Package org.odpi.openmetadata.adminservices.client

Class EngineHostConfigurationClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

org.odpi.openmetadata.adminservices.client.GovernanceServerConfigurationClient

org.odpi.openmetadata.adminservices.client.EngineHostConfigurationClient

public class EngineHostConfigurationClient
extends GovernanceServerConfigurationClient

EngineHostConfigurationClient provides the configuration services for Engine Host OMAG Servers. This involves creating a list of engine services.

Field Summary

Fields inherited from class org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

adminUserId, invalidParameterHandler, nullRequestBody, restClient, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor	Description
EngineHostConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL)	Create a new client with no authentication embedded in the HTTP request.
EngineHostConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL, String connectionUserId, String connectionPassword)	Create a new client that passes a connection userId and password in each HTTP request.

Method Summary

Modifier and Type	Method	Description
void	clearAllEngineServices()	Disable the engine services.
void	clearEngineDefinitionsClientConfig()	Clear the configuration for the metadata server that provides the governance engine definitions through the Governance Engine OMAS.
void	clearEngineHostServices()	Clear the configuration for the engine host services.
void	clearEngineService(String serviceURLMarker)	Disable the engine services.
void	configureEngineService(String serviceURLMarker, Map<String,Object> engineServiceOptions, List<EngineConfig> engines)	Enable a single engine service.
void	configureEngineService(EngineServiceConfig serviceConfig)	Add configuration for a single engine service to the server's config document.
void	disableEngineService(String serviceURLMarker)	Disable a single engine service.
List<RegisteredOMAGService>	getConfiguredEngineServices()	Return the list of engine services for this server.
EngineHostServicesConfig	getEngineHostServicesConfiguration()	Return the configuration for the complete engine host services in this server.
EngineServiceConfig	getEngineServiceConfiguration(String serviceURLMarker)	Return the configuration for the named engine service for this server.
List<RegisteredOMAGService>	getRegisteredEngineServices()	Return the list of engine services for this server.
void	setEngineDefinitionsClientConfig(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.
void	setEngineHostServicesConfig(EngineHostServicesConfig engineHostServicesConfig)	Set up the configuration for the Engine Host Services in an Engine Host OMAG Server in a single call.
void	setEngineServicesConfig(List<EngineServiceConfig> engineServicesConfig)	Set up the configuration for all of the open metadata engine services (OMESs).

Methods inherited from class org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

addAuditLogDestination, addConsoleAuditLogDestination, addEventTopicAuditLogDestination, addFileAuditLogDestination, addSLF4JAuditLogDestination, clearAuditLogDestination, clearAuditLogDestinations, clearOMAGServerConfig, clearServerSecurityConnection, deployOMAGServerConfig, getOMAGServerConfig, getOMAGServerInstanceConfig, getServerClassification, getServerSecurityConnection, setAuditLogDestinations, setDefaultAuditLog, setEventBus, setMaxPageSize, setOMAGServerConfig, setOrganizationName, setServerDescription, setServerPassword, setServerSecurityConnection, setServerType, setServerURLRoot, setServerUserId, updateAuditLogDestination

Methods inherited from class java.lang.Object

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

Constructor Detail

EngineHostConfigurationClient

public EngineHostConfigurationClient(String adminUserId,
                                     String serverName,
                                     String serverPlatformRootURL)
                              throws OMAGInvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

adminUserId - administrator's (end user's) userId to associate with calls.

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the admin services

Throws:

OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

EngineHostConfigurationClient

public EngineHostConfigurationClient(String adminUserId,
                                     String serverName,
                                     String serverPlatformRootURL,
                                     String connectionUserId,
                                     String connectionPassword)
                              throws OMAGInvalidParameterException

Create a new client that passes a connection userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is passed as the admin userId.

Parameters:

adminUserId - administrator's (end user's) userId to associate with calls.

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the admin services

connectionUserId - caller's system userId embedded in all HTTP requests

connectionPassword - caller's system password embedded in all HTTP requests

Throws:

OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

getRegisteredEngineServices

public List<RegisteredOMAGService> getRegisteredEngineServices()
                                                        throws OMAGNotAuthorizedException,
                                                               OMAGInvalidParameterException,
                                                               OMAGConfigurationErrorException

Return the list of engine services for this server.

Returns:

list of engine service descriptions

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getConfiguredEngineServices

public List<RegisteredOMAGService> getConfiguredEngineServices()
                                                        throws OMAGNotAuthorizedException,
                                                               OMAGInvalidParameterException,
                                                               OMAGConfigurationErrorException

Return the list of engine services for this server.

Returns:

list of engine service descriptions

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getEngineHostServicesConfiguration

public EngineHostServicesConfig getEngineHostServicesConfiguration()
                                                            throws OMAGNotAuthorizedException,
                                                                   OMAGInvalidParameterException,
                                                                   OMAGConfigurationErrorException

Return the configuration for the complete engine host services in this server.

Returns:

response containing the engine host services configuration

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getEngineServiceConfiguration

public EngineServiceConfig getEngineServiceConfiguration(String serviceURLMarker)
                                                  throws OMAGNotAuthorizedException,
                                                         OMAGInvalidParameterException,
                                                         OMAGConfigurationErrorException

Return the configuration for the named engine service for this server.

Parameters:

serviceURLMarker - engine service name used in URL

Returns:

response containing the engine services configuration

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setEngineDefinitionsClientConfig

public void setEngineDefinitionsClientConfig(OMAGServerClientConfig clientConfig)
                                      throws OMAGNotAuthorizedException,
                                             OMAGInvalidParameterException,
                                             OMAGConfigurationErrorException

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:

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

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureEngineService

public void configureEngineService(String serviceURLMarker,
                                   Map<String,Object> engineServiceOptions,
                                   List<EngineConfig> engines)
                            throws OMAGNotAuthorizedException,
                                   OMAGInvalidParameterException,
                                   OMAGConfigurationErrorException

Enable a single engine service.

Parameters:

serviceURLMarker - string indicating which engine service it is configuring

engineServiceOptions - property name/value pairs used to configure the engine service

engines - list of qualified names of the engines and optional user information

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

disableEngineService

public void disableEngineService(String serviceURLMarker)
                          throws OMAGNotAuthorizedException,
                                 OMAGInvalidParameterException,
                                 OMAGConfigurationErrorException

Disable a single engine service.

Parameters:

serviceURLMarker - string indicating which engine service it is disabling

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureEngineService

public void configureEngineService(EngineServiceConfig serviceConfig)
                            throws OMAGNotAuthorizedException,
                                   OMAGInvalidParameterException,
                                   OMAGConfigurationErrorException

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

Parameters:

serviceConfig - all values to configure an engine service

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setEngineServicesConfig

public void setEngineServicesConfig(List<EngineServiceConfig> engineServicesConfig)
                             throws OMAGNotAuthorizedException,
                                    OMAGInvalidParameterException,
                                    OMAGConfigurationErrorException

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

Parameters:

engineServicesConfig - list of configuration properties for each engine service.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setEngineHostServicesConfig

public void setEngineHostServicesConfig(EngineHostServicesConfig engineHostServicesConfig)
                                 throws OMAGNotAuthorizedException,
                                        OMAGInvalidParameterException,
                                        OMAGConfigurationErrorException

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

Parameters:

engineHostServicesConfig - governance engine definition client config and list of configuration properties for each engine service.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearEngineHostServices

public void clearEngineHostServices()
                             throws OMAGNotAuthorizedException,
                                    OMAGInvalidParameterException,
                                    OMAGConfigurationErrorException

Clear the configuration for the engine host services.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearEngineDefinitionsClientConfig

public void clearEngineDefinitionsClientConfig()
                                        throws OMAGNotAuthorizedException,
                                               OMAGInvalidParameterException,
                                               OMAGConfigurationErrorException

Clear the configuration for the metadata server that provides the governance engine definitions through the Governance Engine OMAS.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearAllEngineServices

public void clearAllEngineServices()
                            throws OMAGNotAuthorizedException,
                                   OMAGInvalidParameterException,
                                   OMAGConfigurationErrorException

Disable the engine services. This removes all configuration for the engine services in the engine host server.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearEngineService

public void clearEngineService(String serviceURLMarker)
                        throws OMAGNotAuthorizedException,
                               OMAGInvalidParameterException,
                               OMAGConfigurationErrorException

Disable the engine services. This removes all configuration for the engine host server.

Parameters:

serviceURLMarker - engine service name used in URL

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.