Package org.odpi.openmetadata.engineservices.assetanalysis.handlers

Class DiscoveryEngineHandler

java.lang.Object

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

org.odpi.openmetadata.engineservices.assetanalysis.handlers.DiscoveryEngineHandler

public class DiscoveryEngineHandler
extends GovernanceEngineHandler

The DiscoveryEngineHandler is responsible for running discovery services on demand. It is initialized with the configuration for the discovery 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
DiscoveryEngineHandler(EngineConfig engineConfig, String serverName, String serverUserId, GovernanceEngineConfigurationClient configurationClient, GovernanceEngineClient serverClient, DiscoveryEngineClient discoveryEngineClient, AuditLog auditLog, int maxPageSize)	Create a client-side object for calling a discovery engine.

Method Summary

Modifier and Type	Method	Description
String	discoverAsset(String assetGUID, String discoveryRequestType, Map<String,String> analysisParameters, List<String> annotationTypes)	Request the execution of a discovery service to explore a specific asset.
Annotation	getAnnotation(String annotationGUID)	Retrieve a single annotation by unique identifier.
DiscoveryAnalysisReport	getDiscoveryReport(String discoveryRequestGUID)	Request the discovery report for a discovery request that has completed.
List<Annotation>	getDiscoveryReportAnnotations(String discoveryRequestGUID, int startingFrom, int maximumResults)	Return the annotations linked direction to the report.
List<Annotation>	getExtendedAnnotations(String annotationGUID, int startingFrom, int maximumResults)	Return any annotations attached to this annotation.
GovernanceServiceHandler	runGovernanceService(String governanceActionGUID, String governanceRequestType, Date startDate, 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).
void	scanAllAssets(String discoveryRequestType, Map<String,String> analysisParameters, List<String> annotationTypes)	Request the execution of a discovery service for each asset that is found (limited by the supported zones of the Discovery Engine OMAS).

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 Details

DiscoveryEngineHandler

public DiscoveryEngineHandler(EngineConfig engineConfig,
 String serverName,
 String serverUserId,
 GovernanceEngineConfigurationClient configurationClient,
 GovernanceEngineClient serverClient,
 DiscoveryEngineClient discoveryEngineClient,
 AuditLog auditLog,
 int maxPageSize)

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

Parameters:

engineConfig - the unique identifier of the discovery engine.

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

discoveryEngineClient - REST client for direct REST Calls to Discovery Engine OMAS - used by discovery services

auditLog - logging destination

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

Method Details

discoverAsset

public String discoverAsset(String assetGUID,
 String discoveryRequestType,
 Map<String,String> analysisParameters,
 List<String> annotationTypes)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Request the execution of a discovery service to explore a specific asset.

Parameters:

assetGUID - identifier of the asset to analyze.

discoveryRequestType - identifier of the type of discovery request to run - this determines which discovery service to run.

analysisParameters - name value properties to control the analysis

annotationTypes - list of the types of annotations to produce (and no others)

Returns:

unique id for the discovery request.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem with connecting to the metadata server or there is a problem with the setup of the discovery engine.

scanAllAssets

public void scanAllAssets(String discoveryRequestType,
 Map<String,String> analysisParameters,
 List<String> annotationTypes)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Request the execution of a discovery service for each asset that is found (limited by the supported zones of the Discovery Engine OMAS).

Parameters:

discoveryRequestType - identifier of the type of discovery to run - this determines which discovery service to run.

analysisParameters - name value properties to control the analysis

annotationTypes - list of the types of annotations to produce (and no others)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem with connecting to the metadata server or there is a problem with the setup of the discovery engine.

runGovernanceService

public GovernanceServiceHandler runGovernanceService(String governanceActionGUID,
 String governanceRequestType,
 Date startDate,
 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:

governanceActionGUID - unique identifier of the asset to analyse

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

startDate - 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

Returns:

service handler for this request

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.

getDiscoveryReport

public DiscoveryAnalysisReport getDiscoveryReport(String discoveryRequestGUID)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Request the discovery report for a discovery request that has completed.

Parameters:

discoveryRequestGUID - identifier of the discovery request.

Returns:

discovery report

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem connecting to the metadata server.

getDiscoveryReportAnnotations

public List<Annotation> getDiscoveryReportAnnotations(String discoveryRequestGUID,
 int startingFrom,
 int maximumResults)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the annotations linked direction to the report.

Parameters:

discoveryRequestGUID - identifier of the discovery request.

startingFrom - initial position in the stored list.

maximumResults - maximum number of definitions to return on this call.

Returns:

list of annotations

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem connecting to the metadata server.

getExtendedAnnotations

public List<Annotation> getExtendedAnnotations(String annotationGUID,
 int startingFrom,
 int maximumResults)
                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return any annotations attached to this annotation.

Parameters:

annotationGUID - anchor annotation

startingFrom - starting position in the list

maximumResults - maximum number of annotations that can be returned.

Returns:

list of Annotation objects

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem connecting to the metadata server.

getAnnotation

public Annotation getAnnotation(String annotationGUID)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a single annotation by unique identifier. This call is typically used to retrieve the latest values for an annotation.

Parameters:

annotationGUID - unique identifier of the annotation

Returns:

Annotation object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem connecting to the metadata server.