org.odpi.openmetadata.accessservices.governanceengine.server

Class GovernanceActionProcessRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.governanceengine.server.GovernanceActionProcessRESTServices

public class GovernanceActionProcessRESTServices
extends Object

The GovernanceActionProcessRESTServices provides the server-side implementation of the services used by an external user to define governance action processes.

Constructor Summary

Constructors

Constructor and Description
GovernanceActionProcessRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
GUIDResponse	createGovernanceActionProcess(String serverName, String userId, NewGovernanceActionProcessRequestBody requestBody) Create a new metadata element to represent a governance action process.
GUIDResponse	createGovernanceActionType(String serverName, String userId, GovernanceActionTypeProperties requestBody) Create a new metadata element to represent a governance action type.
GovernanceActionProcessElementsResponse	findGovernanceActionProcesses(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody) Retrieve the list of governance action process metadata elements that contain the search string.
GovernanceActionTypeElementsResponse	findGovernanceActionTypes(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody) Retrieve the list of governance action type metadata elements that contain the search string.
GovernanceActionTypeElementResponse	getFirstActionType(String serverName, String userId, String processGUID) Return the governance action type that is the first step in a governance action process.
GovernanceActionProcessElementResponse	getGovernanceActionProcessByGUID(String serverName, String userId, String processGUID) Retrieve the governance action process metadata element with the supplied unique identifier.
GovernanceActionProcessElementsResponse	getGovernanceActionProcessesByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody) Retrieve the list of governance action process metadata elements with a matching qualified or display name.
GovernanceActionTypeElementResponse	getGovernanceActionTypeByGUID(String serverName, String userId, String actionTypeGUID) Retrieve the governance action type metadata element with the supplied unique identifier.
GovernanceActionTypeElementsResponse	getGovernanceActionTypesByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody) Retrieve the list of governance action type metadata elements with a matching qualified or display name.
NextGovernanceActionTypeElementsResponse	getNextGovernanceActionTypes(String serverName, String userId, String actionTypeGUID, int startFrom, int pageSize) Return the lust of next action type defined for the governance action process.
VoidResponse	publishGovernanceActionProcess(String serverName, String userId, String processGUID, NullRequestBody requestBody) Update the zones for the asset so that it becomes visible to consumers.
VoidResponse	removeFirstActionType(String serverName, String userId, String processGUID, NullRequestBody requestBody) Remove the link between a governance process and that governance action type that defines its first step.
VoidResponse	removeGovernanceActionProcess(String serverName, String userId, String processGUID, NullRequestBody requestBody) Remove the metadata element representing a governance action process.
VoidResponse	removeGovernanceActionType(String serverName, String userId, String actionTypeGUID, NullRequestBody requestBody) Remove the metadata element representing a governance action type.
VoidResponse	removeNextActionType(String serverName, String userId, String actionLinkGUID, NullRequestBody requestBody) Remove a follow on step from a governance action process.
VoidResponse	setupFirstActionType(String serverName, String userId, String processGUID, String actionTypeGUID, String requestBody) Set up a link between an governance action process and a governance action type.
GUIDResponse	setupNextActionType(String serverName, String userId, String currentActionTypeGUID, String nextActionTypeGUID, NextGovernanceActionTypeRequestBody requestBody) Add a link between two governance action types to show that one follows on from the other when a governance action process is executing.
VoidResponse	updateGovernanceActionProcess(String serverName, String userId, String processGUID, UpdateGovernanceActionProcessRequestBody requestBody) Update the metadata element representing a governance action process.
VoidResponse	updateGovernanceActionType(String serverName, String userId, String actionTypeGUID, UpdateGovernanceActionTypeRequestBody requestBody) Update the metadata element representing a governance action type.
VoidResponse	updateNextActionType(String serverName, String userId, String nextActionLinkGUID, NextGovernanceActionTypeRequestBody requestBody) 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.
VoidResponse	withdrawGovernanceActionProcess(String serverName, String userId, String processGUID, NullRequestBody requestBody) 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

GovernanceActionProcessRESTServices

public GovernanceActionProcessRESTServices()

Default constructor

Method Detail

createGovernanceActionProcess

public GUIDResponse createGovernanceActionProcess(String serverName,
                                                  String userId,
                                                  NewGovernanceActionProcessRequestBody requestBody)

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

Parameters:

serverName - name of the service to route the request to

userId - calling user

requestBody - properties about the process to store and status value for the new process (default = ACTIVE)

Returns:

unique identifier of the new process or 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 VoidResponse updateGovernanceActionProcess(String serverName,
                                                  String userId,
                                                  String processGUID,
                                                  UpdateGovernanceActionProcessRequestBody requestBody)

Update the metadata element representing a governance action process.

Parameters:

serverName - name of the service to route the request to

userId - calling user

processGUID - unique identifier of the metadata element to update

requestBody - new properties for the metadata element

Returns:

void or 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 VoidResponse publishGovernanceActionProcess(String serverName,
                                                   String userId,
                                                   String processGUID,
                                                   NullRequestBody requestBody)

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 Asset Manager OMAS).

Parameters:

serverName - name of the service to route the request to

userId - calling user

processGUID - unique identifier of the metadata element to publish

requestBody - null request body

Returns:

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 VoidResponse withdrawGovernanceActionProcess(String serverName,
                                                    String userId,
                                                    String processGUID,
                                                    NullRequestBody requestBody)

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 Asset Manager OMAS. This is the setting when the process is first created).

Parameters:

serverName - name of the service to route the request to

userId - calling user

processGUID - unique identifier of the metadata element to withdraw

requestBody - null request body

Returns:

void or 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 VoidResponse removeGovernanceActionProcess(String serverName,
                                                  String userId,
                                                  String processGUID,
                                                  NullRequestBody requestBody)

Remove the metadata element representing a governance action process.

Parameters:

serverName - name of the service to route the request to

userId - calling user

processGUID - unique identifier of the metadata element to remove

requestBody - null request body

Returns:

void or 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 GovernanceActionProcessElementsResponse findGovernanceActionProcesses(String serverName,
                                                                             String userId,
                                                                             int startFrom,
                                                                             int pageSize,
                                                                             SearchStringRequestBody requestBody)

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

Parameters:

serverName - name of the service to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - string to find in the properties

Returns:

list of matching metadata elements or 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 GovernanceActionProcessElementsResponse getGovernanceActionProcessesByName(String serverName,
                                                                                  String userId,
                                                                                  int startFrom,
                                                                                  int pageSize,
                                                                                  NameRequestBody requestBody)

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

Parameters:

serverName - name of the service to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - name to search for

Returns:

list of matching metadata elements or 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 GovernanceActionProcessElementResponse getGovernanceActionProcessByGUID(String serverName,
                                                                               String userId,
                                                                               String processGUID)

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

Parameters:

serverName - name of the service to route the request to

userId - calling user

processGUID - unique identifier of the requested metadata element

Returns:

requested metadata element or 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 GUIDResponse createGovernanceActionType(String serverName,
                                               String userId,
                                               GovernanceActionTypeProperties requestBody)

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

Parameters:

serverName - name of the service to route the request to

userId - calling user

requestBody - properties about the process to store

Returns:

unique identifier of the new governance action type or 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 VoidResponse updateGovernanceActionType(String serverName,
                                               String userId,
                                               String actionTypeGUID,
                                               UpdateGovernanceActionTypeRequestBody requestBody)

Update the metadata element representing a governance action type.

Parameters:

serverName - name of the service to route the request to

userId - calling user

actionTypeGUID - unique identifier of the metadata element to update

requestBody - new properties for the metadata element

Returns:

void or 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 VoidResponse removeGovernanceActionType(String serverName,
                                               String userId,
                                               String actionTypeGUID,
                                               NullRequestBody requestBody)

Remove the metadata element representing a governance action type.

Parameters:

serverName - name of the service to route the request to

userId - calling user

actionTypeGUID - unique identifier of the metadata element to remove

requestBody - null request body

Returns:

void or 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 GovernanceActionTypeElementsResponse findGovernanceActionTypes(String serverName,
                                                                      String userId,
                                                                      int startFrom,
                                                                      int pageSize,
                                                                      SearchStringRequestBody requestBody)

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

Parameters:

serverName - name of the service to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - string to find in the properties

Returns:

list of matching metadata elements or 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 GovernanceActionTypeElementsResponse getGovernanceActionTypesByName(String serverName,
                                                                           String userId,
                                                                           int startFrom,
                                                                           int pageSize,
                                                                           NameRequestBody requestBody)

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

Parameters:

serverName - name of the service to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - name to search for

Returns:

list of matching metadata elements or 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 GovernanceActionTypeElementResponse getGovernanceActionTypeByGUID(String serverName,
                                                                         String userId,
                                                                         String actionTypeGUID)

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

Parameters:

serverName - name of the service to route the request to

userId - calling user

actionTypeGUID - unique identifier of the governance action type

Returns:

requested metadata element or 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 VoidResponse setupFirstActionType(String serverName,
                                         String userId,
                                         String processGUID,
                                         String actionTypeGUID,
                                         String requestBody)

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

Parameters:

serverName - name of the service to route the request to

userId - calling user

processGUID - unique identifier of the governance action process

actionTypeGUID - unique identifier of the governance action type

requestBody - optional guard

Returns:

void or 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 GovernanceActionTypeElementResponse getFirstActionType(String serverName,
                                                              String userId,
                                                              String processGUID)

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

Parameters:

serverName - name of the service to route the request to

userId - calling user

processGUID - unique identifier of the governance action process

Returns:

properties of the governance action type or 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 VoidResponse removeFirstActionType(String serverName,
                                          String userId,
                                          String processGUID,
                                          NullRequestBody requestBody)

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

Parameters:

serverName - name of the service to route the request to

userId - calling user

processGUID - unique identifier of the governance action process

requestBody - null request body

Returns:

void or 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 GUIDResponse setupNextActionType(String serverName,
                                        String userId,
                                        String currentActionTypeGUID,
                                        String nextActionTypeGUID,
                                        NextGovernanceActionTypeRequestBody requestBody)

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

Parameters:

serverName - name of the service to route the request to

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

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

Returns:

unique identifier of the new link or 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 VoidResponse updateNextActionType(String serverName,
                                         String userId,
                                         String nextActionLinkGUID,
                                         NextGovernanceActionTypeRequestBody requestBody)

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.

Parameters:

serverName - name of the service to route the request to

userId - calling user

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

requestBody - guard required for this next step to proceed - or null for always run the next step - and flags

Returns:

void or 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 NextGovernanceActionTypeElementsResponse getNextGovernanceActionTypes(String serverName,
                                                                             String userId,
                                                                             String actionTypeGUID,
                                                                             int startFrom,
                                                                             int pageSize)

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

Parameters:

serverName - name of the service to route the request to

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 or 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 VoidResponse removeNextActionType(String serverName,
                                         String userId,
                                         String actionLinkGUID,
                                         NullRequestBody requestBody)

Remove a follow on step from a governance action process.

Parameters:

serverName - name of the service to route the request to

userId - calling user

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

requestBody - null request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)