Package org.odpi.openmetadata.frameworkservices.gaf.client

Class OpenGovernanceClientBase

java.lang.Object

org.odpi.openmetadata.frameworkservices.gaf.client.OpenGovernanceClientBase

All Implemented Interfaces:

ActionControlInterface, DuplicateManagementInterface, GovernanceActionProcessInterface, GovernanceActionTypeInterface

Direct Known Subclasses:

GovernanceContextClientBase, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceServiceClient, OpenGovernanceServiceClient

public class OpenGovernanceClientBase
extends Object
implements ActionControlInterface, GovernanceActionTypeInterface, GovernanceActionProcessInterface, DuplicateManagementInterface

OpenGovernanceClientBase provides common governance services that originate in the Governance Action Framework (GAF). This includes the ability to define and execute governance action processes as well as manage duplicates.

Field Summary

Fields

Modifier and Type	Field	Description
protected final InvalidParameterHandler	invalidParameterHandler
protected final NullRequestBody	nullRequestBody
protected final String	serverName
protected final String	serverPlatformURLRoot
protected final String	serviceURLMarker

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	cancelEngineAction(String userId, String engineActionGUID)	Request that execution of an engine action is stopped.
String	createGovernanceActionProcess(String userId, GovernanceActionProcessProperties processProperties, ProcessStatus initialStatus)	Create a new metadata element to represent a governance action process.
String	createGovernanceActionProcessStep(String userId, GovernanceActionProcessStepProperties processStepProperties)	Create a new metadata element to represent a governance action process step.
String	createGovernanceActionType(String userId, GovernanceActionTypeProperties properties)	Create a new metadata element to represent a governance action type.
List<EngineActionElement>	findEngineActions(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of engine action metadata elements that contain the search string.
List<GovernanceActionProcessElement>	findGovernanceActionProcesses(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of governance action process metadata elements that contain the search string.
List<GovernanceActionProcessStepElement>	findGovernanceActionProcessSteps(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of governance action process step metadata elements that contain the search string.
List<GovernanceActionTypeElement>	findGovernanceActionTypes(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of governance action type metadata elements that contain the search string.
List<EngineActionElement>	getActiveEngineActions(String userId, int startFrom, int pageSize)	Retrieve the engine actions that are still in process.
EngineActionElement	getEngineAction(String userId, String engineActionGUID)	Request the status of an executing engine action request.
List<EngineActionElement>	getEngineActions(String userId, int startFrom, int pageSize)	Retrieve the engine actions known to the server.
List<EngineActionElement>	getEngineActionsByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of engine action metadata elements with a matching qualified or display name.
FirstGovernanceActionProcessStepElement	getFirstActionProcessStep(String userId, String processGUID)	Return the governance action process step that is the first step in a governance action process.
GovernanceActionProcessElement	getGovernanceActionProcessByGUID(String userId, String processGUID)	Retrieve the governance action process metadata element with the supplied unique identifier.
List<GovernanceActionProcessElement>	getGovernanceActionProcessesByName(String userId, String name, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of governance action process metadata elements with a matching qualified or display name.
GovernanceActionProcessGraph	getGovernanceActionProcessGraph(String userId, String processGUID, Date effectiveTime)	Retrieve the governance action process metadata element with the supplied unique identifier along with its process flow implementation.
GovernanceActionProcessStepElement	getGovernanceActionProcessStepByGUID(String userId, String processStepGUID)	Retrieve the governance action process step metadata element with the supplied unique identifier.
List<GovernanceActionProcessStepElement>	getGovernanceActionProcessStepsByName(String userId, String name, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of governance action process step metadata elements with a matching qualified or display name.
GovernanceActionTypeElement	getGovernanceActionTypeByGUID(String userId, String governanceActionTypeGUID)	Retrieve the governance action type metadata element with the supplied unique identifier.
List<GovernanceActionTypeElement>	getGovernanceActionTypesByName(String userId, String name, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of governance action type metadata elements with a matching qualified or display name.
List<NextGovernanceActionProcessStepElement>	getNextGovernanceActionProcessSteps(String userId, String processStepGUID, int startFrom, int pageSize)	Return the list of next action process step defined for the governance action process.
String	initiateEngineAction(String userId, String qualifiedName, int domainIdentifier, String displayName, String description, List<String> requestSourceGUIDs, List<NewActionTarget> actionTargets, List<String> receivedGuards, Date startTime, String governanceEngineName, String requestType, Map<String,String> requestParameters, String processName, String requestSourceName, String originatorServiceName, String originatorEngineName)	Create an engine action in the metadata store which will trigger the governance service associated with the supplied request type.
String	initiateGovernanceActionProcess(String userId, String processQualifiedName, List<String> requestSourceGUIDs, List<NewActionTarget> actionTargets, Date startTime, Map<String,String> requestParameters, String originatorServiceName, String originatorEngineName)	Using the named governance action process as a template, initiate a chain of engine actions.
String	initiateGovernanceActionType(String userId, String governanceActionTypeQualifiedName, List<String> requestSourceGUIDs, List<NewActionTarget> actionTargets, Date startTime, Map<String,String> requestParameters, String originatorServiceName, String originatorEngineName)	Using the named governance action type as a template, initiate an engine action.
void	linkConsolidatedDuplicate(String userId, String consolidatedElementGUID, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes, List<String> sourceElementGUIDs)	Identify an element that acts as a consolidated version for a set of duplicate elements.
void	linkElementsAsPeerDuplicates(String userId, String metadataElement1GUID, String metadataElement2GUID, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes, boolean setKnownDuplicate)	Link elements as peer duplicates.
void	publishGovernanceActionProcess(String userId, String processGUID)	Update the zones for the asset so that it becomes visible to consumers.
void	removeFirstActionProcessStep(String userId, String processGUID)	Remove the link between a governance process and that governance action process step that defines its first step.
void	removeGovernanceActionProcess(String userId, String processGUID)	Remove the metadata element representing a governance action process.
void	removeGovernanceActionProcessStep(String userId, String processStepGUID)	Remove the metadata element representing a governance action process step.
void	removeGovernanceActionType(String userId, String governanceActionTypeGUID)	Remove the metadata element representing a governance action type.
void	removeNextActionProcessStep(String userId, String processStepLinkGUID)	Remove a follow-on step from a governance action process.
void	setupFirstActionProcessStep(String userId, String processGUID, String processStepGUID, String guard)	Set up a link between a governance action process and a governance action process step.
String	setupNextActionProcessStep(String userId, String currentActionProcessStepGUID, String nextActionProcessStepGUID, String guard, boolean mandatoryGuard)	Add a link between two governance action process steps to show that one follows on from the other when a governance action process is executing.
void	updateGovernanceActionProcess(String userId, String processGUID, boolean isMergeUpdate, ProcessStatus processStatus, GovernanceActionProcessProperties processProperties)	Update the metadata element representing a governance action process.
void	updateGovernanceActionProcessStep(String userId, String processStepGUID, boolean isMergeUpdate, GovernanceActionProcessStepProperties processStepProperties)	Update the metadata element representing a governance action process step.
void	updateGovernanceActionType(String userId, String governanceActionTypeGUID, boolean isMergeUpdate, GovernanceActionTypeProperties properties)	Update the metadata element representing a governance action type.
void	updateNextActionProcessStep(String userId, String nextProcessStepLinkGUID, String guard, boolean mandatoryGuard)	Update the properties of the link between two governance action process steps that shows that one follows on from the other when a governance action process is executing.
void	withdrawGovernanceActionProcess(String userId, String processGUID)	Update the zones for the asset so that it is no longer visible to consumers.

Methods inherited from class java.lang.Object

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

Field Details

serverName

protected final String serverName

serviceURLMarker

protected final String serviceURLMarker

serverPlatformURLRoot

protected final String serverPlatformURLRoot

invalidParameterHandler

protected final InvalidParameterHandler invalidParameterHandler

nullRequestBody

protected final NullRequestBody nullRequestBody

Constructor Details

OpenGovernanceClientBase

public OpenGovernanceClientBase(String serviceURLMarker,
 String serverName,
 String serverPlatformURLRoot,
 int maxPageSize)
                         throws InvalidParameterException

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

Parameters:

serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)

serverName - name of the server to connect to

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

maxPageSize - pre-initialized parameter limit

Throws:

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

OpenGovernanceClientBase

public OpenGovernanceClientBase(String serviceURLMarker,
 String serverName,
 String serverPlatformURLRoot,
 String serverUserId,
 String serverPassword,
 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:

serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)

serverName - name of the server to connect to

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

serverUserId - caller's userId embedded in all HTTP requests

serverPassword - caller's password embedded in all HTTP requests

maxPageSize - pre-initialized parameter limit

Throws:

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

OpenGovernanceClientBase

public OpenGovernanceClientBase(String serviceURLMarker,
 String serverName,
 String serverPlatformURLRoot,
 GAFRESTClient 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:

serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)

serverName - name of the server to connect to

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

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

Throws:

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

Method Details

initiateEngineAction

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

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

Specified by:

initiateEngineAction in interface ActionControlInterface

Parameters:

userId - caller's userId

qualifiedName - unique identifier to give this engine 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 service

actionTargets - list of action target names to GUIDs for the resulting governance service

receivedGuards - list of guards to initiate the engine action

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

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

requestType - governance request type from the caller

requestParameters - properties to pass to the governance service

processName - name of the process that this action is a part of

requestSourceName - source of the request

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 engine action

Throws:

InvalidParameterException - null qualified name

UserNotAuthorizedException - the caller is not authorized to create an engine action

PropertyServerException - there is a problem with the metadata store

initiateGovernanceActionType

public String initiateGovernanceActionType(String userId,
 String governanceActionTypeQualifiedName,
 List<String> requestSourceGUIDs,
 List<NewActionTarget> actionTargets,
 Date startTime,
 Map<String,String> requestParameters,
 String originatorServiceName,
 String originatorEngineName)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Using the named governance action type as a template, initiate an engine action.

Specified by:

initiateGovernanceActionType in interface ActionControlInterface

Parameters:

userId - caller's userId

governanceActionTypeQualifiedName - unique name of the governance action type to use

requestSourceGUIDs - request source elements for the resulting governance service

actionTargets - list of action target names to GUIDs for the resulting governance service

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

requestParameters - request properties to be passed to the engine 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 engine action

Throws:

InvalidParameterException - null or unrecognized qualified name of the type

UserNotAuthorizedException - the caller is not authorized to create an engine action

PropertyServerException - there is a problem with the metadata store

initiateGovernanceActionProcess

public String initiateGovernanceActionProcess(String userId,
 String processQualifiedName,
 List<String> requestSourceGUIDs,
 List<NewActionTarget> actionTargets,
 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 engine actions.

Specified by:

initiateGovernanceActionProcess in interface ActionControlInterface

Parameters:

userId - caller's userId

processQualifiedName - unique name of the governance action process to use

requestSourceGUIDs - request source elements for the resulting governance service

actionTargets - list of action target names to GUIDs for the resulting governance service

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

requestParameters - request properties to be passed to the first engine 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 governance action process instance

Throws:

InvalidParameterException - null or unrecognized qualified name of the process

UserNotAuthorizedException - the caller is not authorized to create a governance action process

PropertyServerException - there is a problem with the metadata store

getEngineAction

public EngineActionElement getEngineAction(String userId,
 String engineActionGUID)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Request the status of an executing engine action request.

Specified by:

getEngineAction in interface ActionControlInterface

Parameters:

userId - identifier of calling user

engineActionGUID - identifier of the engine 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.

cancelEngineAction

public void cancelEngineAction(String userId,
 String engineActionGUID)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Request that execution of an engine action is stopped.

Specified by:

cancelEngineAction in interface ActionControlInterface

Parameters:

userId - identifier of calling user

engineActionGUID - identifier of the engine 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.

getEngineActions

public List<EngineActionElement> getEngineActions(String userId,
 int startFrom,
 int pageSize)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the engine actions known to the server.

Specified by:

getEngineActions in interface ActionControlInterface

Parameters:

userId - userId of caller

startFrom - starting from element

pageSize - maximum elements to return

Returns:

list of engine 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.

getActiveEngineActions

public List<EngineActionElement> getActiveEngineActions(String userId,
 int startFrom,
 int pageSize)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the engine actions that are still in process.

Specified by:

getActiveEngineActions in interface ActionControlInterface

Parameters:

userId - userId of caller

startFrom - starting from element

pageSize - maximum elements to return

Returns:

list of engine 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.

findEngineActions

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

Retrieve the list of engine action metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findEngineActions in interface ActionControlInterface

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getEngineActionsByName

public List<EngineActionElement> getEngineActionsByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of engine action metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getEngineActionsByName in interface ActionControlInterface

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

linkElementsAsPeerDuplicates

public void linkElementsAsPeerDuplicates(String userId,
 String metadataElement1GUID,
 String metadataElement2GUID,
 int statusIdentifier,
 String steward,
 String stewardTypeName,
 String stewardPropertyName,
 String source,
 String notes,
 boolean setKnownDuplicate)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Link elements as peer duplicates. Create a simple relationship between two elements. If the relationship already exists, the properties are updated.

Specified by:

linkElementsAsPeerDuplicates in interface DuplicateManagementInterface

Parameters:

userId - caller's userId

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

statusIdentifier - what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)

steward - identifier of the steward

stewardTypeName - type of element used to identify the steward

stewardPropertyName - property name used to identify steward

source - source of the duplicate detection processing

notes - notes for the steward

setKnownDuplicate - boolean flag indicating whether the KnownDuplicate classification should be set on the linked entities.

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 caller is not authorized to create this type of relationship

PropertyServerException - there is a problem with the metadata store

linkConsolidatedDuplicate

public void linkConsolidatedDuplicate(String userId,
 String consolidatedElementGUID,
 int statusIdentifier,
 String steward,
 String stewardTypeName,
 String stewardPropertyName,
 String source,
 String notes,
 List<String> sourceElementGUIDs)
                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Identify an element that acts as a consolidated version for a set of duplicate elements. (The consolidated element is created using createMetadataElement.)

Specified by:

linkConsolidatedDuplicate in interface DuplicateManagementInterface

Parameters:

userId - caller's userId

consolidatedElementGUID - unique identifier of the metadata element

statusIdentifier - what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)

steward - identifier of the steward

stewardTypeName - type of element used to identify the steward

stewardPropertyName - property name used to identify steward

source - source of the duplicate detection processing

notes - notes for the steward

sourceElementGUIDs - List of the source elements that must be linked to the consolidated element. It is assumed that they already have the KnownDuplicateClassification.

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 caller is not authorized to create this type of relationship

PropertyServerException - there is a problem with the metadata store

createGovernanceActionType

public String createGovernanceActionType(String userId,
 GovernanceActionTypeProperties properties)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a governance action type.

Specified by:

createGovernanceActionType in interface GovernanceActionTypeInterface

Parameters:

userId - calling user

properties - properties about the governance action type to store

Returns:

unique identifier of the new governance action type

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateGovernanceActionType

public void updateGovernanceActionType(String userId,
 String governanceActionTypeGUID,
 boolean isMergeUpdate,
 GovernanceActionTypeProperties properties)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a governance action type.

Specified by:

updateGovernanceActionType in interface GovernanceActionTypeInterface

Parameters:

userId - calling user

governanceActionTypeGUID - unique identifier of the metadata element to update

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

properties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeGovernanceActionType

public void removeGovernanceActionType(String userId,
 String governanceActionTypeGUID)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a governance action type.

Specified by:

removeGovernanceActionType in interface GovernanceActionTypeInterface

Parameters:

userId - calling user

governanceActionTypeGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findGovernanceActionTypes

public List<GovernanceActionTypeElement> findGovernanceActionTypes(String userId,
 String searchString,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action type metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findGovernanceActionTypes in interface GovernanceActionTypeInterface

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective date/time for query

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceActionTypesByName

public List<GovernanceActionTypeElement> getGovernanceActionTypesByName(String userId,
 String name,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getGovernanceActionTypesByName in interface GovernanceActionTypeInterface

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective date/time for query

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceActionTypeByGUID

public GovernanceActionTypeElement getGovernanceActionTypeByGUID(String userId,
 String governanceActionTypeGUID)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance action type metadata element with the supplied unique identifier.

Specified by:

getGovernanceActionTypeByGUID in interface GovernanceActionTypeInterface

Parameters:

userId - calling user

governanceActionTypeGUID - unique identifier of the governance action type

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createGovernanceActionProcess

public String createGovernanceActionProcess(String userId,
 GovernanceActionProcessProperties processProperties,
 ProcessStatus initialStatus)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a governance action process.

Specified by:

createGovernanceActionProcess in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processProperties - properties about the process to store

initialStatus - status value for the new process (default = ACTIVE)

Returns:

unique identifier of the new process

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateGovernanceActionProcess

public void updateGovernanceActionProcess(String userId,
 String processGUID,
 boolean isMergeUpdate,
 ProcessStatus processStatus,
 GovernanceActionProcessProperties processProperties)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a governance action process.

Specified by:

updateGovernanceActionProcess in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processGUID - unique identifier of the metadata element to update

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

processStatus - new status for the process

processProperties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

publishGovernanceActionProcess

public void publishGovernanceActionProcess(String userId,
 String processGUID)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the zones for the asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Governance Engine OMAS).

Specified by:

publishGovernanceActionProcess in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawGovernanceActionProcess

public void withdrawGovernanceActionProcess(String userId,
 String processGUID)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the zones for the asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Governance Engine OMAS. This is the setting when the process is first created).

Specified by:

withdrawGovernanceActionProcess in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeGovernanceActionProcess

public void removeGovernanceActionProcess(String userId,
 String processGUID)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a governance action process.

Specified by:

removeGovernanceActionProcess in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findGovernanceActionProcesses

public List<GovernanceActionProcessElement> findGovernanceActionProcesses(String userId,
 String searchString,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action process metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findGovernanceActionProcesses in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective date/time for query

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceActionProcessesByName

public List<GovernanceActionProcessElement> getGovernanceActionProcessesByName(String userId,
 String name,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action process metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getGovernanceActionProcessesByName in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective date/time for query

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceActionProcessByGUID

public GovernanceActionProcessElement getGovernanceActionProcessByGUID(String userId,
 String processGUID)
                                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance action process metadata element with the supplied unique identifier.

Specified by:

getGovernanceActionProcessByGUID in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processGUID - unique identifier of the requested metadata element

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceActionProcessGraph

public GovernanceActionProcessGraph getGovernanceActionProcessGraph(String userId,
 String processGUID,
 Date effectiveTime)
                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance action process metadata element with the supplied unique identifier along with its process flow implementation. This includes the process steps and the links between them

Specified by:

getGovernanceActionProcessGraph in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processGUID - unique identifier of the requested metadata element

effectiveTime - effective date/time for query

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createGovernanceActionProcessStep

public String createGovernanceActionProcessStep(String userId,
 GovernanceActionProcessStepProperties processStepProperties)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a governance action process step.

Specified by:

createGovernanceActionProcessStep in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processStepProperties - properties about the process step to store

Returns:

unique identifier of the new governance action process step

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateGovernanceActionProcessStep

public void updateGovernanceActionProcessStep(String userId,
 String processStepGUID,
 boolean isMergeUpdate,
 GovernanceActionProcessStepProperties processStepProperties)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a governance action process step.

Specified by:

updateGovernanceActionProcessStep in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processStepGUID - unique identifier of the metadata element to update

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

processStepProperties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeGovernanceActionProcessStep

public void removeGovernanceActionProcessStep(String userId,
 String processStepGUID)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a governance action process step.

Specified by:

removeGovernanceActionProcessStep in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processStepGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findGovernanceActionProcessSteps

public List<GovernanceActionProcessStepElement> findGovernanceActionProcessSteps(String userId,
 String searchString,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action process step metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findGovernanceActionProcessSteps in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective date/time for query

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceActionProcessStepsByName

public List<GovernanceActionProcessStepElement> getGovernanceActionProcessStepsByName(String userId,
 String name,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action process step metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getGovernanceActionProcessStepsByName in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective date/time for query

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceActionProcessStepByGUID

public GovernanceActionProcessStepElement getGovernanceActionProcessStepByGUID(String userId,
 String processStepGUID)
                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance action process step metadata element with the supplied unique identifier.

Specified by:

getGovernanceActionProcessStepByGUID in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processStepGUID - unique identifier of the governance action process step

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupFirstActionProcessStep

public void setupFirstActionProcessStep(String userId,
 String processGUID,
 String processStepGUID,
 String guard)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Set up a link between a governance action process and a governance action process step. This defines the first step in the process.

Specified by:

setupFirstActionProcessStep in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

processStepGUID - unique identifier of the governance action process step

guard - optional guard for the first governance service to run

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getFirstActionProcessStep

public FirstGovernanceActionProcessStepElement getFirstActionProcessStep(String userId,
 String processGUID)
                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the governance action process step that is the first step in a governance action process.

Specified by:

getFirstActionProcessStep in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

Returns:

properties of the first governance action process step

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeFirstActionProcessStep

public void removeFirstActionProcessStep(String userId,
 String processGUID)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the link between a governance process and that governance action process step that defines its first step.

Specified by:

removeFirstActionProcessStep in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupNextActionProcessStep

public String setupNextActionProcessStep(String userId,
 String currentActionProcessStepGUID,
 String nextActionProcessStepGUID,
 String guard,
 boolean mandatoryGuard)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Add a link between two governance action process steps to show that one follows on from the other when a governance action process is executing.

Specified by:

setupNextActionProcessStep in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

currentActionProcessStepGUID - unique identifier of the governance action process step that defines the previous step in the governance action process

nextActionProcessStepGUID - unique identifier of the governance action process step that defines the next step in the governance action process

guard - guard required for this next step to proceed - or null for always run the next step.

mandatoryGuard - means that no next steps can run if this guard is not returned

Returns:

unique identifier of the new link

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateNextActionProcessStep

public void updateNextActionProcessStep(String userId,
 String nextProcessStepLinkGUID,
 String guard,
 boolean mandatoryGuard)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the properties of the link between two governance action process steps that shows that one follows on from the other when a governance action process is executing.

Specified by:

updateNextActionProcessStep in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

nextProcessStepLinkGUID - unique identifier of the relationship between the governance action process steps

guard - guard required for this next step to proceed - or null for always run the next step.

mandatoryGuard - means that no next steps can run if this guard is not returned

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getNextGovernanceActionProcessSteps

public List<NextGovernanceActionProcessStepElement> getNextGovernanceActionProcessSteps(String userId,
 String processStepGUID,
 int startFrom,
 int pageSize)
                                                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of next action process step defined for the governance action process.

Specified by:

getNextGovernanceActionProcessSteps in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processStepGUID - unique identifier of the current governance action process step

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

return the list of relationships and attached governance action process steps.

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeNextActionProcessStep

public void removeNextActionProcessStep(String userId,
 String processStepLinkGUID)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a follow-on step from a governance action process.

Specified by:

removeNextActionProcessStep in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processStepLinkGUID - unique identifier of the relationship between the governance action process steps

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)