Package org.odpi.openmetadata.accessservices.assetmanager.server.spring

Class GovernanceExchangeResource

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.server.spring.GovernanceExchangeResource

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/asset-manager/users/{userId}")
public class GovernanceExchangeResource
extends Object

The GovernanceExchangeResource provides the server-side implementation for defining/retrieving governance metadata.

Constructor Summary

Constructors

Constructor	Description
GovernanceExchangeResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
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.
GovernanceActionElementsResponse	getActiveGovernanceActions(String serverName, String userId, int startFrom, int pageSize)	Retrieve the governance actions that are still in process.
GovernanceActionTypeElementResponse	getFirstActionType(String serverName, String userId, String processGUID)	Return the governance action type that is the first step in a governance action process.
GovernanceActionElementResponse	getGovernanceAction(String serverName, String userId, String governanceActionGUID)	Request the status and properties of an executing governance action request.
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.
GovernanceActionElementsResponse	getGovernanceActions(String serverName, String userId, int startFrom, int pageSize)	Retrieve the governance actions that are known to the server.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceExchangeResource

public GovernanceExchangeResource()

Default constructor

Method Detail

findGovernanceActionProcesses

@PostMapping(path="/governance-action-processes/by-search-string")
public GovernanceActionProcessElementsResponse findGovernanceActionProcesses(@PathVariable
                                                                             String serverName,
                                                                             @PathVariable
                                                                             String userId,
                                                                             @RequestParam
                                                                             int startFrom,
                                                                             @RequestParam
                                                                             int pageSize,
                                                                             @RequestBody
                                                                             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

@PostMapping(path="/governance-action-processes/by-name")
public GovernanceActionProcessElementsResponse getGovernanceActionProcessesByName(@PathVariable
                                                                                  String serverName,
                                                                                  @PathVariable
                                                                                  String userId,
                                                                                  @RequestParam
                                                                                  int startFrom,
                                                                                  @RequestParam
                                                                                  int pageSize,
                                                                                  @RequestBody
                                                                                  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

@GetMapping(path="/governance-action-processes/{processGUID}")
public GovernanceActionProcessElementResponse getGovernanceActionProcessByGUID(@PathVariable
                                                                               String serverName,
                                                                               @PathVariable
                                                                               String userId,
                                                                               @PathVariable
                                                                               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)

findGovernanceActionTypes

@PostMapping(path="/governance-action-types/by-search-string")
public GovernanceActionTypeElementsResponse findGovernanceActionTypes(@PathVariable
                                                                      String serverName,
                                                                      @PathVariable
                                                                      String userId,
                                                                      @RequestParam
                                                                      int startFrom,
                                                                      @RequestParam
                                                                      int pageSize,
                                                                      @RequestBody
                                                                      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

@PostMapping(path="/governance-action-types/by-name")
public GovernanceActionTypeElementsResponse getGovernanceActionTypesByName(@PathVariable
                                                                           String serverName,
                                                                           @PathVariable
                                                                           String userId,
                                                                           @RequestParam
                                                                           int startFrom,
                                                                           @RequestParam
                                                                           int pageSize,
                                                                           @RequestBody
                                                                           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

@GetMapping(path="/governance-action-types/{actionTypeGUID}")
public GovernanceActionTypeElementResponse getGovernanceActionTypeByGUID(@PathVariable
                                                                         String serverName,
                                                                         @PathVariable
                                                                         String userId,
                                                                         @PathVariable
                                                                         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)

getFirstActionType

@GetMapping(path="/governance-action-processes/{processGUID}/first-action-type")
public GovernanceActionTypeElementResponse getFirstActionType(@PathVariable
                                                              String serverName,
                                                              @PathVariable
                                                              String userId,
                                                              @PathVariable
                                                              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)

getNextGovernanceActionTypes

@GetMapping(path="/governance-action-types/{actionTypeGUID}/next-action-type")
public NextGovernanceActionTypeElementsResponse getNextGovernanceActionTypes(@PathVariable
                                                                             String serverName,
                                                                             @PathVariable
                                                                             String userId,
                                                                             @PathVariable
                                                                             String actionTypeGUID,
                                                                             @RequestParam
                                                                             int startFrom,
                                                                             @RequestParam
                                                                             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)

getGovernanceAction

@GetMapping(path="/governance-actions/{governanceActionGUID}")
public GovernanceActionElementResponse getGovernanceAction(@PathVariable
                                                           String serverName,
                                                           @PathVariable
                                                           String userId,
                                                           @PathVariable
                                                           String governanceActionGUID)

Request the status and properties of an executing governance action request.

Parameters:

serverName - name of server instance to route request to

userId - identifier of calling user

governanceActionGUID - identifier of the governance action request.

Returns:

governance action properties and status or 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.

getGovernanceActions

@GetMapping(path="/governance-actions")
public GovernanceActionElementsResponse getGovernanceActions(@PathVariable
                                                             String serverName,
                                                             @PathVariable
                                                             String userId,
                                                             @RequestParam
                                                             int startFrom,
                                                             @RequestParam
                                                             int pageSize)

Retrieve the governance actions that are known to the server.

Parameters:

serverName - name of server instance to route request to

userId - userId of caller

startFrom - starting from element

pageSize - maximum elements to return

Returns:

list of governance action elements or 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.

getActiveGovernanceActions

@GetMapping(path="/governance-actions/active")
public GovernanceActionElementsResponse getActiveGovernanceActions(@PathVariable
                                                                   String serverName,
                                                                   @PathVariable
                                                                   String userId,
                                                                   @RequestParam
                                                                   int startFrom,
                                                                   @RequestParam
                                                                   int pageSize)

Retrieve the governance actions that are still in process.

Parameters:

serverName - name of server instance to route request to

userId - userId of caller

startFrom - starting from element

pageSize - maximum elements to return

Returns:

list of governance action elements or 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.