Package org.odpi.openmetadata.frameworks.opensurvey

Class SurveyContext

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.ConnectorContextBase

org.odpi.openmetadata.frameworks.opensurvey.SurveyContext

public class SurveyContext
extends ConnectorContextBase

SurveyContext provides a survey action service with access to information about the survey request along with access to the open metadata repository interfaces.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.ConnectorContextBase

connectorActivityReportWriter, connectorGUID, connectorId, connectorName, connectorUserId, defaultDeleteMethod, externalSourceGUID, externalSourceName, fileClassifier, generateIntegrationReport, governanceDefinitionClient, localServerName, localServiceName, maxPageSize, openMetadataClient, openMetadataStore, propertyHelper

Constructor Summary

Constructors

Constructor

Description

SurveyContext(String localServerName, String localServiceName, String externalSourceGUID, String externalSourceName, String connectorId, String connectorName, String connectorUserId, String connectorGUID, boolean generateIntegrationReport, OpenMetadataClient openMetadataClient, AuditLog auditLog, int maxPageSize, DeleteMethod deleteMethod, String assetGUID, Map<String,String> requestParameters, List<ActionTargetElement> actionTargetElements, SurveyAssetStore assetStore, AnnotationStore annotationStore, String surveyActionServiceName, String requesterUserId)

Constructor sets up the key parameters for using the context.

Method Summary

Modifier and Type	Method	Description
boolean	elementShouldBeSurveyed(String elementName, List<String> excludedNames, List<String> includedNames)	Determine whether a particular element should be surveyed.
List<ActionTargetElement>	getActionTargetElements()	Return the list of elements that this governance action service should work on.
AnnotationStore	getAnnotationStore()	Return the annotation store for the survey action service.
String	getAssetGUID()	Return the unique identifier of the asset being discovered.
SurveyAssetStore	getAssetStore()	Return the asset store for the survey action service.
List<NewActionTarget>	getCompletionActionTargets()	Return any additional action targets that should be made available to downstream governance actions.
List<String>	getCompletionGuards()	Return the guards provided by the survey action service.
AuditLogMessageDefinition	getCompletionMessage()	Return the populated message to act as the completion message.
Map<String,String>	getCompletionRequestParameters()	Return any new request parameters for downstream governance actions.
CompletionStatus	getCompletionStatus()	Return the completion status provided by the survey action service.
String	getRequesterUserId()	Return the requester user identifier.
Map<String,String>	getRequestParameters()	Return the properties that hold the parameters used to drive the survey action service's analysis.
String	getSurveyActionServiceName()	Return the survey action service.
void	recordCompletionStatus(CompletionStatus status, List<String> outputGuards, Map<String,String> requestParameters, List<NewActionTarget> newActionTargets, AuditLogMessageDefinition completionMessage)	Declare that all the processing for the governance action service is finished and the status of the work.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.ConnectorContextBase

createIncidentReport, disconnect, getActorProfileClient, getActorRoleClient, getAnchorGUID, getAnchorGUID, getAssetClient, getAssetClient, getConnectionClient, getConnectorId, getConnectorName, getConnectorTypeClient, getEndpointClient, getFileClassifier, getGlossaryClient, getGlossaryTermClient, getGovernanceDefinitionClient, getGovernanceDefinitionClient, getLocalServerName, getLocalServiceName, getMaxPageSize, getMultiLanguageClient, getMyUserId, getOpenMetadataStore, getSchemaAttributeClient, getSchemaAttributeClient, getSchemaTypeClient, getSchemaTypeClient, getSoftwareCapabilityClient, getSoftwareCapabilityClient, getValidMetadataValuesClient, getValidValueDefinitionClient, isTypeOf, isTypeOf, openToDo, openToDo, publishReport, registerContextEvent, registerDirectoryListener, registerDirectoryTreeListener, registerFileListener, reportElementCreation, reportElementDelete, reportElementUpdate, setActiveReportPublishing, startRecording, unregisterDirectoryListener, unregisterDirectoryTreeListener, unregisterFileListener, validateIsActive

Methods inherited from class java.lang.Object

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

Constructor Details

SurveyContext

public SurveyContext(String localServerName,
 String localServiceName,
 String externalSourceGUID,
 String externalSourceName,
 String connectorId,
 String connectorName,
 String connectorUserId,
 String connectorGUID,
 boolean generateIntegrationReport,
 OpenMetadataClient openMetadataClient,
 AuditLog auditLog,
 int maxPageSize,
 DeleteMethod deleteMethod,
 String assetGUID,
 Map<String,String> requestParameters,
 List<ActionTargetElement> actionTargetElements,
 SurveyAssetStore assetStore,
 AnnotationStore annotationStore,
 String surveyActionServiceName,
 String requesterUserId)

Constructor sets up the key parameters for using the context.

Parameters:

localServerName - name of local server

localServiceName - name of the service to call

externalSourceGUID - metadata collection unique id

externalSourceName - metadata collection unique name

connectorId - id of this connector instance

connectorName - name of this connector instance

connectorUserId - userId to use when issuing open metadata requests

connectorGUID - unique identifier of the connector element that describes this connector in the open metadata store(s)

generateIntegrationReport - should the context generate an integration report?

openMetadataClient - client to access open metadata store

auditLog - logging destination

maxPageSize - max number of results

deleteMethod - default delete method

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

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

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

annotationStore - annotation store for the survey action service

surveyActionServiceName - name of the running service

requesterUserId - original user requesting this governance service

Method Details

getAssetGUID

public String getAssetGUID()
                    throws UserNotAuthorizedException

Return the unique identifier of the asset being discovered.

Returns:

string guid

Throws:

UserNotAuthorizedException - exception thrown if connector is no longer active

getRequestParameters

public Map<String,String> getRequestParameters()
                                        throws UserNotAuthorizedException

Return the properties that hold the parameters used to drive the survey action service's analysis.

Returns:

AdditionalProperties object storing the analysis parameters

Throws:

UserNotAuthorizedException - exception thrown if connector is no longer active

getActionTargetElements

public List<ActionTargetElement> getActionTargetElements()

Return the list of elements that this governance action service should work on.

Returns:

cached list of action target metadata elements

getRequesterUserId

public String getRequesterUserId()

Return the requester user identifier.

Returns:

userId

getAssetStore

public SurveyAssetStore getAssetStore()
                               throws UserNotAuthorizedException

Return the asset store for the survey action service. This is able to provide a connector to the asset configured with the properties of the asset from a property server.

Returns:

asset store

Throws:

UserNotAuthorizedException - exception thrown if connector is no longer active

getAnnotationStore

public AnnotationStore getAnnotationStore()
                                   throws UserNotAuthorizedException

Return the annotation store for the survey action service. This is where the annotations are stored and retrieved from.

Returns:

annotation store

Throws:

UserNotAuthorizedException - exception thrown if connector is no longer active

elementShouldBeSurveyed

public boolean elementShouldBeSurveyed(String elementName,
 List<String> excludedNames,
 List<String> includedNames)

Determine whether a particular element should be surveyed. The include list takes precedent over the exclude list.

Parameters:

elementName - name of the element

excludedNames - list of names to exclude (null means ignore value)

includedNames - list of names to include (null means ignore value)

Returns:

flag indicating whether to work with the database

recordCompletionStatus

public void recordCompletionStatus(CompletionStatus status,
 List<String> outputGuards,
 Map<String,String> requestParameters,
 List<NewActionTarget> newActionTargets,
 AuditLogMessageDefinition completionMessage)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Declare that all the processing for the governance action service is finished and the status of the work.

Parameters:

status - completion status enum value

outputGuards - optional guard strings for triggering subsequent action(s)

requestParameters - properties to pass to the next governance action service

newActionTargets - map of action target names to GUIDs for the resulting governance action service

completionMessage - message to describe completion results or reasons for failure

Throws:

InvalidParameterException - the completion status is null

UserNotAuthorizedException - the governance action service is not authorized to update the governance action service status

PropertyServerException - there is a problem connecting to the metadata store

getSurveyActionServiceName

public String getSurveyActionServiceName()

Return the survey action service.

Returns:

qualified name

getCompletionStatus

public CompletionStatus getCompletionStatus()

Return the completion status provided by the survey action service.

Returns:

enum

getCompletionGuards

public List<String> getCompletionGuards()

Return the guards provided by the survey action service. If these are null then a standard guard (eg SURVEY_INVALID, SURVEY_COMPLETE, SURVEY_FAILED) is used

Returns:

list of strings

getCompletionMessage

public AuditLogMessageDefinition getCompletionMessage()

Return the populated message to act as the completion message.

Returns:

audit log message definition

getCompletionRequestParameters

public Map<String,String> getCompletionRequestParameters()

Return any new request parameters for downstream governance actions.

Returns:

map of request parameter name to request parameter value

getCompletionActionTargets

public List<NewActionTarget> getCompletionActionTargets()

Return any additional action targets that should be made available to downstream governance actions. This is in addition to the actual survey report.

Returns:

list of new action targets

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

print out of variables in a JSON-style