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

invalidParameterHandler, nullRequestBody, restClient, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor	Description
EngineHostConfigurationClient(String serverName, String serverPlatformRootURL, String secretStoreProvider, String secretStoreLocation, String secretStoreCollection, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
void	clearEngineHostServices()	Clear the configuration for the engine host services.
List<EngineConfig>	getEngineHostServicesConfiguration()	Return the configuration for the complete engine host services in this server.
List<RegisteredOMAGService>	getRegisteredEngineServices()	Return the list of engine services for this server.
void	setEngineHostServicesConfig(List<EngineConfig> engineHostServicesConfig)	Set up the configuration for the Engine Host Services in an Engine Host OMAG Server in a single call.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

EngineHostConfigurationClient

public EngineHostConfigurationClient(String serverName,
 String serverPlatformRootURL,
 String secretStoreProvider,
 String secretStoreLocation,
 String secretStoreCollection,
 AuditLog auditLog)
                              throws InvalidParameterException

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

Parameters:

serverName - name of the server to connect to

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

secretStoreProvider - class name of the secrets store

secretStoreLocation - location (networkAddress) of the secrets store

secretStoreCollection - name of the collection of secrets to use to connect to the remote server

auditLog - destination for log messages.

Throws:

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

Method Details

getRegisteredEngineServices

public List<RegisteredOMAGService> getRegisteredEngineServices()
                                                        throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Return the list of engine services for this server.

Returns:

list of engine service descriptions

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getEngineHostServicesConfiguration

public List<EngineConfig> getEngineHostServicesConfiguration()
                                                      throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

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

Returns:

response containing the engine host services configuration

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setEngineHostServicesConfig

public void setEngineHostServicesConfig(List<EngineConfig> engineHostServicesConfig)
                                 throws UserNotAuthorizedException,
InvalidParameterException,
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:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearEngineHostServices

public void clearEngineHostServices()
                             throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Clear the configuration for the engine host services.

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.