org.odpi.openmetadata.accessservices.governanceengine.client

Class GovernanceEngineClient

java.lang.Object

org.odpi.openmetadata.accessservices.governanceengine.client.GovernanceEngineClient

All Implemented Interfaces:

GovernanceProcessingInterface, MetadataElementInterface

public class GovernanceEngineClient
extends Object
implements MetadataElementInterface, GovernanceProcessingInterface

GovernanceEngineClient sits in the governance context of a governance action service when it is running in the engine host OMAG server. It is however shared by all of the governance action services running in an engine service so that we only need one connector to the topic listener for the watchdog governance services.

Constructor Summary

Constructors

Constructor and Description
GovernanceEngineClient(String serverName, String serverPlatformURLRoot) Create a new client with no authentication embedded in the HTTP request.
GovernanceEngineClient(String serverName, String serverPlatformURLRoot, GovernanceEngineRESTClient restClient, int maxPageSize) Create a new client that passes userId and password in each HTTP request.
GovernanceEngineClient(String serverName, String serverPlatformURLRoot, String serverUserId, String serverPassword) Create a new client that passes userId and password in each HTTP request.

Method Summary

Modifier and Type	Method and Description
void	claimGovernanceAction(String userId, String governanceActionGUID) Request that execution of a governance action is allocated to the caller.
void	classifyMetadataElementInStore(String userId, String metadataElementGUID, String classificationName, Date effectiveFrom, Date effectiveTo, ElementProperties properties) Add a new classification to the metadata element.
String	createIncidentReport(String userId, String qualifiedName, int domainIdentifier, String background, List<IncidentImpactedElement> impactedResources, List<IncidentDependency> previousIncidents, Map<String,Integer> incidentClassifiers, Map<String,String> additionalProperties, String originatorGUID) Create an incident report to capture the situation detected by this governance action service.
String	createMetadataElementInStore(String userId, String metadataElementTypeName, ElementStatus initialStatus, Date effectiveFrom, Date effectiveTo, ElementProperties properties, String templateGUID) Create a new metadata element in the metadata store.
String	createRelatedElementsInStore(String userId, String relationshipTypeName, String metadataElement1GUID, String metadataElement2GUID, Date effectiveFrom, Date effectiveTo, ElementProperties properties) Create a relationship between two metadata elements.
void	deleteMetadataElementInStore(String userId, String metadataElementGUID) Delete a specific metadata element.
void	deleteRelatedElementsInStore(String userId, String relationshipGUID) Delete a relationship between two metadata elements.
List<OpenMetadataElement>	findMetadataElements(String userId, String metadataElementTypeName, List<String> metadataElementSubtypeName, SearchProperties searchProperties, List<ElementStatus> limitResultsByStatus, SearchClassifications matchClassifications, String sequencingProperty, SequencingOrder sequencingOrder, int startFrom, int pageSize) Return a list of metadata elements that match the supplied criteria.
List<OpenMetadataElement>	findMetadataElementsWithString(String userId, String searchString, int startFrom, int pageSize) Retrieve the metadata elements that contain the requested string.
List<RelatedMetadataElements>	findRelationshipsBetweenMetadataElements(String userId, String relationshipTypeName, SearchProperties searchProperties, String sequencingProperty, SequencingOrder sequencingOrder, int startFrom, int pageSize) Return a list of relationships that match the requested conditions.
List<GovernanceActionElement>	getActiveClaimedGovernanceActions(String userId, String governanceEngineGUID, int startFrom, int pageSize) Retrieve the governance actions that are still in process and that have been claimed by this caller's userId.
GovernanceActionElement	getGovernanceAction(String userId, String governanceActionGUID) Request the status of an executing governance action request.
OpenMetadataElement	getMetadataElementByGUID(String userId, String elementGUID) Retrieve the metadata element using its unique identifier.
List<RelatedMetadataElement>	getRelatedMetadataElements(String userId, String elementGUID, String relationshipTypeName, int startFrom, int pageSize) Retrieve the metadata elements connected to the supplied element.
String	initiateGovernanceAction(String userId, String qualifiedName, int domainIdentifier, String displayName, String description, List<String> requestSourceGUIDs, List<String> actionTargetGUIDs, List<String> receivedGuards, Date startTime, String governanceEngineName, String requestType, Map<String,String> requestParameters, String originatorServiceName, String originatorEngineName) Create a governance action in the metadata store which will trigger the governance action service associated with the supplied request type.
String	initiateGovernanceActionProcess(String userId, String processQualifiedName, List<String> requestSourceGUIDs, List<String> actionTargetGUIDs, Date startTime, Map<String,String> requestParameters, String originatorServiceName, String originatorEngineName) Using the named governance action process as a template, initiate a chain of governance actions.
void	reclassifyMetadataElementInStore(String userId, String metadataElementGUID, String classificationName, boolean replaceProperties, ElementProperties properties) Update the properties of a classification that is currently attached to a specific metadata element.
void	recordCompletionStatus(String userId, String governanceActionGUID, Map<String,String> requestParameters, CompletionStatus status, List<String> outputGuards, List<String> newActionTargetGUIDs) Declare that all of the processing for the governance action service is finished and the status of the work.
void	unclassifyMetadataElementInStore(String userId, String metadataElementGUID, String classificationName) Remove the named classification from a specific metadata element.
void	updateActionTargetStatus(String userId, String actionTargetGUID, GovernanceActionStatus status, Date startDate, Date completionDate) Update the status of a specific action target.
void	updateClassificationStatusInStore(String userId, String metadataElementGUID, String classificationName, Date effectiveFrom, Date effectiveTo) Update the effectivity dates of a specific classification attached to a metadata element.
void	updateGovernanceActionStatus(String userId, String governanceActionGUID, GovernanceActionStatus governanceActionStatus) Update the status of the governance action - providing the caller is permitted.
void	updateMetadataElementInStore(String userId, String metadataElementGUID, boolean replaceProperties, ElementProperties properties) Update the properties of a specific metadata element.
void	updateMetadataElementStatusInStore(String userId, String metadataElementGUID, ElementStatus newElementStatus, Date effectiveFrom, Date effectiveTo) Update the status of specific metadata element.
void	updateRelatedElementsInStore(String userId, String relationshipGUID, boolean replaceProperties, ElementProperties properties) Update the properties associated with a relationship.
void	updateRelatedElementsStatusInStore(String userId, String relationshipGUID, Date effectiveFrom, Date effectiveTo) Update the effectivity dates of a specific relationship between metadata elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceEngineClient

public GovernanceEngineClient(String serverName,
                              String serverPlatformURLRoot)
                       throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceEngineClient

public GovernanceEngineClient(String serverName,
                              String serverPlatformURLRoot,
                              String serverUserId,
                              String serverPassword)
                       throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

serverUserId - caller's userId embedded in all HTTP requests

serverPassword - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceEngineClient

public GovernanceEngineClient(String serverName,
                              String serverPlatformURLRoot,
                              GovernanceEngineRESTClient restClient,
                              int maxPageSize)
                       throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

Throws:

InvalidParameterException - there is a problem with the information about the remote OMAS

Method Detail

getMetadataElementByGUID

public OpenMetadataElement getMetadataElementByGUID(String userId,
                                                    String elementGUID)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Retrieve the metadata element using its unique identifier.

Specified by:

getMetadataElementByGUID in interface MetadataElementInterface

Parameters:

userId - caller's userId

elementGUID - unique identifier for the metadata element

Returns:

metadata element properties

Throws:

InvalidParameterException - the unique identifier is null or not known.

UserNotAuthorizedException - the governance action service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

findMetadataElementsWithString

public List<OpenMetadataElement> findMetadataElementsWithString(String userId,
                                                                String searchString,
                                                                int startFrom,
                                                                int pageSize)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException

Retrieve the metadata elements that contain the requested string.

Specified by:

findMetadataElementsWithString in interface MetadataElementInterface

Parameters:

userId - caller's userId

searchString - name to retrieve

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements (or null if no elements match the name)

Throws:

InvalidParameterException - the qualified name is null

UserNotAuthorizedException - the governance action service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

getRelatedMetadataElements

public List<RelatedMetadataElement> getRelatedMetadataElements(String userId,
                                                               String elementGUID,
                                                               String relationshipTypeName,
                                                               int startFrom,
                                                               int pageSize)
                                                        throws InvalidParameterException,
                                                               UserNotAuthorizedException,
                                                               PropertyServerException

Retrieve the metadata elements connected to the supplied element.

Specified by:

getRelatedMetadataElements in interface MetadataElementInterface

Parameters:

userId - caller's userId

elementGUID - unique identifier for the starting metadata element

relationshipTypeName - type name of relationships to follow (or null for all)

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of related elements

Throws:

InvalidParameterException - the unique identifier is null or not known; the relationship type is invalid

UserNotAuthorizedException - the governance action service is not able to access the elements

PropertyServerException - there is a problem accessing the metadata store

findMetadataElements

public List<OpenMetadataElement> findMetadataElements(String userId,
                                                      String metadataElementTypeName,
                                                      List<String> metadataElementSubtypeName,
                                                      SearchProperties searchProperties,
                                                      List<ElementStatus> limitResultsByStatus,
                                                      SearchClassifications matchClassifications,
                                                      String sequencingProperty,
                                                      SequencingOrder sequencingOrder,
                                                      int startFrom,
                                                      int pageSize)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Return a list of metadata elements that match the supplied criteria. The results can be returned over many pages.

Specified by:

findMetadataElements in interface MetadataElementInterface

Parameters:

userId - caller's userId

metadataElementTypeName - type of interest (null means any element type)

metadataElementSubtypeName - optional list of the subtypes of the metadataElementTypeName to include in the search results. Null means all subtypes.

searchProperties - Optional list of entity property conditions to match.

limitResultsByStatus - By default, entities in all statuses (other than DELETE) are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.

matchClassifications - Optional list of classifications to match.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

a list of elements matching the supplied criteria; null means no matching elements in the metadata store.

Throws:

InvalidParameterException - one of the search parameters are is invalid

UserNotAuthorizedException - the governance action service is not able to access the elements

PropertyServerException - there is a problem accessing the metadata store

findRelationshipsBetweenMetadataElements

public List<RelatedMetadataElements> findRelationshipsBetweenMetadataElements(String userId,
                                                                              String relationshipTypeName,
                                                                              SearchProperties searchProperties,
                                                                              String sequencingProperty,
                                                                              SequencingOrder sequencingOrder,
                                                                              int startFrom,
                                                                              int pageSize)
                                                                       throws InvalidParameterException,
                                                                              UserNotAuthorizedException,
                                                                              PropertyServerException

Return a list of relationships that match the requested conditions. The results can be received as a series of pages.

Specified by:

findRelationshipsBetweenMetadataElements in interface MetadataElementInterface

Parameters:

userId - caller's userId

relationshipTypeName - relationship's type. Null means all types (but may be slow so not recommended).

searchProperties - Optional list of relationship property conditions to match.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

a list of relationships. Null means no matching relationships.

Throws:

InvalidParameterException - one of the search parameters are is invalid

UserNotAuthorizedException - the governance action service is not able to access the elements

PropertyServerException - there is a problem accessing the metadata store

createMetadataElementInStore

public String createMetadataElementInStore(String userId,
                                           String metadataElementTypeName,
                                           ElementStatus initialStatus,
                                           Date effectiveFrom,
                                           Date effectiveTo,
                                           ElementProperties properties,
                                           String templateGUID)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Create a new metadata element in the metadata store. The type name comes from the open metadata types. The selected type also controls the names and types of the properties that are allowed. This version of the method allows access to advanced features such as multiple states and effectivity dates.

Specified by:

createMetadataElementInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

metadataElementTypeName - type name of the new metadata element

initialStatus - initial status of the metadata element

effectiveFrom - the date when this element is active - null for active on creation

effectiveTo - the date when this element becomes inactive - null for active until deleted

properties - properties of the new metadata element

templateGUID - the unique identifier of the existing asset to copy (this will copy all of the attachments such as nested content, schema connection etc)

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - the type name, status or one of the properties is invalid

UserNotAuthorizedException - the governance action service is not authorized to create this type of element

PropertyServerException - there is a problem with the metadata store

updateMetadataElementInStore

public void updateMetadataElementInStore(String userId,
                                         String metadataElementGUID,
                                         boolean replaceProperties,
                                         ElementProperties properties)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Update the properties of a specific metadata element. The properties must match the type definition associated with the metadata element when it was created. However, it is possible to update a few properties, or replace all of them by the value used in the replaceProperties flag.

Specified by:

updateMetadataElementInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

replaceProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.

properties - new properties for the metadata element

Throws:

InvalidParameterException - either the unique identifier or the properties are invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to update this element

PropertyServerException - there is a problem with the metadata store

updateMetadataElementStatusInStore

public void updateMetadataElementStatusInStore(String userId,
                                               String metadataElementGUID,
                                               ElementStatus newElementStatus,
                                               Date effectiveFrom,
                                               Date effectiveTo)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Update the status of specific metadata element. The new status must match a status value that is defined for the element's type assigned when it was created. The effectivity dates control the visibility of the element through specific APIs.

Specified by:

updateMetadataElementStatusInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

newElementStatus - new status value - or null to leave as is

effectiveFrom - the date when this element is active - null for active now

effectiveTo - the date when this element becomes inactive - null for active until deleted

Throws:

InvalidParameterException - either the unique identifier or the status are invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to update this element

PropertyServerException - there is a problem with the metadata store

deleteMetadataElementInStore

public void deleteMetadataElementInStore(String userId,
                                         String metadataElementGUID)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Delete a specific metadata element.

Specified by:

deleteMetadataElementInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

Throws:

InvalidParameterException - the unique identifier is null or invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to delete this element

PropertyServerException - there is a problem with the metadata store

classifyMetadataElementInStore

public void classifyMetadataElementInStore(String userId,
                                           String metadataElementGUID,
                                           String classificationName,
                                           Date effectiveFrom,
                                           Date effectiveTo,
                                           ElementProperties properties)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Add a new classification to the metadata element. Note that only one classification with the same name can be attached to a metadata element.

Specified by:

classifyMetadataElementInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

classificationName - name of the classification to add (if the classification is already present then use reclassify)

effectiveFrom - the date when this classification is active - null for active now

effectiveTo - the date when this classification becomes inactive - null for active until deleted

properties - properties to store in the new classification. These must conform to the valid properties associated with the classification name

Throws:

InvalidParameterException - the unique identifier or classification name is null or invalid in some way; properties do not match the valid properties associated with the classification's type definition

UserNotAuthorizedException - the governance action service is not authorized to update this element

PropertyServerException - there is a problem with the metadata store

reclassifyMetadataElementInStore

public void reclassifyMetadataElementInStore(String userId,
                                             String metadataElementGUID,
                                             String classificationName,
                                             boolean replaceProperties,
                                             ElementProperties properties)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Update the properties of a classification that is currently attached to a specific metadata element.

Specified by:

reclassifyMetadataElementInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

classificationName - unique name of the classification to update

replaceProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.

properties - new properties for the classification

Throws:

InvalidParameterException - the unique identifier or classification name is null or invalid in some way; properties do not match the valid properties associated with the classification's type definition

UserNotAuthorizedException - the governance action service is not authorized to update this element/classification

PropertyServerException - there is a problem with the metadata store

updateClassificationStatusInStore

public void updateClassificationStatusInStore(String userId,
                                              String metadataElementGUID,
                                              String classificationName,
                                              Date effectiveFrom,
                                              Date effectiveTo)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Update the effectivity dates of a specific classification attached to a metadata element. The effectivity dates control the visibility of the classification through specific APIs.

Specified by:

updateClassificationStatusInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

classificationName - unique name of the classification to update

effectiveFrom - the date when this element is active - null for active now

effectiveTo - the date when this element becomes inactive - null for active until deleted

Throws:

InvalidParameterException - either the unique identifier or the status are invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to update this element

PropertyServerException - there is a problem with the metadata store

unclassifyMetadataElementInStore

public void unclassifyMetadataElementInStore(String userId,
                                             String metadataElementGUID,
                                             String classificationName)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Remove the named classification from a specific metadata element.

Specified by:

unclassifyMetadataElementInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

metadataElementGUID - unique identifier of the metadata element to update

classificationName - unique name of the classification to remove

Throws:

InvalidParameterException - the unique identifier or classification name is null or invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to remove this classification

PropertyServerException - there is a problem with the metadata store

createRelatedElementsInStore

public String createRelatedElementsInStore(String userId,
                                           String relationshipTypeName,
                                           String metadataElement1GUID,
                                           String metadataElement2GUID,
                                           Date effectiveFrom,
                                           Date effectiveTo,
                                           ElementProperties properties)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Create a relationship between two metadata elements. It is important to put the right element at each end of the relationship according to the type definition since this will affect how the relationship is interpreted.

Specified by:

createRelatedElementsInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

relationshipTypeName - name of the type of relationship to create. This will determine the types of metadata elements that can be related and the properties that can be associated with this relationship.

metadataElement1GUID - unique identifier of the metadata element at end 1 of the relationship

metadataElement2GUID - unique identifier of the metadata element at end 2 of the relationship

effectiveFrom - the date when this element is active - null for active now

effectiveTo - the date when this element becomes inactive - null for active until deleted

properties - the properties of the relationship

Returns:

unique identifier of the new relationship

Throws:

InvalidParameterException - the unique identifier's of the metadata elements are null or invalid in some way; the properties are not valid for this type of relationship

UserNotAuthorizedException - the governance action service is not authorized to create this type of relationship

PropertyServerException - there is a problem with the metadata store

updateRelatedElementsInStore

public void updateRelatedElementsInStore(String userId,
                                         String relationshipGUID,
                                         boolean replaceProperties,
                                         ElementProperties properties)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Update the properties associated with a relationship.

Specified by:

updateRelatedElementsInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

relationshipGUID - unique identifier of the relationship to update

replaceProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.

properties - new properties for the relationship

Throws:

InvalidParameterException - the unique identifier of the relationship is null or invalid in some way; the properties are not valid for this type of relationship

UserNotAuthorizedException - the governance action service is not authorized to update this relationship

PropertyServerException - there is a problem with the metadata store

updateRelatedElementsStatusInStore

public void updateRelatedElementsStatusInStore(String userId,
                                               String relationshipGUID,
                                               Date effectiveFrom,
                                               Date effectiveTo)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Update the effectivity dates of a specific relationship between metadata elements. The effectivity dates control the visibility of the classification through specific APIs.

Specified by:

updateRelatedElementsStatusInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

relationshipGUID - unique identifier of the relationship to update

effectiveFrom - the date when this element is active - null for active now

effectiveTo - the date when this element becomes inactive - null for active until deleted

Throws:

InvalidParameterException - either the unique identifier or the status are invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to update this element

PropertyServerException - there is a problem with the metadata store

deleteRelatedElementsInStore

public void deleteRelatedElementsInStore(String userId,
                                         String relationshipGUID)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Delete a relationship between two metadata elements.

Specified by:

deleteRelatedElementsInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

relationshipGUID - unique identifier of the relationship to delete

Throws:

InvalidParameterException - the unique identifier of the relationship is null or invalid in some way

UserNotAuthorizedException - the governance action service is not authorized to delete this relationship

PropertyServerException - there is a problem with the metadata store

updateActionTargetStatus

public void updateActionTargetStatus(String userId,
                                     String actionTargetGUID,
                                     GovernanceActionStatus status,
                                     Date startDate,
                                     Date completionDate)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Update the status of a specific action target. By default, these values are derived from the values for the governance action service. However, if the governance action service has to process name target elements, then setting the status on each individual target will show the progress of the governance action service.

Specified by:

updateActionTargetStatus in interface GovernanceProcessingInterface

Parameters:

userId - caller's userId

actionTargetGUID - unique identifier of the governance action service.

status - status enum to show its progress

startDate - date/time that the governance action service started processing the target

completionDate - date/time that the governance process completed processing this target.

Throws:

InvalidParameterException - the action target GUID is not recognized

UserNotAuthorizedException - the governance action service is not authorized to update the action target properties

PropertyServerException - there is a problem connecting to the metadata store

updateGovernanceActionStatus

public void updateGovernanceActionStatus(String userId,
                                         String governanceActionGUID,
                                         GovernanceActionStatus governanceActionStatus)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Update the status of the governance action - providing the caller is permitted.

Specified by:

updateGovernanceActionStatus in interface GovernanceProcessingInterface

Parameters:

userId - identifier of calling user

governanceActionGUID - identifier of the governance action request

governanceActionStatus - new status enum

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 metadata store.

recordCompletionStatus

public void recordCompletionStatus(String userId,
                                   String governanceActionGUID,
                                   Map<String,String> requestParameters,
                                   CompletionStatus status,
                                   List<String> outputGuards,
                                   List<String> newActionTargetGUIDs)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

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

Specified by:

recordCompletionStatus in interface GovernanceProcessingInterface

Parameters:

userId - caller's userId

governanceActionGUID - unique identifier of the governance action to update

requestParameters - request properties from the caller (will be passed onto any follow on actions)

status - completion status enum value

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

newActionTargetGUIDs - list of additional elements to add to the action targets for the next phase

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

initiateGovernanceAction

public String initiateGovernanceAction(String userId,
                                       String qualifiedName,
                                       int domainIdentifier,
                                       String displayName,
                                       String description,
                                       List<String> requestSourceGUIDs,
                                       List<String> actionTargetGUIDs,
                                       List<String> receivedGuards,
                                       Date startTime,
                                       String governanceEngineName,
                                       String requestType,
                                       Map<String,String> requestParameters,
                                       String originatorServiceName,
                                       String originatorEngineName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Create a governance action in the metadata store which will trigger the governance action service associated with the supplied request type. The governance action remains to act as a record of the actions taken for auditing.

Specified by:

initiateGovernanceAction in interface GovernanceProcessingInterface

Parameters:

userId - caller's userId

qualifiedName - unique identifier to give this governance action

domainIdentifier - governance domain associated with this action (0=ALL)

displayName - display name for this action

description - description for this action

requestSourceGUIDs - request source elements for the resulting governance action service

actionTargetGUIDs - list of action targets for the resulting governance action service

receivedGuards - list of guards to initiate the governance action

startTime - future start time or null for "as soon as possible"

governanceEngineName - name of the governance engine that should execute the request

requestType - request type to identify the governance action service to run

requestParameters - properties to pass to the governance action service

originatorServiceName - unique name of the requesting governance service (if initiated by a governance engine).

originatorEngineName - optional unique name of the requesting governance engine (if initiated by a governance engine).

Returns:

unique identifier of the governance action

Throws:

InvalidParameterException - null qualified name

UserNotAuthorizedException - this governance action service is not authorized to create a governance action

PropertyServerException - there is a problem with the metadata store

initiateGovernanceActionProcess

public String initiateGovernanceActionProcess(String userId,
                                              String processQualifiedName,
                                              List<String> requestSourceGUIDs,
                                              List<String> actionTargetGUIDs,
                                              Date startTime,
                                              Map<String,String> requestParameters,
                                              String originatorServiceName,
                                              String originatorEngineName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Using the named governance action process as a template, initiate a chain of governance actions.

Specified by:

initiateGovernanceActionProcess in interface GovernanceProcessingInterface

Parameters:

userId - caller's userId

processQualifiedName - unique name of the governance action process to use

requestSourceGUIDs - request source elements for the resulting governance action service

actionTargetGUIDs - list of action targets for the resulting governance action service

startTime - future start time or null for "as soon as possible".

requestParameters - request properties to be passed to the first governance action

originatorServiceName - unique name of the requesting governance service (if initiated by a governance engine).

originatorEngineName - optional unique name of the governance engine (if initiated by a governance engine).

Returns:

unique identifier of the first governance action of the process

Throws:

InvalidParameterException - null or unrecognized qualified name of the process

UserNotAuthorizedException - this governance action service is not authorized to create a governance action process

PropertyServerException - there is a problem with the metadata store

createIncidentReport

public String createIncidentReport(String userId,
                                   String qualifiedName,
                                   int domainIdentifier,
                                   String background,
                                   List<IncidentImpactedElement> impactedResources,
                                   List<IncidentDependency> previousIncidents,
                                   Map<String,Integer> incidentClassifiers,
                                   Map<String,String> additionalProperties,
                                   String originatorGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Create an incident report to capture the situation detected by this governance action service. This incident report will be processed by other governance activities.

Specified by:

createIncidentReport in interface GovernanceProcessingInterface

Parameters:

userId - caller's userId

qualifiedName - unique identifier to give this new incident report

domainIdentifier - governance domain associated with this action (0=ALL)

background - description of the situation

impactedResources - details of the resources impacted by this situation

previousIncidents - links to previous incident reports covering this situation

incidentClassifiers - initial classifiers for the incident report

additionalProperties - additional arbitrary properties for the incident reports

originatorGUID - the unique identifier of the person or process that created the incident

Returns:

unique identifier of the resulting incident report

Throws:

InvalidParameterException - null or non-unique qualified name for the incident report

UserNotAuthorizedException - this governance action service is not authorized to create a incident report

PropertyServerException - there is a problem with the metadata store

getGovernanceAction

public GovernanceActionElement getGovernanceAction(String userId,
                                                   String governanceActionGUID)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Request the status of an executing governance action request.

Specified by:

getGovernanceAction in interface GovernanceProcessingInterface

Parameters:

userId - identifier of calling user

governanceActionGUID - identifier of the governance action request.

Returns:

status enum

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 metadata store.

claimGovernanceAction

public void claimGovernanceAction(String userId,
                                  String governanceActionGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Request that execution of a governance action is allocated to the caller.

Specified by:

claimGovernanceAction in interface GovernanceProcessingInterface

Parameters:

userId - identifier of calling user

governanceActionGUID - identifier of the governance action 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 metadata store.

getActiveClaimedGovernanceActions

public List<GovernanceActionElement> getActiveClaimedGovernanceActions(String userId,
                                                                       String governanceEngineGUID,
                                                                       int startFrom,
                                                                       int pageSize)
                                                                throws InvalidParameterException,
                                                                       UserNotAuthorizedException,
                                                                       PropertyServerException

Retrieve the governance actions that are still in process and that have been claimed by this caller's userId. This call is used when the caller restarts.

Specified by:

getActiveClaimedGovernanceActions in interface GovernanceProcessingInterface

Parameters:

userId - userId of caller

governanceEngineGUID - unique identifier of governance engine

startFrom - starting from element

pageSize - maximum elements to return

Returns:

list of governance action elements

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 metadata store.