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
abstract void	initialize(String localServerName, AuditLog auditLog, String localServerUserId, int maxPageSize, EngineServiceDefinition engineServiceDefinition)	Initialize engine service.
abstract void	shutdown()	Shutdown the engine service.
protected void	validateEngineDefinition(EngineServiceDefinition engineServiceDefinition)	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 localServerName,
 AuditLog auditLog,
 String localServerUserId,
 int maxPageSize,
 EngineServiceDefinition engineServiceDefinition)
                         throws OMAGConfigurationErrorException

Initialize engine service.

Parameters:

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

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

engineServiceDefinition - details of the options and the engines to run

Throws:

OMAGConfigurationErrorException - an issue in the configuration prevented initialization

shutdown

public abstract void shutdown()

Shutdown the engine service.

validateEngineDefinition

protected void validateEngineDefinition(EngineServiceDefinition engineServiceDefinition)
                                 throws InvalidParameterException

Validate the content of the configuration.

Parameters:

engineServiceDefinition - configuration

Throws:

InvalidParameterException - Missing content from the config