Package org.odpi.openmetadata.engineservices.archivemanager.handlers

Class ArchiveEngineHandler

java.lang.Object

org.odpi.openmetadata.governanceservers.enginehostservices.admin.GovernanceEngineHandler

org.odpi.openmetadata.engineservices.archivemanager.handlers.ArchiveEngineHandler

public class ArchiveEngineHandler
extends GovernanceEngineHandler

The ArchiveEngineHandler is responsible for running archive services on demand. It is initialized with the configuration for the archive services it supports along with the clients to the asset properties store and annotations store.

Field Summary

Fields inherited from class org.odpi.openmetadata.governanceservers.enginehostservices.admin.GovernanceEngineHandler

auditLog, engineUserId, governanceEngineGUID, governanceEngineName, governanceEngineProperties, maxPageSize, serverClient, serverName, serverUserId

Constructor Summary

Constructors

Constructor	Description
ArchiveEngineHandler(EngineConfig engineConfig, String serverName, String serverUserId, GovernanceEngineConfigurationClient configurationClient, GovernanceEngineClient serverClient, EnterpriseRepositoryServicesClient archiveEngineClient, AuditLog auditLog, int maxPageSize)	Create a client-side object for calling a archive engine.

Method Summary

Modifier and Type	Method	Description
GovernanceServiceHandler	runGovernanceService(String governanceActionGUID, String requestType, Map<String,String> requestParameters, List<RequestSourceElement> requestSourceElements, List<ActionTargetElement> actionTargetElements)	Run an instance of a governance action service in its own thread and return the handler (for disconnect processing).

Methods inherited from class org.odpi.openmetadata.governanceservers.enginehostservices.admin.GovernanceEngineHandler

executeGovernanceAction, getGovernanceEngineName, getServiceCache, getSummary, publishWatchdogEvent, refreshConfig, refreshServiceConfig, terminate, validateGovernanceEngineInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveEngineHandler

public ArchiveEngineHandler(EngineConfig engineConfig,
                            String serverName,
                            String serverUserId,
                            GovernanceEngineConfigurationClient configurationClient,
                            GovernanceEngineClient serverClient,
                            EnterpriseRepositoryServicesClient archiveEngineClient,
                            AuditLog auditLog,
                            int maxPageSize)

Create a client-side object for calling a archive engine.

Parameters:

engineConfig - the unique identifier of the archive engine.

serverName - the name of the engine host server where the archive engine is running

serverUserId - user id for the server to use

configurationClient - client to retrieve the configuration

serverClient - client used by the engine host services to control the execution of governance action requests

archiveEngineClient - REST client for direct REST Calls to Archive Engine OMAS - used by archive services

auditLog - logging destination

maxPageSize - maximum number of results that can be returned in a single request

Method Detail

runGovernanceService

public GovernanceServiceHandler runGovernanceService(String governanceActionGUID,
                                                     String requestType,
                                                     Map<String,String> requestParameters,
                                                     List<RequestSourceElement> requestSourceElements,
                                                     List<ActionTargetElement> actionTargetElements)
                                              throws InvalidParameterException,
                                                     PropertyServerException

Run an instance of a governance action service in its own thread and return the handler (for disconnect processing).

Specified by:

runGovernanceService in class GovernanceEngineHandler

Parameters:

governanceActionGUID - unique identifier of the asset to analyse

requestType - unique identifier of the asset that the annotations should be attached to

requestParameters - name-value properties to control the governance action service

requestSourceElements - metadata elements associated with the request to the governance action service

actionTargetElements - metadata elements that need to be worked on by the governance action service

Returns:

service handler for this request

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there was a problem detected by the governance action engine.