org.odpi.openmetadata.accessservices.assetconsumer.client

Class AssetConsumer

java.lang.Object

org.odpi.openmetadata.accessservices.assetconsumer.client.AssetConsumer

All Implemented Interfaces:

AssetConsumerInterface

public class AssetConsumer
extends Object
implements AssetConsumerInterface

The AssetConsumer Open Metadata Access Service (OMAS) provides an interface to support an application or tool that is using Open Connector Framework (OCF) connectors to work with assets such as data stores, data sets and APIs. The interface is divided into three parts:

• Client-side only services that work with the OCF to create requested connectors.
• OMAS Server calls to retrieve connection information on behalf of the OCF.
• OMAS Server calls to add feedback to the asset.

Constructor Summary

Constructors

Constructor and Description
AssetConsumer(String newServerURL) Create a new AssetConsumer client.

Method Summary

Modifier and Type	Method and Description
String	addCommentReply(String userId, String commentGUID, CommentType commentType, String commentText) Adds a comment to the asset.
String	addCommentToAsset(String userId, String assetGUID, CommentType commentType, String commentText) Adds a comment to the asset.
String	addLikeToAsset(String userId, String assetGUID) Adds a "Like" to the asset.
void	addLogMessageToAsset(String userId, String assetGUID, String connectorInstanceId, String connectionName, String connectorType, String contextId, String message) Creates an Audit log record for the asset.
String	addPrivateTagToAsset(String userId, String assetGUID, String tagName, String tagDescription) Adds a new private tag to the asset's properties.
String	addRatingToAsset(String userId, String assetGUID, StarRating starRating, String review) Adds a rating to the asset.
String	addTagToAsset(String userId, String assetGUID, String tagName, String tagDescription) Adds a new public tag to the asset's properties.
AssetUniverse	getAssetProperties(String userId, String assetGUID) Returns a comprehensive collection of properties about the requested asset.
Connector	getConnectorByConnection(String userId, Connection connection) Returns the connector corresponding to the supplied connection.
Connector	getConnectorByGUID(String userId, String connectionGUID) Returns the connector corresponding to the supplied connection GUID.
Connector	getConnectorByName(String userId, String connectionName) Returns the connector corresponding to the supplied connection name.
void	removeComment(String userId, String commentGUID) Removes a comment added to the asset by this user.
void	removeLike(String userId, String likeGUID) Removes a "Like" added to the asset by this user.
void	removePrivateTag(String userId, String tagGUID) Removes a tag from the asset that was added by this user.
void	removeRating(String userId, String ratingGUID) Removes of a star rating that was added to the asset by this user.
void	removeTag(String userId, String tagGUID) Removes a tag from the asset that was added by this user.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetConsumer

public AssetConsumer(String newServerURL)

Create a new AssetConsumer client.

Parameters:

newServerURL - the network address of the server running the OMAS REST services

Method Detail

getConnectorByName

public Connector getConnectorByName(String userId,
                                    String connectionName)
                             throws InvalidParameterException,
                                    UnrecognizedConnectionNameException,
                                    AmbiguousConnectionNameException,
                                    ConnectionCheckedException,
                                    ConnectorCheckedException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Returns the connector corresponding to the supplied connection name.

Specified by:

getConnectorByName in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

connectionName - this may be the qualifiedName or displayName of the connection.

Returns:

Connector - connector instance.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UnrecognizedConnectionNameException - there is no connection defined for this name.

AmbiguousConnectionNameException - there is more than one connection defined for this name.

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.

PropertyServerException - there is a problem retrieving information from the property (metadata) server.

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

getConnectorByGUID

public Connector getConnectorByGUID(String userId,
                                    String connectionGUID)
                             throws InvalidParameterException,
                                    UnrecognizedConnectionGUIDException,
                                    ConnectionCheckedException,
                                    ConnectorCheckedException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Returns the connector corresponding to the supplied connection GUID.

Specified by:

getConnectorByGUID in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

connectionGUID - the unique id for the connection within the property server.

Returns:

Connector - connector instance.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UnrecognizedConnectionGUIDException - the supplied GUID is not recognized by the property server.

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.

PropertyServerException - there is a problem retrieving information from the property server.

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

getConnectorByConnection

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

Returns the connector corresponding to the supplied connection.

Specified by:

getConnectorByConnection in interface AssetConsumerInterface

Parameters:

userId - String userId of user making request. This userId is stored in the connector for

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

Returns:

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.

PropertyServerException - there is a problem retrieving information from the property (metadata) server.

getAssetProperties

public AssetUniverse getAssetProperties(String userId,
                                        String assetGUID)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        UserNotAuthorizedException

Returns a comprehensive collection of properties about the requested asset.

Specified by:

getAssetProperties in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

assetGUID - String - unique id for asset.

Returns:

AssetUniverse - a comprehensive collection of properties about the asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem retrieving the asset properties from the property server.

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

addLogMessageToAsset

public void addLogMessageToAsset(String userId,
                                 String assetGUID,
                                 String connectorInstanceId,
                                 String connectionName,
                                 String connectorType,
                                 String contextId,
                                 String message)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Creates an Audit log record for the asset. This log record is stored in the Asset's Audit Log.

Specified by:

addLogMessageToAsset in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

assetGUID - String - unique id for the asset.

connectorInstanceId - String - (optional) id of connector in use (if any).

connectionName - String - (optional) name of the connection (extracted from the connector).

connectorType - String - (optional) type of connector in use (if any).

contextId - String - (optional) function name, or processId of the activity that the caller is performing.

message - log record content.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem adding the asset properties to the property server.

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

addTagToAsset

public String addTagToAsset(String userId,
                            String assetGUID,
                            String tagName,
                            String tagDescription)
                     throws InvalidParameterException,
                            PropertyServerException,
                            UserNotAuthorizedException

Adds a new public tag to the asset's properties.

Specified by:

addTagToAsset in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

assetGUID - String - unique id for the asset.

tagName - String - name of the tag.

tagDescription - String - (optional) description of the tag. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic glossary term.

Returns:

String - GUID for new tag.

Throws:

InvalidParameterException - - one of the parameters is null or invalid.

PropertyServerException - - There is a problem adding the asset properties to the property server.

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

addPrivateTagToAsset

public String addPrivateTagToAsset(String userId,
                                   String assetGUID,
                                   String tagName,
                                   String tagDescription)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Adds a new private tag to the asset's properties.

Specified by:

addPrivateTagToAsset in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

assetGUID - String - unique id for the asset.

tagName - String - name of the tag.

tagDescription - String - (optional) description of the tag. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic glossary term.

Returns:

String - GUID for new tag.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem adding the asset properties to the property server.

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

addRatingToAsset

public String addRatingToAsset(String userId,
                               String assetGUID,
                               StarRating starRating,
                               String review)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Adds a rating to the asset.

Specified by:

addRatingToAsset in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

assetGUID - String - unique id for the asset.

starRating - StarRating - enumeration for none, one to five stars.

review - String - user review of asset.

Returns:

guid of new rating object.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem adding the asset properties to the property server.

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

addLikeToAsset

public String addLikeToAsset(String userId,
                             String assetGUID)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Adds a "Like" to the asset.

Specified by:

addLikeToAsset in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

assetGUID - String - unique id for the asset

Returns:

guid of new like object.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem adding the asset properties to the property server.

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

addCommentToAsset

public String addCommentToAsset(String userId,
                                String assetGUID,
                                CommentType commentType,
                                String commentText)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Adds a comment to the asset.

Specified by:

addCommentToAsset in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

assetGUID - String - unique id for the asset.

commentType - type of comment enum.

commentText - String - the text of the comment.

Returns:

guid of new comment.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem adding the asset properties to the property server.

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

addCommentReply

public String addCommentReply(String userId,
                              String commentGUID,
                              CommentType commentType,
                              String commentText)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Adds a comment to the asset.

Specified by:

addCommentReply in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

commentGUID - String - unique id for an existing comment. Used to add a reply to a comment.

commentType - type of comment enum.

commentText - String - the text of the comment.

Returns:

guid of new comment.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem adding the asset properties to the property server.

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

removeTag

public void removeTag(String userId,
                      String tagGUID)
               throws InvalidParameterException,
                      PropertyServerException,
                      UserNotAuthorizedException

Removes a tag from the asset that was added by this user.

Specified by:

removeTag in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

tagGUID - String - unique id for the tag.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem updating the asset properties in the property server.

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

removePrivateTag

public void removePrivateTag(String userId,
                             String tagGUID)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Removes a tag from the asset that was added by this user.

Specified by:

removePrivateTag in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

tagGUID - String - unique id for the tag.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem updating the asset properties in the property server.

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

removeRating

public void removeRating(String userId,
                         String ratingGUID)
                  throws InvalidParameterException,
                         PropertyServerException,
                         UserNotAuthorizedException

Removes of a star rating that was added to the asset by this user.

Specified by:

removeRating in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

ratingGUID - String - unique id for the rating object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem updating the asset properties in the property server.

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

removeLike

public void removeLike(String userId,
                       String likeGUID)
                throws InvalidParameterException,
                       PropertyServerException,
                       UserNotAuthorizedException

Removes a "Like" added to the asset by this user.

Specified by:

removeLike in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

likeGUID - String - unique id for the like object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem updating the asset properties in the property server.

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

removeComment

public void removeComment(String userId,
                          String commentGUID)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException

Removes a comment added to the asset by this user.

Specified by:

removeComment in interface AssetConsumerInterface

Parameters:

userId - String - userId of user making request.

commentGUID - String - unique id for the comment object.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - There is a problem updating the asset properties in the property server.

UserNotAuthorizedException - the user does not have permission to perform this request.