Class DiscoveryEngine

  • Direct Known Subclasses:
    AssetAnalysisClient

    public abstract class DiscoveryEngine
    extends java.lang.Object
    DiscoveryEngine provides the interface for a discovery engine. The discovery engine runs inside a discovery server. The discovery server provides the server runtime environment for the discovery engine along with the interfaces for configuring the discovery engine.
    • Constructor Summary

      Constructors 
      Constructor Description
      DiscoveryEngine()  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract java.lang.String discoverAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String assetDiscoveryType)
      Request the execution of a discovery service to explore a specific asset.
      abstract java.lang.String discoverAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String assetDiscoveryType, java.util.Map<java.lang.String,​java.lang.String> analysisParameters)
      Request the execution of a discovery service to explore a specific asset.
      abstract java.lang.String discoverAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String assetDiscoveryType, java.util.Map<java.lang.String,​java.lang.String> analysisParameters, java.util.List<java.lang.String> annotationTypes)
      Request the execution of a discovery service to explore a specific asset.
      abstract Annotation getAnnotation​(java.lang.String userId, java.lang.String annotationGUID)
      Retrieve a single annotation by unique identifier.
      abstract DiscoveryAnalysisReport getDiscoveryReport​(java.lang.String userId, java.lang.String discoveryRequestGUID)
      Request the discovery report for a discovery request that has completed.
      abstract java.util.List<Annotation> getDiscoveryReportAnnotations​(java.lang.String userId, java.lang.String discoveryRequestGUID, int startingFrom, int maximumResults)
      Return the annotations linked direction to the report.
      abstract DiscoveryRequestStatus getDiscoveryStatus​(java.lang.String userId, java.lang.String discoveryRequestGUID)
      Request the status of an executing discovery request.
      abstract java.util.List<Annotation> getExtendedAnnotations​(java.lang.String userId, java.lang.String annotationGUID, int startingFrom, int maximumResults)
      Return any annotations attached to this annotation.
      abstract void scanAllAssets​(java.lang.String userId, java.lang.String assetDiscoveryType, java.util.Map<java.lang.String,​java.lang.String> analysisParameters, java.util.List<java.lang.String> annotationTypes)
      Explore each of the assets in the asset store.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DiscoveryEngine

        public DiscoveryEngine()
    • Method Detail

      • discoverAsset

        public abstract java.lang.String discoverAsset​(java.lang.String userId,
                                                       java.lang.String assetGUID,
                                                       java.lang.String assetDiscoveryType)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       DiscoveryEngineException
        Request the execution of a discovery service to explore a specific asset.
        Parameters:
        userId - identifier of calling user
        assetGUID - identifier of the asset to analyze.
        assetDiscoveryType - identifier of the type of analysis - this determines which discovery service to run.
        Returns:
        unique id for the discovery request.
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        UserNotAuthorizedException - user not authorized to issue this request.
        DiscoveryEngineException - there was a problem detected by the discovery engine.
      • discoverAsset

        public abstract java.lang.String discoverAsset​(java.lang.String userId,
                                                       java.lang.String assetGUID,
                                                       java.lang.String assetDiscoveryType,
                                                       java.util.Map<java.lang.String,​java.lang.String> analysisParameters)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       DiscoveryEngineException
        Request the execution of a discovery service to explore a specific asset.
        Parameters:
        userId - identifier of calling user
        assetGUID - identifier of the asset to analyze.
        assetDiscoveryType - identifier of the type of analysis - this determines which discovery service to run.
        analysisParameters - name value properties to control the analysis
        Returns:
        unique id for the discovery request.
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        UserNotAuthorizedException - user not authorized to issue this request.
        DiscoveryEngineException - there was a problem detected by the discovery engine.
      • discoverAsset

        public abstract java.lang.String discoverAsset​(java.lang.String userId,
                                                       java.lang.String assetGUID,
                                                       java.lang.String assetDiscoveryType,
                                                       java.util.Map<java.lang.String,​java.lang.String> analysisParameters,
                                                       java.util.List<java.lang.String> annotationTypes)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       DiscoveryEngineException
        Request the execution of a discovery service to explore a specific asset.
        Parameters:
        userId - identifier of calling user
        assetGUID - identifier of the asset to analyze.
        assetDiscoveryType - identifier of the type of analysis - this determines which discovery service to run.
        analysisParameters - name value properties to control the analysis
        annotationTypes - list of the types of annotations to produce (and no others)
        Returns:
        unique id for the discovery request.
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        UserNotAuthorizedException - user not authorized to issue this request.
        DiscoveryEngineException - there was a problem detected by the discovery engine.
      • scanAllAssets

        public abstract void scanAllAssets​(java.lang.String userId,
                                           java.lang.String assetDiscoveryType,
                                           java.util.Map<java.lang.String,​java.lang.String> analysisParameters,
                                           java.util.List<java.lang.String> annotationTypes)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           DiscoveryEngineException
        Explore each of the assets in the asset store. A new instance of the discovery service is started for each retrieved asset.
        Parameters:
        userId - identifier of calling user
        assetDiscoveryType - identifier of the type of analysis - this determines which discovery service to run.
        analysisParameters - name value properties to control the analysis
        annotationTypes - list of the types of annotations to produce (and no others)
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        UserNotAuthorizedException - user not authorized to issue this request.
        DiscoveryEngineException - there was a problem detected by the discovery engine.
      • getDiscoveryReportAnnotations

        public abstract java.util.List<Annotation> getDiscoveryReportAnnotations​(java.lang.String userId,
                                                                                 java.lang.String discoveryRequestGUID,
                                                                                 int startingFrom,
                                                                                 int maximumResults)
                                                                          throws InvalidParameterException,
                                                                                 UserNotAuthorizedException,
                                                                                 DiscoveryEngineException
        Return the annotations linked direction to the report.
        Parameters:
        userId - identifier of 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
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        UserNotAuthorizedException - user not authorized to issue this request.
        DiscoveryEngineException - there was a problem detected by the discovery engine.