org.odpi.openmetadata.accessservices.assetconsumer

Interface AssetConsumerInterface

All Known Implementing Classes:

AssetConsumer

public interface AssetConsumerInterface

The AssetConsumer Open Metadata Access Service (OMAS) is used by applications and tools as a factory for Open Connector Framework (OCF) connectors. The configuration for the connectors is managed as open metadata in a Connection definition. The caller to the AssetConsumer OMAS passes either the name, GUID or URL for the connection to the appropriate method to retrieve a connector. The AssetConsumer OMAS retrieves the connection from the metadata repository and creates an appropriate connector as described the connection and returns it to the caller. Each connection has a unique guid and a name. An application can request a connector instance from the OCF's Connector Broker using the guid, name or URL of a connection, or by passing a fully populated connection object. If the connection guid, name or URL is used, AssetConsumer OMAS looks up the connection properties in the metadata repository before calling the OCF ConnectorBroker to create the connector In addition it is possible to maintain feedback for the asset through the AssetConsumer OMAS. This is in terms of tags, star ratings, likes and comments. There is also the ability to add audit log records related to the use of the asset through the AssetConsumerInterface OMAS.

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.

Method Detail

getConnectorByName

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

Returns the connector corresponding to the supplied connection name.

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

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

Returns the connector corresponding to the supplied connection GUID.

Parameters:

userId - String userId of user making request.

connectionGUID - the unique id for the connection within the metadata repository.

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 (metadata) server.

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

getConnectorByConnection

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

Returns the connector corresponding to the supplied connection.

Parameters:

userId - String 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.

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

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

getAssetProperties

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

Returns a comprehensive collection of properties about the requested asset.

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

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.

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

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

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

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

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

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

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

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

Adds a rating to the asset.

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

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

Adds a "Like" to the asset.

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

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

Adds a comment to the asset.

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

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

Adds a comment to the asset.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Removes a comment added to the asset by this user.

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.