Package org.odpi.openmetadata.accessservices.governanceengine.client

Class GovernanceActionProcessClient

java.lang.Object

org.odpi.openmetadata.accessservices.governanceengine.client.GovernanceActionProcessClient

All Implemented Interfaces:

GovernanceActionProcessInterface

public class GovernanceActionProcessClient
extends Object
implements GovernanceActionProcessInterface

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	Description
GovernanceActionProcessClient(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
GovernanceActionProcessClient(String serverName, String serverPlatformURLRoot, String serverUserId, String serverPassword)	Create a new client that passes userId and password in each HTTP request.
GovernanceActionProcessClient(String serverName, String serverPlatformURLRoot, GovernanceEngineRESTClient restClient, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.

Method Summary

Modifier and Type	Method	Description
String	createGovernanceActionProcess(String userId, GovernanceActionProcessProperties processProperties, ProcessStatus initialStatus)	Create a new metadata element to represent a governance action process.
String	createGovernanceActionType(String userId, GovernanceActionTypeProperties actionTypeProperties)	Create a new metadata element to represent a governance action type.
List<GovernanceActionProcessElement>	findGovernanceActionProcesses(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of governance action process metadata elements that contain the search string.
List<GovernanceActionTypeElement>	findGovernanceActionTypes(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of governance action type metadata elements that contain the search string.
GovernanceActionTypeElement	getFirstActionType(String userId, String processGUID)	Return the governance action type 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)	Retrieve the list of governance action process metadata elements with a matching qualified or display name.
GovernanceActionTypeElement	getGovernanceActionTypeByGUID(String userId, String actionTypeGUID)	Retrieve the governance action type metadata element with the supplied unique identifier.
List<GovernanceActionTypeElement>	getGovernanceActionTypesByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of governance action type metadata elements with a matching qualified or display name.
List<NextGovernanceActionTypeElement>	getNextGovernanceActionTypes(String userId, String actionTypeGUID, int startFrom, int pageSize)	Return the lust of next action type defined for the governance action process.
void	publishGovernanceActionProcess(String userId, String processGUID)	Update the zones for the asset so that it becomes visible to consumers.
void	removeFirstActionType(String userId, String processGUID)	Remove the link between a governance process and that governance action type that defines its first step.
void	removeGovernanceActionProcess(String userId, String processGUID)	Remove the metadata element representing a governance action process.
void	removeGovernanceActionType(String userId, String actionTypeGUID)	Remove the metadata element representing a governance action type.
void	removeNextActionType(String userId, String actionLinkGUID)	Remove a follow on step from a governance action process.
void	setupFirstActionType(String userId, String processGUID, String actionTypeGUID, String guard)	Set up a link between an governance action process and a governance action type.
String	setupNextActionType(String userId, String currentActionTypeGUID, String nextActionTypeGUID, String guard, boolean mandatoryGuard, boolean ignoreMultipleTriggers)	Add a link between two governance action types 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	updateGovernanceActionType(String userId, String actionTypeGUID, boolean isMergeUpdate, GovernanceActionTypeProperties actionTypeProperties)	Update the metadata element representing a governance action type.
void	updateNextActionType(String userId, String nextActionLinkGUID, String guard, boolean mandatoryGuard, boolean ignoreMultipleTriggers)	Update the properties of the link between two governance action types 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

Constructor Detail

GovernanceActionProcessClient

public GovernanceActionProcessClient(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.

GovernanceActionProcessClient

public GovernanceActionProcessClient(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.

GovernanceActionProcessClient

public GovernanceActionProcessClient(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

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

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

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)

createGovernanceActionType

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

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

Specified by:

createGovernanceActionType in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

actionTypeProperties - properties about the process 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 actionTypeGUID,
                                       boolean isMergeUpdate,
                                       GovernanceActionTypeProperties actionTypeProperties)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Update the metadata element representing a governance action type.

Specified by:

updateGovernanceActionType in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

actionTypeGUID - unique identifier of the metadata element to update

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

actionTypeProperties - 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 actionTypeGUID)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Remove the metadata element representing a governance action type.

Specified by:

removeGovernanceActionType in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

actionTypeGUID - 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)
                                                            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 GovernanceActionProcessInterface

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)

getGovernanceActionTypesByName

public List<GovernanceActionTypeElement> getGovernanceActionTypesByName(String userId,
                                                                        String name,
                                                                        int startFrom,
                                                                        int pageSize)
                                                                 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 GovernanceActionProcessInterface

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)

getGovernanceActionTypeByGUID

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

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

Specified by:

getGovernanceActionTypeByGUID in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

actionTypeGUID - 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)

setupFirstActionType

public void setupFirstActionType(String userId,
                                 String processGUID,
                                 String actionTypeGUID,
                                 String guard)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

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

Specified by:

setupFirstActionType in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

actionTypeGUID - unique identifier of the governance action type

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)

getFirstActionType

public GovernanceActionTypeElement getFirstActionType(String userId,
                                                      String processGUID)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

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

Specified by:

getFirstActionType in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

Returns:

properties of the 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)

removeFirstActionType

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

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

Specified by:

removeFirstActionType 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)

setupNextActionType

public String setupNextActionType(String userId,
                                  String currentActionTypeGUID,
                                  String nextActionTypeGUID,
                                  String guard,
                                  boolean mandatoryGuard,
                                  boolean ignoreMultipleTriggers)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

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

Specified by:

setupNextActionType in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

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

nextActionTypeGUID - unique identifier of the governance action type 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

ignoreMultipleTriggers - prevent multiple instances of the next step to run (or not)

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)

updateNextActionType

public void updateNextActionType(String userId,
                                 String nextActionLinkGUID,
                                 String guard,
                                 boolean mandatoryGuard,
                                 boolean ignoreMultipleTriggers)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

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

Specified by:

updateNextActionType in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

nextActionLinkGUID - unique identifier of the relationship between the governance action types

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

ignoreMultipleTriggers - prevent multiple instances of the next step to run (or not)

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)

getNextGovernanceActionTypes

public List<NextGovernanceActionTypeElement> getNextGovernanceActionTypes(String userId,
                                                                          String actionTypeGUID,
                                                                          int startFrom,
                                                                          int pageSize)
                                                                   throws InvalidParameterException,
                                                                          UserNotAuthorizedException,
                                                                          PropertyServerException

Return the lust of next action type defined for the governance action process.

Specified by:

getNextGovernanceActionTypes in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

actionTypeGUID - unique identifier of the current governance action type

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

return the list of relationships and attached governance action types.

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)

removeNextActionType

public void removeNextActionType(String userId,
                                 String actionLinkGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Remove a follow on step from a governance action process.

Specified by:

removeNextActionType in interface GovernanceActionProcessInterface

Parameters:

userId - calling user

actionLinkGUID - unique identifier of the relationship between the governance action types

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)