org.odpi.openmetadata.accessservices.discoveryengine.client

Class DiscoveryEngineClient

java.lang.Object

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryEngineClient

public class DiscoveryEngineClient
extends ConnectedAssetClientBase

DiscoveryEngineClient provides the client-side operational REST APIs for a running Discovery Engine

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

invalidParameterHandler, nullRequestBody, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor and Description
DiscoveryEngineClient(String serverName, String serverPlatformRootURL, ODFRESTClient restClient) Constructor sets up the key parameters for accessing the asset store.

Method Summary

Modifier and Type	Method and Description
DiscoveryAnalysisReport	createDiscoveryAnalysisReport(String userId, String qualifiedName, String displayName, String description, Date creationDate, Map<String,String> analysisParameters, DiscoveryRequestStatus discoveryRequestStatus, String assetGUID, String discoveryEngineGUID, String discoveryServiceGUID, Map<String,String> additionalProperties, List<Classification> classifications) Create a new discovery analysis report and chain it to its asset, discovery engine and discovery service.
Annotation	getAnnotation(String userId, String discoveryReportGUID, String annotationGUID) Retrieve a single annotation by unique identifier.
Connector	getConnectorForConnection(String userId, Connection connection) Returns the connector corresponding to the supplied connection.
DiscoveryAnalysisReport	getDiscoveryAnalysisReport(String userId, String discoveryReportGUID) Request the discovery report for a discovery request that has completed.
List<Annotation>	getDiscoveryReportAnnotations(String userId, String discoveryReportGUID, int startingFrom, int maximumResults) Return the annotations linked directly to the report.
DiscoveryRequestStatus	getDiscoveryStatus(String userId, String discoveryReportGUID) Request the status of an executing discovery request.
List<Annotation>	getExtendedAnnotations(String userId, String discoveryReportGUID, String annotationGUID, int startingFrom, int maximumResults) Return any annotations attached to this annotation.
void	logAssetAuditMessage(String userId, String assetGUID, String message) Log an audit message about this asset.
void	setDiscoveryStatus(String userId, String discoveryReportGUID, DiscoveryRequestStatus newStatus) Request the status of an executing discovery request.
DiscoveryAnalysisReport	updateDiscoveryAnalysisReport(String userId, DiscoveryAnalysisReport updatedReport) Update the properties of the discovery analysis report.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

getAssetForConnection, getAssetProperties, getAssetSummary, getConnectionByGUID, getConnectionForAsset, getConnectorForConnection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiscoveryEngineClient

public DiscoveryEngineClient(String serverName,
                             String serverPlatformRootURL,
                             ODFRESTClient restClient)
                      throws InvalidParameterException

Constructor sets up the key parameters for accessing the asset store.

Parameters:

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the OMAS REST servers

restClient - client for calling REST APIs

Throws:

InvalidParameterException - unable to initialize the client due to bad parameters

Method Detail

getConnectorForConnection

public Connector getConnectorForConnection(String userId,
                                           Connection connection)
                                    throws InvalidParameterException,
                                           ConnectionCheckedException,
                                           ConnectorCheckedException

Returns the connector corresponding to the supplied connection.

Parameters:

userId - userId of user making request.

connection - the connection object that contains the properties needed to create the connection.

Returns:

Connector connector instance

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

logAssetAuditMessage

public void logAssetAuditMessage(String userId,
                                 String assetGUID,
                                 String message)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Log an audit message about this asset.

Parameters:

userId - userId of user making request.

assetGUID - unique identifier for asset.

message - message to log

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving the asset properties from the property servers).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createDiscoveryAnalysisReport

public DiscoveryAnalysisReport createDiscoveryAnalysisReport(String userId,
                                                             String qualifiedName,
                                                             String displayName,
                                                             String description,
                                                             Date creationDate,
                                                             Map<String,String> analysisParameters,
                                                             DiscoveryRequestStatus discoveryRequestStatus,
                                                             String assetGUID,
                                                             String discoveryEngineGUID,
                                                             String discoveryServiceGUID,
                                                             Map<String,String> additionalProperties,
                                                             List<Classification> classifications)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException

Create a new discovery analysis report and chain it to its asset, discovery engine and discovery service.

Parameters:

userId - calling user

qualifiedName - unique name for the report

displayName - short name for the report

description - description of the report

creationDate - date of the report

analysisParameters - analysis parameters passed to the discovery service

discoveryRequestStatus - current status of the discovery processing

assetGUID - unique identifier of the asset being analysed

discoveryEngineGUID - unique identifier of the discovery engine that is running the discovery service

discoveryServiceGUID - unique identifier of the discovery service creating the report

additionalProperties - additional properties for the report

classifications - classifications to attach to the report

Returns:

The new discovery report.

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to access the asset and/or report

PropertyServerException - there was a problem in the store whether the asset/report properties are kept.

updateDiscoveryAnalysisReport

public DiscoveryAnalysisReport updateDiscoveryAnalysisReport(String userId,
                                                             DiscoveryAnalysisReport updatedReport)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException

Update the properties of the discovery analysis report.

Parameters:

userId - calling user.

updatedReport - updated report - this will replace what was previous stored.

Returns:

the new values stored in the repository

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getDiscoveryStatus

public DiscoveryRequestStatus getDiscoveryStatus(String userId,
                                                 String discoveryReportGUID)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Request the status of an executing discovery request.

Parameters:

userId - identifier of calling user

discoveryReportGUID - identifier of the discovery request.

Returns:

status enum

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

setDiscoveryStatus

public void setDiscoveryStatus(String userId,
                               String discoveryReportGUID,
                               DiscoveryRequestStatus newStatus)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Request the status of an executing discovery request.

Parameters:

userId - identifier of calling user

discoveryReportGUID - identifier of the discovery request.

newStatus - status enum

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getDiscoveryAnalysisReport

public DiscoveryAnalysisReport getDiscoveryAnalysisReport(String userId,
                                                          String discoveryReportGUID)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Request the discovery report for a discovery request that has completed.

Parameters:

userId - identifier of calling user

discoveryReportGUID - identifier of the discovery report.

Returns:

discovery report

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getDiscoveryReportAnnotations

public List<Annotation> getDiscoveryReportAnnotations(String userId,
                                                      String discoveryReportGUID,
                                                      int startingFrom,
                                                      int maximumResults)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Return the annotations linked directly to the report.

Parameters:

userId - identifier of calling user

discoveryReportGUID - 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.

PropertyServerException - there was a problem that occurred within the property server.

getExtendedAnnotations

public List<Annotation> getExtendedAnnotations(String userId,
                                               String discoveryReportGUID,
                                               String annotationGUID,
                                               int startingFrom,
                                               int maximumResults)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Return any annotations attached to this annotation.

Parameters:

userId - identifier of calling user

discoveryReportGUID - identifier of the discovery report.

annotationGUID - anchor annotation

startingFrom - starting position in the list

maximumResults - maximum number of annotations that can be returned.

Returns:

list of Annotation objects

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getAnnotation

public Annotation getAnnotation(String userId,
                                String discoveryReportGUID,
                                String annotationGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Retrieve a single annotation by unique identifier. This call is typically used to retrieve the latest values for an annotation.

Parameters:

userId - identifier of calling user

discoveryReportGUID - identifier of the discovery report.

annotationGUID - unique identifier of the annotation

Returns:

Annotation object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.