org.odpi.openmetadata.accessservices.assetconsumer

Interface AssetConsumerInterface

All Known Implementing Classes:

AssetConsumer

public interface AssetConsumerInterface

The Asset Consumer 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 Asset Consumer OMAS passes either the name, GUID or URL for the connection to the appropriate method to retrieve a connector. The Asset Consumer 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. The Asset Consumer OMAS supports access to the asset properties either through the connector, or by a direct call to Asset Consumer API. It also supports the management of Asset Collections. In addition it is possible to maintain feedback for the asset through the Asset Consumer OMAS. This is in terms of tags, star ratings, likes and comments. Finally, there is the ability to add audit log records related to the use of the asset through the Asset Consumer 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.
void	addToMyAssets(String userId, String assetCollectionGUID, String assetGUID) Add an asset to the identified user's list of favorite assets.
AssetCollection	attachAssetCollection(String userId, String assetCollectionGUID) Connect an existing asset collection to this user's profile.
AssetCollection	createAssetCollection(String userId, String qualifiedName, String displayName, String description, String collectionUse, AssetCollectionOrder assetCollectionOrder, Map<String,Object> additionalProperties) Create a new asset collection.
AssetCollection	getAssetCollection(String userId, String assetCollectionGUID) Return the properties of a specific asset collection,
String	getAssetForConnection(String userId, String connectionGUID) Returns the unique identifier for the asset connected to the connection.
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.
List<AssetCollection>	getMyAssetCollections(String userId, int startFrom, int pageSize) Returns the list of asset collections that this user has created or linked to their profile.
List<AssetCollectionMember>	getMyAssets(String userId, String assetCollectionGUID, int startFrom, int pageSize) Return a list of assets that the specified user has added to their favorites list.
MyProfile	getMyProfile(String userId) Return the profile for this user.
void	removeAssetCollection(String userId, String assetCollectionGUID) Delete an asset collection (the assets are not affected).
void	removeComment(String userId, String commentGUID) Removes a comment added to the asset by this user.
void	removeFromMyAssets(String userId, String assetCollectionGUID, String assetGUID) Remove an asset from identified user's list of favorite assets.
void	removeLike(String userId, String likeGUID) Removes a "Like" added to the asset by this user.
void	removePrivateTag(String userId, String tagGUID) Removes a private 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.
void	updateMyProfile(String userId, String employeeNumber, String fullName, String knownName, String jobTitle, String jobRoleDescription, Map<String,Object> additionalProperties) Create or update the profile for the requesting 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 - 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 server(s).

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

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

getConnectorByConnection

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

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.

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

getMyProfile

MyProfile getMyProfile(String userId)
                throws InvalidParameterException,
                       NoProfileForUserException,
                       PropertyServerException,
                       UserNotAuthorizedException

Return the profile for this user.

Parameters:

userId - userId of the user making the request.

Returns:

profile object

Throws:

InvalidParameterException - the userId is null or invalid.

NoProfileForUserException - the user does not have a profile.

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

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

updateMyProfile

void updateMyProfile(String userId,
                     String employeeNumber,
                     String fullName,
                     String knownName,
                     String jobTitle,
                     String jobRoleDescription,
                     Map<String,Object> additionalProperties)
              throws InvalidParameterException,
                     PropertyServerException,
                     UserNotAuthorizedException

Create or update the profile for the requesting user.

Parameters:

userId - the name of the calling user.

employeeNumber - personnel/serial/unique employee number of the individual.

fullName - full name of the person.

knownName - known name or nickname of the individual.

jobTitle - job title of the individual.

jobRoleDescription - job description of the individual.

additionalProperties - additional properties about the individual.

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

getMyAssetCollections

List<AssetCollection> getMyAssetCollections(String userId,
                                            int startFrom,
                                            int pageSize)
                                     throws InvalidParameterException,
                                            NoProfileForUserException,
                                            PropertyServerException,
                                            UserNotAuthorizedException

Returns the list of asset collections that this user has created or linked to their profile.

Parameters:

userId - userId of user making request

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return

Returns:

a list of asset collections

Throws:

InvalidParameterException - one of the parameters is null or invalid.

NoProfileForUserException - the user does not have a profile so can not have any asset collections.

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

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

getAssetCollection

AssetCollection getAssetCollection(String userId,
                                   String assetCollectionGUID)
                            throws InvalidParameterException,
                                   NoProfileForUserException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Return the properties of a specific asset collection,

Parameters:

userId - userId of user making request.

assetCollectionGUID - unique identifier of the required connection.

Returns:

asset collection properties

Throws:

InvalidParameterException - one of the parameters is null or invalid.

NoProfileForUserException - the user does not have a profile so can not have any asset collections.

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

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

createAssetCollection

AssetCollection createAssetCollection(String userId,
                                      String qualifiedName,
                                      String displayName,
                                      String description,
                                      String collectionUse,
                                      AssetCollectionOrder assetCollectionOrder,
                                      Map<String,Object> additionalProperties)
                               throws InvalidParameterException,
                                      NoProfileForUserException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Create a new asset collection.

Parameters:

userId - userId of user making request.

qualifiedName - unique name of the asset collection.

displayName - short displayable name for the asset collection.

description - description of the asset collection.

collectionUse - description of how the asset consumer intends to use the collection.

assetCollectionOrder - description of how the assets in the collection should be organized (null for no organization).

additionalProperties - additional arbitrary properties.

Returns:

the newly created AssetCollection

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile so can not have any asset collections.

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

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

attachAssetCollection

AssetCollection attachAssetCollection(String userId,
                                      String assetCollectionGUID)
                               throws InvalidParameterException,
                                      NoProfileForUserException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Connect an existing asset collection to this user's profile.

Parameters:

userId - userId of user making request.

assetCollectionGUID - unique identifier of the asset collection.

Returns:

details of the identified asset collection

Throws:

InvalidParameterException - one of the parameters is null or invalid.

NoProfileForUserException - the user does not have a profile so can not have any asset collections.

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

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

removeAssetCollection

void removeAssetCollection(String userId,
                           String assetCollectionGUID)
                    throws InvalidParameterException,
                           PropertyServerException,
                           NoProfileForUserException,
                           UserNotAuthorizedException

Delete an asset collection (the assets are not affected).

Parameters:

userId - userId of user making request.

assetCollectionGUID - unique identifier of the asset collection.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

NoProfileForUserException - the user does not have a profile so can not have any asset collections.

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

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

getMyAssets

List<AssetCollectionMember> getMyAssets(String userId,
                                        String assetCollectionGUID,
                                        int startFrom,
                                        int pageSize)
                                 throws InvalidParameterException,
                                        NoProfileForUserException,
                                        PropertyServerException,
                                        UserNotAuthorizedException

Return a list of assets that the specified user has added to their favorites list.

Parameters:

userId - userId of user making request.

assetCollectionGUID - unique identifier of the asset collection to use.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of asset details

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile so can not have any asset collections.

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

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

addToMyAssets

void addToMyAssets(String userId,
                   String assetCollectionGUID,
                   String assetGUID)
            throws InvalidParameterException,
                   NoProfileForUserException,
                   NotAnAssetException,
                   PropertyServerException,
                   UserNotAuthorizedException

Add an asset to the identified user's list of favorite assets.

Parameters:

userId - userId of user making request.

assetCollectionGUID - unique identifier of the asset collection to use.

assetGUID - unique identifier of the asset.

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile so can not have any asset collections.

NotAnAssetException - the guid is not recognized as an identifier for an asset.

PropertyServerException - there is a problem updating information in the property server(s).

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

removeFromMyAssets

void removeFromMyAssets(String userId,
                        String assetCollectionGUID,
                        String assetGUID)
                 throws InvalidParameterException,
                        NoProfileForUserException,
                        PropertyServerException,
                        UserNotAuthorizedException

Remove an asset from identified user's list of favorite assets.

Parameters:

userId - userId of user making request.

assetCollectionGUID - unique identifier of the asset collection to use.

assetGUID - unique identifier of the asset.

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile so can not have any asset collections.

PropertyServerException - there is a problem updating information in the property server(s).

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

getAssetForConnection

String getAssetForConnection(String userId,
                             String connectionGUID)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UnrecognizedConnectionGUIDException,
                             NoConnectedAssetException,
                             UserNotAuthorizedException

Returns the unique identifier for the asset connected to the connection.

Parameters:

userId - the userId of the requesting user.

connectionGUID - uniqueId for the connection.

Returns:

unique identifier of asset

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

NoConnectedAssetException - there is no asset associated with this connection.

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 - userId of user making request.

assetGUID - unique id for asset.

Returns:

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 servers).

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 - userId of user making request.

assetGUID - unique id for the asset.

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

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

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

contextId - (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 - userId of user making request.

assetGUID - unique id for the asset.

tagName - name of the tag.

tagDescription - (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:

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 - userId of user making request.

assetGUID - unique id for the asset.

tagName - name of the tag.

tagDescription - (optional) description of the tag.

Returns:

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 - userId of user making request.

assetGUID - unique id for the asset.

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

review - 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 - userId of user making request.

assetGUID - 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 - userId of user making request.

assetGUID - unique id for the asset.

commentType - type of comment enum.

commentText - 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 - userId of user making request.

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

commentType - type of comment enum.

commentText - 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 - userId of user making request.

tagGUID - 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 private tag from the asset that was added by this user.

Parameters:

userId - userId of user making request.

tagGUID - 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 - userId of user making request.

ratingGUID - 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 - userId of user making request.

likeGUID - 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 - userId of user making request.

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