Package org.odpi.openmetadata.viewservices.actionauthor.server

Class ActionAuthorRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.actionauthor.server.ActionAuthorRESTServices
public class ActionAuthorRESTServices extends TokenController
The ActionAuthorRESTServices provides the implementation of the Action Author Open Metadata View Service (OMVS).

  • Constructor Details

    • ActionAuthorRESTServices

      public ActionAuthorRESTServices()
      Default constructor

  • Method Details

    • linkTargetForGovernanceAction

      public VoidResponse linkTargetForGovernanceAction(String serverName, String governanceActionGUID, String elementGUID, NewRelationshipRequestBody requestBody)
      Link a governance action to the element it is to work on (action target).
      Parameters:
      serverName - name of the service to route the request to
      governanceActionGUID - unique identifier of the governance action
      elementGUID - unique identifier of the target
      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)

    • detachTargetForGovernanceAction

      public VoidResponse detachTargetForGovernanceAction(String serverName, String governanceActionGUID, String elementGUID, DeleteRelationshipRequestBody requestBody)
      Detach a governance action from the element it is to work on (action target).
      Parameters:
      serverName - name of the service to route the request to
      governanceActionGUID - unique identifier of the governance action
      elementGUID - unique identifier of the target
      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)

    • linkGovernanceActionExecutor

      public VoidResponse linkGovernanceActionExecutor(String serverName, String governanceActionTypeGUID, String governanceEngineGUID, NewRelationshipRequestBody requestBody)
      Link a governance action type to the governance engine that it is to call.
      Parameters:
      serverName - name of the service to route the request to
      governanceActionTypeGUID - unique identifier of the governance action type
      governanceEngineGUID - unique identifier of the governance engine to call
      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)

    • detachGovernanceActionExecutor

      public VoidResponse detachGovernanceActionExecutor(String serverName, String governanceActionTypeGUID, String governanceEngineGUID, DeleteRelationshipRequestBody requestBody)
      Detach a governance action type from the governance engine that it is to call.
      Parameters:
      serverName - name of the service to route the request to
      governanceActionTypeGUID - unique identifier of the governance action type
      governanceEngineGUID - unique identifier of the governance engine to call
      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)

    • setupFirstActionProcessStep

      public VoidResponse setupFirstActionProcessStep(String serverName, String processGUID, String processStepGUID, NewRelationshipRequestBody requestBody)
      Set up a link between a governance action process and a governance action process step. This defines the first step in the process.
      Parameters:
      serverName - name of the service to route the request to
      processGUID - unique identifier of the governance action process
      processStepGUID - unique identifier of the governance action process step
      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)

    • removeFirstProcessStep

      public VoidResponse removeFirstProcessStep(String serverName, String processGUID, String firstProcessStepGUID, DeleteRelationshipRequestBody requestBody)
      Remove the link between a governance process and that governance action process step that defines its first step.
      Parameters:
      serverName - name of the service to route the request to
      processGUID - unique identifier of the governance action process
      firstProcessStepGUID - unique identifier of the first step in the 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)

    • setupNextActionProcessStep

      public GUIDResponse setupNextActionProcessStep(String serverName, String currentProcessStepGUID, String nextProcessStepGUID, NewRelationshipRequestBody requestBody)
      Add a link between two governance action process steps 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
      currentProcessStepGUID - unique identifier of the governance action process step that defines the previous step in the governance action process
      nextProcessStepGUID - unique identifier of the governance action process step 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)

    • updateNextActionProcessStep

      public VoidResponse updateNextActionProcessStep(String serverName, String nextProcessStepLinkGUID, UpdateRelationshipRequestBody requestBody)
      Update the properties of the link between two governance action process steps 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
      nextProcessStepLinkGUID - unique identifier of the relationship between the governance action process steps
      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)

    • removeNextActionProcessStep

      public VoidResponse removeNextActionProcessStep(String serverName, String actionLinkGUID, DeleteRelationshipRequestBody requestBody)
      Remove a follow-on step from a governance action process.
      Parameters:
      serverName - name of the service to route the request to
      actionLinkGUID - unique identifier of the relationship between the governance action process steps
      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)