Package org.odpi.openmetadata.engineservices.repositorygovernance.handlers

Class RepositoryGovernanceEngineHandler

java.lang.Object

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

org.odpi.openmetadata.engineservices.repositorygovernance.handlers.RepositoryGovernanceEngineHandler

public class RepositoryGovernanceEngineHandler
extends GovernanceEngineHandler

The RepositoryGovernanceEngineHandler is responsible for running repository governance services on demand. It is initialized with the configuration for the repository governance 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, configurationClient, engineActionClient, engineUserId, governanceEngineGUID, governanceEngineName, governanceEngineProperties, maxPageSize, serverName, serverUserId

Constructor Summary

Constructors

Constructor	Description
RepositoryGovernanceEngineHandler(EngineConfig engineConfig, String serverName, String serverUserId, GovernanceConfigurationClient configurationClient, GovernanceContextClient engineActionClient, EnterpriseRepositoryServicesClient repositoryGovernanceEngineClient, AuditLog auditLog, int maxPageSize)	Create a client-side object for calling a repository governance engine.

Method Summary

Modifier and Type	Method	Description
void	runGovernanceService(String engineActionGUID, String governanceRequestType, String requesterUserId, Date requestedStartDate, 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

executeEngineAction, getGovernanceEngineElement, getGovernanceEngineName, getServiceCache, getSummary, refreshConfig, refreshServiceConfig, restartGovernanceService, restartServices, startServiceExecutionThread, terminate, validateGovernanceEngineInitialized

Methods inherited from class java.lang.Object

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

Constructor Details

RepositoryGovernanceEngineHandler

public RepositoryGovernanceEngineHandler(EngineConfig engineConfig,
 String serverName,
 String serverUserId,
 GovernanceConfigurationClient configurationClient,
 GovernanceContextClient engineActionClient,
 EnterpriseRepositoryServicesClient repositoryGovernanceEngineClient,
 AuditLog auditLog,
 int maxPageSize)

Create a client-side object for calling a repository governance engine.

Parameters:

engineConfig - the unique identifier of the repository governance engine.

serverName - the name of the engine host server where the repository governance engine is running

serverUserId - user id for the server to use

configurationClient - client to retrieve the configuration

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

repositoryGovernanceEngineClient - REST client for direct REST Calls to OMRS - used by repository governance services

auditLog - logging destination

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

Method Details

runGovernanceService

public void runGovernanceService(String engineActionGUID,
 String governanceRequestType,
 String requesterUserId,
 Date requestedStartDate,
 Map<String,String> requestParameters,
 List<RequestSourceElement> requestSourceElements,
 List<ActionTargetElement> actionTargetElements)
                          throws InvalidParameterException,
UserNotAuthorizedException,
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:

engineActionGUID - unique identifier of the asset to analyse

governanceRequestType - governance request type to use when calling the governance engine

requesterUserId - original user requesting this governance service

requestedStartDate - date/time to start the governance action service

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

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

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