Package org.odpi.openmetadata.accessservices.governanceengine.server

Class GovernanceEngineRESTServices

  • public class GovernanceEngineRESTServices
extends Object
    The GovernanceEngineRESTServices provides the server-side implementation of the services used by the governance engine as it is managing requests to execute open governance services in the governance server. These services align with the interface definitions from the Governance Action Framework (GAF).

    • Constructor Detail

      • GovernanceEngineRESTServices

        public GovernanceEngineRESTServices()
        Default constructor

    • Method Detail

      • getOutTopicConnection

        public ConnectionResponse getOutTopicConnection​(String serverName,
                                                String userId,
                                                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 governance engine definition.

      • logAssetAuditMessage

        public VoidResponse logAssetAuditMessage​(String serverName,
                                         String userId,
                                         String assetGUID,
                                         String governanceService,
                                         String message)
        Log an audit message about this asset.
        Parameters:
        serverName - name of server instance to route request to
        userId - userId of user making request.
        assetGUID - unique identifier for asset.
        governanceService - name of 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.

      • linkElementsAsDuplicates

        public VoidResponse linkElementsAsDuplicates​(String serverName,
                                             String userId,
                                             PeerDuplicatesRequestBody requestBody)
        Link elements as peer duplicates. Create a simple relationship between two elements. If the relationship already exists, the properties are updated.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        requestBody - parameters for the relationship
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid, or the elements are of different types PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • linkConsolidatedDuplicate

        public VoidResponse linkConsolidatedDuplicate​(String serverName,
                                              String userId,
                                              ConsolidatedDuplicatesRequestBody requestBody)
        Identify an element that acts as a consolidated version for a set of duplicate elements. (The consolidated element is created using createMetadataElement.) Creates a simple relationship between the elements. If the ConsolidatedDuplicate classification already exists, the properties are updated.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        requestBody - parameters for the relationship
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid, or the elements are of different types PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • updateActionTargetStatus

        public VoidResponse updateActionTargetStatus​(String serverName,
                                             String userId,
                                             ActionTargetStatusRequestBody requestBody)
        Update the status of a specific action target. By default, these values are derived from the values for the governance action service. However, if the governance action service has to process name target elements, then setting the status on each individual target will show the progress of the governance action service.
        Parameters:
        serverName - name of server instance to route request to
        userId - caller's userId
        requestBody - relationship properties
        Returns:
        void or InvalidParameterException the action target GUID is not recognized UserNotAuthorizedException the governance action service is not authorized to update the action target properties PropertyServerException there is a problem connecting to the metadata store

      • updateGovernanceActionStatus

        public VoidResponse updateGovernanceActionStatus​(String serverName,
                                                 String userId,
                                                 String governanceActionGUID,
                                                 StatusRequestBody requestBody)
        Update the status of the governance action - providing the caller is permitted.
        Parameters:
        serverName - name of server instance to route request to
        userId - identifier of calling user
        governanceActionGUID - identifier of the governance action request
        requestBody - 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.

      • recordCompletionStatus

        public VoidResponse recordCompletionStatus​(String serverName,
                                           String userId,
                                           String governanceActionGUID,
                                           CompletionStatusRequestBody requestBody)
        Declare that all the processing for the governance action service is finished and the status of the work.
        Parameters:
        serverName - name of server instance to route request to
        userId - caller's userId
        governanceActionGUID - unique identifier of the governance action to update
        requestBody - completion status enum value, optional guard strings for triggering subsequent action(s) plus a list of additional elements to add to the action targets for the next phase
        Returns:
        void or InvalidParameterException the completion status is null UserNotAuthorizedException the governance action service is not authorized to update the governance action service status PropertyServerException there is a problem connecting to the metadata store

      • initiateGovernanceAction

        public GUIDResponse initiateGovernanceAction​(String serverName,
                                             String userId,
                                             String governanceEngineName,
                                             GovernanceActionRequestBody requestBody)
        Create a governance action in the metadata store which will trigger the governance action service associated with the supplied request type. The governance action remains to act as a record of the actions taken for auditing.
        Parameters:
        serverName - name of server instance to route request to
        userId - caller's userId
        governanceEngineName - name of the governance engine that should execute the request
        requestBody - properties for the governance action and to pass to the governance action service
        Returns:
        unique identifier of the governance action or InvalidParameterException null qualified name UserNotAuthorizedException this governance action service is not authorized to create a governance action PropertyServerException there is a problem with the metadata store

      • initiateGovernanceActionProcess

        public GUIDResponse initiateGovernanceActionProcess​(String serverName,
                                                    String userId,
                                                    GovernanceActionProcessRequestBody requestBody)
        Using the named governance action process as a template, initiate a chain of governance actions.
        Parameters:
        serverName - name of server instance to route request to
        userId - caller's userId
        requestBody - properties to initiate the new instance of the process
        Returns:
        unique identifier of the first governance action of the process or InvalidParameterException null or unrecognized qualified name of the process UserNotAuthorizedException this governance action service is not authorized to create a governance action process PropertyServerException there is a problem with the metadata store

      • getGovernanceAction

        public GovernanceActionElementResponse getGovernanceAction​(String serverName,
                                                           String userId,
                                                           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.

      • claimGovernanceAction

        public VoidResponse claimGovernanceAction​(String serverName,
                                          String userId,
                                          String governanceActionGUID,
                                          NullRequestBody requestBody)
        Request that execution of a governance action is allocated to the caller.
        Parameters:
        serverName - name of server instance to route request to
        userId - identifier of calling user
        governanceActionGUID - 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

        public GovernanceActionElementsResponse getGovernanceActions​(String serverName,
                                                             String userId,
                                                             int startFrom,
                                                             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

        public GovernanceActionElementsResponse getActiveGovernanceActions​(String serverName,
                                                                   String userId,
                                                                   int startFrom,
                                                                   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.

      • getActiveClaimedGovernanceActions

        public GovernanceActionElementsResponse 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. This call is used when the caller restarts.
        Parameters:
        serverName - name of server instance to route request to
        userId - userId of caller
        governanceEngineGUID - unique identifier of governance engine
        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.