org.odpi.openmetadata.engineservices.governanceaction.handlers

Class GovernanceActionEngineHandler

java.lang.Object

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

org.odpi.openmetadata.engineservices.governanceaction.handlers.GovernanceActionEngineHandler

public class GovernanceActionEngineHandler
extends GovernanceEngineHandler

The GovernanceActionEngineHandler is responsible for running governance action services on demand. It is initialized with the configuration for the governance action 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 and Description
GovernanceActionEngineHandler(EngineConfig engineConfig, String localServerName, String partnerServerName, String partnerURLRoot, String serverUserId, GovernanceEngineConfigurationClient configurationClient, GovernanceEngineClient serverClient, GovernanceEngineClient governanceEngineClient, AuditLog auditLog, int maxPageSize) Create a client-side object for calling a governance action engine.

Method Summary

Modifier and Type	Method and Description
void	publishWatchdogEvent(WatchdogGovernanceEvent watchdogGovernanceEvent) Pass on the watchdog event to any governance service that supports them.
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, refreshConfig, refreshServiceConfig, terminate, validateGovernanceEngineInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceActionEngineHandler

public GovernanceActionEngineHandler(EngineConfig engineConfig,
                                     String localServerName,
                                     String partnerServerName,
                                     String partnerURLRoot,
                                     String serverUserId,
                                     GovernanceEngineConfigurationClient configurationClient,
                                     GovernanceEngineClient serverClient,
                                     GovernanceEngineClient governanceEngineClient,
                                     AuditLog auditLog,
                                     int maxPageSize)

Create a client-side object for calling a governance action engine. Notices there there are two versions of the GovernanceEngineClient. It is possible that they pointing at different metadata server instances so do not consolidate them into one client (even if IntelliJ begs you to :).

Parameters:

engineConfig - the unique identifier of the governance action engine.

localServerName - the name of the engine host server where the governance action engine is running

serverUserId - user id for the server to use

configurationClient - client to retrieve the configuration

serverClient - client to control the execution of governance action requests

governanceEngineClient - REST client for calls made by the governance action services

auditLog - logging destination

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

Method Detail

publishWatchdogEvent

public void publishWatchdogEvent(WatchdogGovernanceEvent watchdogGovernanceEvent)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Pass on the watchdog event to any governance service that supports them.

Overrides:

publishWatchdogEvent in class GovernanceEngineHandler

Parameters:

watchdogGovernanceEvent - element describing the changing metadata data.

Throws:

InvalidParameterException - Vital fields of the governance action are not filled out

UserNotAuthorizedException - the governance service is not permitted to execute the governance action

PropertyServerException - there is a problem communicating with the open metadata stores

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.