Package org.odpi.openmetadata.governanceservers.enginehostservices.admin

Class EngineServiceAdmin

java.lang.Object

org.odpi.openmetadata.governanceservers.enginehostservices.admin.EngineServiceAdmin

Direct Known Subclasses:

GovernanceActionAdmin, RepositoryGovernanceAdmin, SurveyActionAdmin, WatchdogActionAdmin

public abstract class EngineServiceAdmin
extends Object

EngineServiceAdmin is the interface that an engine service implements to receive its configuration. The java class that implements this interface is created with a default constructor and then the initialize method is called.

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditLog	auditLog
protected InvalidParameterHandler	invalidParameterHandler
protected String	localServerName

Constructor Summary

Constructors

Constructor	Description
EngineServiceAdmin()

Method Summary

Modifier and Type	Method	Description
protected String	getPartnerServiceRootURL(EngineServiceConfig engineServicesConfig)	Return the open metadata server's root URL from the configuration.
protected String	getPartnerServiceServerName(EngineServiceConfig engineServiceConfig)	Return the open metadata server's name from the configuration.
abstract void	initialize(String localServerId, String localServerName, AuditLog auditLog, String localServerUserId, String localServerPassword, int maxPageSize, GovernanceConfigurationClient configurationClient, EngineServiceConfig engineServiceConfig, GovernanceEngineMap governanceEngineMap)	Initialize engine service.
abstract void	shutdown()	Shutdown the engine service.
protected void	validateConfigDocument(EngineServiceConfig engineServiceConfig)	Validate the content of the configuration.

Methods inherited from class java.lang.Object

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

Field Details

localServerName

protected String localServerName

auditLog

protected AuditLog auditLog

invalidParameterHandler

protected InvalidParameterHandler invalidParameterHandler

Constructor Details

EngineServiceAdmin

public EngineServiceAdmin()

Method Details

initialize

public abstract void initialize(String localServerId,
 String localServerName,
 AuditLog auditLog,
 String localServerUserId,
 String localServerPassword,
 int maxPageSize,
 GovernanceConfigurationClient configurationClient,
 EngineServiceConfig engineServiceConfig,
 GovernanceEngineMap governanceEngineMap)
                         throws OMAGConfigurationErrorException

Initialize engine service.

Parameters:

localServerId - unique identifier of this server

localServerName - name of this server

auditLog - link to the repository responsible for servicing the REST calls

localServerUserId - user id for this server to use if sending REST requests and processing inbound messages

localServerPassword - password for this server to use if sending REST requests

maxPageSize - maximum number of records that can be requested on the pageSize parameter

configurationClient - client used to connect to the Governance Engine OMAS to retrieve the governance engine definitions

engineServiceConfig - details of the options and the engines to run

governanceEngineMap - map of configured engines

Throws:

OMAGConfigurationErrorException - an issue in the configuration prevented initialization

shutdown

public abstract void shutdown()

Shutdown the engine service.

getPartnerServiceRootURL

protected String getPartnerServiceRootURL(EngineServiceConfig engineServicesConfig)
                                   throws OMAGConfigurationErrorException

Return the open metadata server's root URL from the configuration.

Parameters:

engineServicesConfig - configuration

Returns:

root URL

Throws:

OMAGConfigurationErrorException - No root URL present in the config

validateConfigDocument

protected void validateConfigDocument(EngineServiceConfig engineServiceConfig)
                               throws InvalidParameterException

Validate the content of the configuration.

Parameters:

engineServiceConfig - configuration

Throws:

InvalidParameterException - Missing content from the config

getPartnerServiceServerName

protected String getPartnerServiceServerName(EngineServiceConfig engineServiceConfig)
                                      throws OMAGConfigurationErrorException

Return the open metadata server's name from the configuration.

Parameters:

engineServiceConfig - configuration

Returns:

server name

Throws:

OMAGConfigurationErrorException - No server name present in the config