org.odpi.openmetadata.adminservices

Class OMAGServerAdminForEngineServices

java.lang.Object

org.odpi.openmetadata.adminservices.OMAGServerAdminForEngineServices

public class OMAGServerAdminForEngineServices
extends Object

OMAGServerAdminForEngineServices provides the server-side support for the services that add engine services configuration to an OMAG Server.

Constructor Summary

Constructors

Constructor and Description
OMAGServerAdminForEngineServices() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	clearAllEngineServices(String userId, String serverName) Disable the engine services.
VoidResponse	clearEngineDefinitionsClientConfig(String userId, String serverName) Remove the configuration for the Governance Engine OMAS Engine client configuration in a single call.
VoidResponse	clearEngineHostServicesConfig(String userId, String serverName) Remove the configuration for an Engine Host OMAG Server in a single call.
VoidResponse	clearEngineService(String userId, String serverName, String serviceURLMarker) Remove an engine service.
VoidResponse	configureEngineService(String userId, String serverName, EngineServiceConfig serviceConfig) Add configuration for a single engine service to the server's config document.
VoidResponse	configureEngineService(String userId, String serverName, String serviceURLMarker, EngineServiceRequestBody requestBody) Enable a single registered engine service.
RegisteredOMAGServicesResponse	getConfiguredEngineServices(String userId, String serverName) Return the list of engine services that are configured for this server.
EngineHostServicesResponse	getEngineHostServicesConfiguration(String userId, String serverName) Return the engine host services configuration including the list of engine services that are configured for this server.
EngineServiceConfigResponse	getEngineServiceConfiguration(String userId, String serverName, String serviceURLMarker) Return the configuration for the requested engine service that is configured for this server.
VoidResponse	setEngineDefinitionsClientConfig(String userId, String serverName, OMAGServerClientConfig clientConfig) Set up the name and platform URL root for the metadata server running the Governance Engine OMAS that provides the governance engine definitions used by the engine services.
VoidResponse	setEngineHostServicesConfig(String userId, String serverName, EngineHostServicesConfig servicesConfig) Set up the configuration for an Engine Host OMAG Server in a single call.
VoidResponse	setEngineServicesConfig(String userId, String serverName, List<EngineServiceConfig> engineServicesConfig) Set up the configuration for all of the open metadata engine services (OMESs).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OMAGServerAdminForEngineServices

public OMAGServerAdminForEngineServices()

Default constructor

Method Detail

getConfiguredEngineServices

public RegisteredOMAGServicesResponse getConfiguredEngineServices(String userId,
                                                                  String serverName)

Return the list of engine services that are configured for this server. If you want to see the configuration for these services, use the getEngineHostServicesConfiguration.

Parameters:

userId - calling user

serverName - name of server

Returns:

list of engine service descriptions

getEngineHostServicesConfiguration

public EngineHostServicesResponse getEngineHostServicesConfiguration(String userId,
                                                                     String serverName)

Return the engine host services configuration including the list of engine services that are configured for this server.

Parameters:

userId - calling user

serverName - name of server

Returns:

engine host services configuration

getEngineServiceConfiguration

public EngineServiceConfigResponse getEngineServiceConfiguration(String userId,
                                                                 String serverName,
                                                                 String serviceURLMarker)

Return the configuration for the requested engine service that is configured for this server.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceURLMarker - engine service name used in URL

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or serviceURLMarker parameter.

setEngineDefinitionsClientConfig

public VoidResponse setEngineDefinitionsClientConfig(String userId,
                                                     String serverName,
                                                     OMAGServerClientConfig clientConfig)

Set up the name and platform URL root for the metadata server running the Governance Engine OMAS that provides the governance engine definitions used by the engine services.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

clientConfig - URL root and server name for the metadata server.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

configureEngineService

public VoidResponse configureEngineService(String userId,
                                           String serverName,
                                           String serviceURLMarker,
                                           EngineServiceRequestBody requestBody)

Enable a single registered engine service. This builds the engine service configuration for the server's config document.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceURLMarker - engine service name used in URL

requestBody - minimum values to configure an engine service

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.

configureEngineService

public VoidResponse configureEngineService(String userId,
                                           String serverName,
                                           EngineServiceConfig serviceConfig)

Add configuration for a single engine service to the server's config document.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceConfig - all values to configure an engine service

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.

setEngineServicesConfig

public VoidResponse setEngineServicesConfig(String userId,
                                            String serverName,
                                            List<EngineServiceConfig> engineServicesConfig)

Set up the configuration for all of the open metadata engine services (OMESs). This overrides the current values.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

engineServicesConfig - list of configuration properties for each engine service.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or engineServicesConfig parameter.

setEngineHostServicesConfig

public VoidResponse setEngineHostServicesConfig(String userId,
                                                String serverName,
                                                EngineHostServicesConfig servicesConfig)

Set up the configuration for an Engine Host OMAG Server in a single call. This overrides the current values.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

servicesConfig - full configuration for the engine host server.

Returns:

void response OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

clearEngineHostServicesConfig

public VoidResponse clearEngineHostServicesConfig(String userId,
                                                  String serverName)

Remove the configuration for an Engine Host OMAG Server in a single call. This overrides the current values.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Returns:

void response OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

clearEngineDefinitionsClientConfig

public VoidResponse clearEngineDefinitionsClientConfig(String userId,
                                                       String serverName)

Remove the configuration for the Governance Engine OMAS Engine client configuration in a single call. This overrides the current values.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Returns:

void response OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

clearAllEngineServices

public VoidResponse clearAllEngineServices(String userId,
                                           String serverName)

Disable the engine services. This removes all configuration for the engine services and disables the enterprise repository services.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.

clearEngineService

public VoidResponse clearEngineService(String userId,
                                       String serverName,
                                       String serviceURLMarker)

Remove an engine service. This removes all configuration for the engine service.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceURLMarker - engine service name used in URL

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.