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, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody 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
      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)

    • getTechnologyTypesForOpenMetadataType

      public TechnologyTypeSummaryListResponse getTechnologyTypesForOpenMetadataType(String serverName, String typeName, int startFrom, int pageSize, 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
      typeName - the type name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      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 there is a problem reported in the open metadata server(s)

    • getTechnologyTypeDetail

      public TechnologyTypeReportResponse getTechnologyTypeDetail(String serverName, FilterRequestBody requestBody)
      Retrieve the requested deployed implementation type metadata element.
      Parameters:
      serverName - name of the service to route the request to
      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)

    • getTechnologyTypeHierarchy

      public TechnologyTypeHierarchyResponse getTechnologyTypeHierarchy(String serverName, 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
      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)

    • getTechnologyTypeElements

      public TechnologyTypeElementListResponse getTechnologyTypeElements(String serverName, int startFrom, int pageSize, boolean getTemplates, 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      getTemplates - boolean indicating whether templates or non-template elements should 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)

    • createElementFromTemplate

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

    • getElementFromTemplate

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

    • addCatalogTarget

      public GUIDResponse addCatalogTarget(String serverName, String integrationConnectorGUID, String metadataElementGUID, CatalogTargetProperties requestBody)
      Add a catalog target to an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      integrationConnectorGUID - unique identifier of the integration service.
      metadataElementGUID - unique identifier of the metadata element that is a catalog target.
      requestBody - properties for the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • updateCatalogTarget

      public VoidResponse updateCatalogTarget(String serverName, String relationshipGUID, CatalogTargetProperties requestBody)
      Update a catalog target for an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      relationshipGUID - unique identifier of the relationship.
      requestBody - properties for the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • getCatalogTarget

      public CatalogTargetResponse getCatalogTarget(String serverName, String relationshipGUID)
      Retrieve a specific catalog target associated with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      relationshipGUID - unique identifier of the relationship.
      Returns:
      details of the governance service and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • getCatalogTargets

      public CatalogTargetsResponse getCatalogTargets(String serverName, String integrationConnectorGUID, int startFrom, int pageSize)
      Retrieve the details of the metadata elements identified as catalog targets with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      integrationConnectorGUID - unique identifier of the integration connector.
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • removeCatalogTarget

      public VoidResponse removeCatalogTarget(String serverName, String relationshipGUID, NullRequestBody requestBody)
      Unregister a catalog target from the integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      relationshipGUID - unique identifier of the integration connector.
      requestBody - null request body.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • findGovernanceActionTypes

      public GovernanceActionTypesResponse findGovernanceActionTypes(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of governance action type metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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

      public GovernanceActionTypesResponse getGovernanceActionTypesByName(String serverName, int startFrom, int pageSize, FilterRequestBody 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
      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

      public GovernanceActionTypeResponse getGovernanceActionTypeByGUID(String serverName, String governanceActionTypeGUID)
      Retrieve the governance action type metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to
      governanceActionTypeGUID - 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)

    • findGovernanceActionProcesses

      public GovernanceActionProcessElementsResponse findGovernanceActionProcesses(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of governance action process metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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

      public GovernanceActionProcessElementsResponse getGovernanceActionProcessesByName(String serverName, int startFrom, int pageSize, FilterRequestBody 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
      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

      public GovernanceActionProcessElementResponse getGovernanceActionProcessByGUID(String serverName, 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
      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)

    • getGovernanceActionProcessGraph

      public GovernanceActionProcessGraphResponse getGovernanceActionProcessGraph(String serverName, String processGUID, ResultsRequestBody requestBody)
      Retrieve the governance action process metadata element with the supplied unique identifier along with the flow definition describing its implementation.
      Parameters:
      serverName - name of the service to route the request to
      processGUID - unique identifier of the requested metadata element
      requestBody - effectiveTime
      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)

    • getEngineAction

      public EngineActionElementResponse getEngineAction(String serverName, String engineActionGUID)
      Request the status and properties of an executing engine action request.
      Parameters:
      serverName - name of server instance to route request to
      engineActionGUID - identifier of the engine action request.
      Returns:
      engine 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.

    • cancelEngineAction

      public VoidResponse cancelEngineAction(String serverName, String engineActionGUID)
      Request that an engine action is stopped.
      Parameters:
      serverName - name of server instance to route request to
      engineActionGUID - identifier of the engine action request.
      Returns:
      engine 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.

    • getEngineActions

      public EngineActionElementsResponse getEngineActions(String serverName, int startFrom, int pageSize)
      Retrieve the engine actions that are known to the server.
      Parameters:
      serverName - name of server instance to route request to
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of engine 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.

    • getActiveEngineActions

      public EngineActionElementsResponse getActiveEngineActions(String serverName, int startFrom, int pageSize)
      Retrieve the engine actions that are still in process.
      Parameters:
      serverName - name of server instance to route request to
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of engine 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.

    • findEngineActions

      public EngineActionElementsResponse findEngineActions(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of engine action metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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)

    • getEngineActionsByName

      public EngineActionElementsResponse getEngineActionsByName(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of engine 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 to
      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)

    • initiateEngineAction

      public GUIDResponse initiateEngineAction(String serverName, 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
      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

    • initiateGovernanceActionType

      public GUIDResponse initiateGovernanceActionType(String serverName, 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
      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 there is a problem with the metadata store

    • initiateGovernanceActionProcess

      public GUIDResponse initiateGovernanceActionProcess(String serverName, 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
      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 there is a problem with the metadata store

    • addExternalIdentifier

      public VoidResponse addExternalIdentifier(String serverName, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, UpdateMetadataCorrelatorsRequestBody requestBody)
      Add the description of a specific external identifier.
      Parameters:
      serverName - name of the service to route the request to.
      openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • updateExternalIdentifier

      public VoidResponse updateExternalIdentifier(String serverName, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, UpdateMetadataCorrelatorsRequestBody requestBody)
      Update the description of a specific external identifier.
      Parameters:
      serverName - name of the service to route the request to.
      openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • validateExternalIdentifier

      public BooleanResponse validateExternalIdentifier(String serverName, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, UpdateMetadataCorrelatorsRequestBody requestBody)
      That the external identifier matches the open metadata GUID.
      Parameters:
      serverName - name of the service to route the request to.
      openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • removeExternalIdentifier

      public VoidResponse removeExternalIdentifier(String serverName, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, UpdateMetadataCorrelatorsRequestBody requestBody)
      Remove an external identifier from an existing open metadata element. The open metadata element is not affected.
      Parameters:
      serverName - name of the service to route the request to.
      openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • removeExternalScope

      public VoidResponse removeExternalScope(String serverName, String externalScopeGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeRequestBody requestBody)
      Remove the scope associated with a collection of external identifiers. All associated external identifiers are removed too. The linked open metadata elements are not affected.
      Parameters:
      serverName - name of the service to route the request to.
      externalScopeGUID - unique identifier (GUID) of the scope element in the open metadata ecosystem
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • confirmSynchronization

      public VoidResponse confirmSynchronization(String serverName, String openMetadataElementGUID, String openMetadataElementTypeName, MetadataCorrelationProperties requestBody)
      Confirm that the values of a particular metadata element have been synchronized. This is important from an audit point of view, and to allow bidirectional updates of metadata using optimistic locking.
      Parameters:
      serverName - name of the service to route the request to.
      openMetadataElementGUID - unique identifier (GUID) of this element in open metadata
      openMetadataElementTypeName - type name for the open metadata element
      requestBody - details of the external identifier and its scope
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • getExternalIdentifiers

      public MetadataCorrelationHeadersResponse getExternalIdentifiers(String serverName, String openMetadataElementGUID, String openMetadataElementTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the external identifiers for a particular metadata element.
      Parameters:
      serverName - name of the service to route the request to.
      openMetadataElementGUID - unique identifier (GUID) of this element in open metadata
      openMetadataElementTypeName - type name for the open metadata element
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - details of the external identifier and its scope
      Returns:
      list of correlation header elements, null if null or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • getElementsForExternalIdentifier

      public ElementHeadersResponse getElementsForExternalIdentifier(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, UpdateMetadataCorrelatorsRequestBody requestBody)
      Retrieve the unique identifier of the external asset manager from its qualified name. Typically, the qualified name comes from the integration connector configuration.
      Parameters:
      serverName - name of the service to route the request to.
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - details of the external identifier
      Returns:
      list of linked elements, null if null or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server