Package org.odpi.openmetadata.engineservices.surveyaction.handlers

Class SurveyActionEngineHandler

java.lang.Object

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

org.odpi.openmetadata.engineservices.surveyaction.handlers.SurveyActionEngineHandler

public class SurveyActionEngineHandler
extends GovernanceEngineHandler

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

Constructor Summary

Constructors

Constructor	Description
SurveyActionEngineHandler(EngineConfig engineConfig, String serverName, String serverUserId, GovernanceEngineConfigurationClient configurationClient, GovernanceContextClient engineActionClient, ConnectedAssetClient connectedAssetClient, FileSystemAssetOwner fileSystemAssetOwner, CSVFileAssetOwner csvFileAssetOwner, OpenMetadataClient openMetadataClient, AuditLog auditLog, int maxPageSize)	Create a client-side object for calling a survey action 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 survey 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

SurveyActionEngineHandler

public SurveyActionEngineHandler(EngineConfig engineConfig,
 String serverName,
 String serverUserId,
 GovernanceEngineConfigurationClient configurationClient,
 GovernanceContextClient engineActionClient,
 ConnectedAssetClient connectedAssetClient,
 FileSystemAssetOwner fileSystemAssetOwner,
 CSVFileAssetOwner csvFileAssetOwner,
 OpenMetadataClient openMetadataClient,
 AuditLog auditLog,
 int maxPageSize)

Create a client-side object for calling a survey action engine.

Parameters:

engineConfig - the unique identifier of the survey action engine.

serverName - the name of the engine host server where the survey action 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

connectedAssetClient - REST client from the OCF that is linked to the Asset Owner OMAS

fileSystemAssetOwner - REST client that is linked to the Asset Owner OMAS

csvFileAssetOwner - REST client that is linked to the Asset Owner OMAS

openMetadataClient - REST Client from the GAF that is linked to the Asset Owner OMAS

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 survey action service in its own thread and return the handler (for disconnect processing).

Specified by:

runGovernanceService in class GovernanceEngineHandler

Parameters:

engineActionGUID - unique identifier of engine action to activate

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 service

requestParameters - name-value properties to control the governance service

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

actionTargetElements - metadata elements that need to be worked on by the governance 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 engine.