Package org.odpi.openmetadata.engineservices.assetanalysis.server

Class AssetAnalysisRESTServices

java.lang.Object
org.odpi.openmetadata.engineservices.assetanalysis.server.AssetAnalysisRESTServices
public class AssetAnalysisRESTServices extends Object
AssetAnalysisRESTServices provides the external service implementation for a discovery engine. Each method contains the engine host server name and the discovery engine identifier (guid). The AssetAnalysisRESTServices locates the correct discovery engine instance within the correct engine host server instance and delegates the request.

  • Constructor Details

    • AssetAnalysisRESTServices

      public AssetAnalysisRESTServices()

  • Method Details

    • validateConnector

      public ConnectorReportResponse validateConnector(String serverName, String userId, String connectorProviderClassName)
      Validate the connector and return its connector type.
      Parameters:
      serverName - integration daemon server name
      userId - calling user
      connectorProviderClassName - name of a specific connector or null for all connectors
      Returns:
      connector type or InvalidParameterException the connector provider class name is not a valid connector fo this service UserNotAuthorizedException user not authorized to issue this request PropertyServerException there was a problem detected by the integration service

    • discoverAsset

      public GUIDResponse discoverAsset(String serverName, String discoveryEngineName, String userId, String assetGUID, String discoveryRequestType, DiscoveryRequestRequestBody requestBody)
      Request the execution of a discovery service to explore a specific asset.
      Parameters:
      serverName - name of the engine host server.
      discoveryEngineName - unique name of the discovery engine.
      userId - identifier of calling user
      assetGUID - identifier of the asset to analyze.
      discoveryRequestType - identifier of the type of asset to analyze - this determines which discovery service to run.
      requestBody - containing analysisParameters and annotationTypes
      Returns:
      unique id for the discovery request or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or DiscoveryEngineException there was a problem detected by the discovery engine.

    • scanAllAssets

      public VoidResponse scanAllAssets(String serverName, String discoveryEngineName, String userId, String discoveryRequestType, DiscoveryRequestRequestBody requestBody)
      Request the execution of a discovery service to explore a specific asset.
      Parameters:
      serverName - name of the engine host server.
      discoveryEngineName - unique name of the discovery engine.
      userId - identifier of calling user
      discoveryRequestType - identifier of the type of asset to analyze - this determines which discovery service to run.
      requestBody - containing analysisParameters and annotationTypes
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or DiscoveryEngineException there was a problem detected by the discovery engine.

    • getDiscoveryAnalysisReport

      public DiscoveryAnalysisReportResponse getDiscoveryAnalysisReport(String serverName, String discoveryEngineName, String userId, String discoveryRequestGUID)
      Request the discovery report for a discovery request that has completed.
      Parameters:
      serverName - name of the engine host server.
      discoveryEngineName - unique name of the discovery engine.
      userId - calling user
      discoveryRequestGUID - identifier of the discovery request.
      Returns:
      discovery report or DiscoveryEngineException there was a problem detected by the discovery engine.

    • getDiscoveryReportAnnotations

      public AnnotationListResponse getDiscoveryReportAnnotations(String serverName, String discoveryEngineName, String userId, String discoveryRequestGUID, int startingFrom, int maximumResults)
      Return the annotations linked direction to the report.
      Parameters:
      serverName - name of the engine host server.
      discoveryEngineName - unique name of the discovery engine.
      userId - calling user
      discoveryRequestGUID - identifier of the discovery request.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of annotations or DiscoveryEngineException there was a problem detected by the discovery engine.

    • getExtendedAnnotations

      public AnnotationListResponse getExtendedAnnotations(String serverName, String discoveryEngineName, String userId, String annotationGUID, int startingFrom, int maximumResults)
      Return any annotations attached to this annotation.
      Parameters:
      serverName - name of the engine host server.
      discoveryEngineName - unique name of the discovery engine.
      userId - calling user
      annotationGUID - anchor annotation
      startingFrom - starting position in the list
      maximumResults - maximum number of annotations that can be returned.
      Returns:
      list of Annotation objects or DiscoveryEngineException there was a problem detected by the discovery engine.

    • getAnnotation

      public AnnotationResponse getAnnotation(String serverName, String discoveryEngineName, String userId, String annotationGUID)
      Retrieve a single annotation by unique identifier. This call is typically used to retrieve the latest values for an annotation.
      Parameters:
      serverName - name of the engine host server.
      discoveryEngineName - unique name of the discovery engine.
      userId - calling user
      annotationGUID - unique identifier of the annotation
      Returns:
      Annotation object or DiscoveryEngineException there was a problem detected by the discovery engine.