Package org.odpi.openmetadata.viewservices.automatedcuration.server

Class AutomatedCurationRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.automatedcuration.server.AutomatedCurationRESTServices
public class AutomatedCurationRESTServices extends TokenController
The AutomatedCurationRESTServices provides the implementation of the Automated Curation Open Metadata View Service (OMVS).

  • Constructor Details

    • AutomatedCurationRESTServices

      public AutomatedCurationRESTServices()
      Default constructor

  • Method Details

    • findTechnologyTypes

      public TechnologyTypeSummaryListResponse findTechnologyTypes(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of deployed implementation type metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      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 a problem reported in the open metadata server(s)

    • getTechnologyTypesForOpenMetadataType

      public TechnologyTypeSummaryListResponse getTechnologyTypesForOpenMetadataType(String serverName, String urlMarker, String typeName, ResultsRequestBody requestBody)
      Retrieve the list of deployed implementation type metadata elements linked to a particular open metadata type.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      typeName - the type name to search for
      requestBody - does the value start with the supplied string?
      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 a problem reported in the open metadata server(s)

    • getTechnologyTypeDetail

      public TechnologyTypeReportResponse getTechnologyTypeDetail(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the requested deployed implementation type metadata element.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      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 a problem reported in the open metadata server(s)

    • getTechnologyTypeHierarchy

      public TechnologyTypeHierarchyResponse getTechnologyTypeHierarchy(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the requested deployed implementation type metadata element and its subtypes. A mermaid version if the hierarchy is also returned.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      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 a problem reported in the open metadata server(s)

    • getTechnologyTypeElements

      public OpenMetadataRootElementsResponse getTechnologyTypeElements(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the requested deployed implementation type metadata element. There are no wildcards allowed in the name.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      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 a problem reported in the open metadata server(s)

    • createElementFromTemplate

      public GUIDResponse createElementFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      Create a new element from a template.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - information about the template
      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 a problem reported in the open metadata server(s)

    • saveClientSideSecret

      public VoidResponse saveClientSideSecret(String serverName, String urlMarker, String secretsStoreGUID, SecretsCollectionRequestBody requestBody)
      Creates or replaces the details of a client-side secret in the requested secret store.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      secretsStoreGUID - unique identifier of secret store asset
      requestBody - details of the secrets collection
      Returns:
      a list of projects InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteClientSideSecret

      public VoidResponse deleteClientSideSecret(String serverName, String urlMarker, String secretsStoreGUID, NameRequestBody requestBody)
      Removes the named client-side secret from the secrets store
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      secretsStoreGUID - unique identifier of secret store asset
      requestBody - name of the secrets collection
      Returns:
      a list of projects InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • cancelEngineAction

      public VoidResponse cancelEngineAction(String serverName, String urlMarker, String engineActionGUID)
      Request that an engine action is stopped.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      engineActionGUID - identifier of the engine action request.
      Returns:
      engine action properties and status or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • getActiveEngineActions

      public EngineActionElementsResponse getActiveEngineActions(String serverName, String urlMarker, int startFrom, int pageSize)
      Retrieve the engine actions that are still in process.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      startFrom - starting from position
      pageSize - maximum elements to return
      Returns:
      list of engine action elements or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • initiateEngineAction

      public GUIDResponse initiateEngineAction(String serverName, String urlMarker, String governanceEngineName, InitiateEngineActionRequestBody 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
      urlMarker - view service URL marker
      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 a problem with the metadata store

    • initiateGovernanceActionType

      public GUIDResponse initiateGovernanceActionType(String serverName, String urlMarker, InitiateGovernanceActionTypeRequestBody requestBody)
      Using the named governance action type as a template, initiate an engine action.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      requestBody - properties to initiate the new instance of the engine action
      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 a problem with the metadata store

    • initiateGovernanceActionProcess

      public GUIDResponse initiateGovernanceActionProcess(String serverName, String urlMarker, InitiateGovernanceActionProcessRequestBody 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
      urlMarker - view service URL marker
      requestBody - properties to initiate the new instance of the process
      Returns:
      unique identifier of the governance action process instance 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 a problem with the metadata store

    • updateEngineActionStatus

      public VoidResponse updateEngineActionStatus(String serverName, String urlMarker, String engineActionGUID, EngineActionStatusRequestBody requestBody)
      Update the status of the engine action - providing the caller is permitted.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      engineActionGUID - identifier of the engine action request
      requestBody - new status enum
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • claimEngineAction

      public VoidResponse claimEngineAction(String serverName, String urlMarker, String engineActionGUID)
      Request that execution of an engine action is allocated to the caller.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      engineActionGUID - identifier of the engine action request
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • getActiveClaimedEngineActions

      public EngineActionElementsResponse getActiveClaimedEngineActions(String serverName, String urlMarker, String governanceEngineGUID, int startFrom, int pageSize)
      Retrieve the engine 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
      urlMarker - view service URL marker
      governanceEngineGUID - unique identifier of governance engine
      startFrom - starting from position
      pageSize - maximum elements to return
      Returns:
      list of engine action elements or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • updateActionTargetStatus

      public VoidResponse updateActionTargetStatus(String serverName, String urlMarker, 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 many 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
      urlMarker - view service URL marker
      requestBody - the action target and its new status
      Returns:
      void or InvalidParameterException the action target GUID is not recognized. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.

    • recordCompletionStatus

      public VoidResponse recordCompletionStatus(String serverName, String urlMarker, String engineActionGUID, 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
      urlMarker - view service URL marker
      engineActionGUID - unique identifier of the associated engine action
      requestBody - completion status, output guards, new action targets and completion message
      Returns:
      void or InvalidParameterException the completion status is null. UserNotAuthorizedException the user is not authorized to issue this request. PropertyServerException there was a problem detected by the metadata store.