Class GovernanceEngineOMASResource
java.lang.Object
org.odpi.openmetadata.accessservices.governanceengine.server.spring.GovernanceEngineOMASResource
@RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/governance-engine/users/{userId}")
public class GovernanceEngineOMASResource
extends Object
GovernanceEngineOMASResource supports the REST APIs for running Governance Action Service
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclaimGovernanceAction
(String serverName, String userId, String governanceActionGUID, NullRequestBody requestBody) Request that execution of a governance action is allocated to the caller.findGovernanceActions
(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody) Retrieve the list of governance action metadata elements that contain the search string.getActiveClaimedGovernanceActions
(String serverName, String userId, String governanceEngineGUID, int startFrom, int pageSize) Retrieve the governance actions that are still in process and that have been claimed by this caller's userId.getActiveGovernanceActions
(String serverName, String userId, int startFrom, int pageSize) Retrieve the governance actions that are still in process.getGovernanceAction
(String serverName, String userId, String governanceActionGUID) Request the status and properties of an executing governance action request.getGovernanceActions
(String serverName, String userId, int startFrom, int pageSize) Retrieve the governance actions that are known to the server.getGovernanceActionsByName
(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody) Retrieve the list of governance action metadata elements with a matching qualified or display name.getOutTopicConnection
(String serverName, String userId, String callerId) Return the connection object for the Governance Engine OMAS's out topic.logAssetAuditMessage
(String serverName, String userId, String assetGUID, String governanceService, String message) Log an audit message about an asset.updateGovernanceActionStatus
(String serverName, String userId, String governanceActionGUID, StatusRequestBody requestBody) Update the status of the governance action - providing the caller is permitted.
-
Constructor Details
-
GovernanceEngineOMASResource
public GovernanceEngineOMASResource()
-
-
Method Details
-
getOutTopicConnection
@GetMapping(path="/topics/out-topic-connection/{callerId}") public ConnectionResponse getOutTopicConnection(@PathVariable String serverName, @PathVariable String userId, @PathVariable String callerId) Return the connection object for the Governance Engine OMAS's out topic.- Parameters:
serverName
- name of the service to route the request to.userId
- identifier of calling user.callerId
- unique identifier of the caller- Returns:
- connection object for the out topic or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the topic connection.
-
logAssetAuditMessage
@PostMapping(path="/assets/{assetGUID}/log-records/{governanceService}") public VoidResponse logAssetAuditMessage(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String governanceService, @RequestBody String message) Log an audit message about an asset.- Parameters:
serverName
- name of server instance to route request touserId
- userId of user making request.assetGUID
- unique identifier for asset.governanceService
- unique name for governance service.message
- message to log- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem that occurred within the property server.
-
updateGovernanceActionStatus
@PostMapping(path="/governance-actions/{governanceActionGUID}/status/update") public VoidResponse updateGovernanceActionStatus(@PathVariable String serverName, @PathVariable String userId, @PathVariable String governanceActionGUID, @RequestBody StatusRequestBody requestBody) Update the status of the governance action - providing the caller is permitted.- Parameters:
serverName
- name of server instance to route request touserId
- identifier of calling usergovernanceActionGUID
- identifier of the governance action requestrequestBody
- new status ordinal- Returns:
- void 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.
-
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 touserId
- identifier of calling usergovernanceActionGUID
- 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.
-
claimGovernanceAction
@PostMapping(path="/governance-actions/{governanceActionGUID}/claim") public VoidResponse claimGovernanceAction(@PathVariable String serverName, @PathVariable String userId, @PathVariable String governanceActionGUID, @RequestBody(required=false) NullRequestBody requestBody) Request that execution of a governance action is allocated to the caller.- Parameters:
serverName
- name of server instance to route request touserId
- identifier of calling usergovernanceActionGUID
- identifier of the governance action request.requestBody
- null request body- Returns:
- void 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 touserId
- userId of callerstartFrom
- starting from elementpageSize
- 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 touserId
- userId of callerstartFrom
- starting from elementpageSize
- 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.
-
getActiveClaimedGovernanceActions
@GetMapping(path="/governance-engines/{governanceEngineGUID}/active-governance-actions") public GovernanceActionElementsResponse getActiveClaimedGovernanceActions(@PathVariable String serverName, @PathVariable String userId, @PathVariable String governanceEngineGUID, @RequestParam int startFrom, @RequestParam int pageSize) Retrieve the governance actions that are still in process and that have been claimed by this caller's userId. This call is used when the caller restarts.- Parameters:
serverName
- name of server instance to route request touserId
- userId of callergovernanceEngineGUID
- unique identifier of governance enginestartFrom
- starting from elementpageSize
- 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.
-
findGovernanceActions
@PostMapping(path="/governance-actions/by-search-string") public GovernanceActionElementsResponse findGovernanceActions(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody SearchStringRequestBody requestBody) Retrieve the list of governance action 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 touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- 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)
-
getGovernanceActionsByName
@PostMapping(path="/governance-actions/by-name") public GovernanceActionElementsResponse getGovernanceActionsByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody NameRequestBody requestBody) Retrieve the list of governance action 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 touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- 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)
-