org.odpi.openmetadata.accessservices.assetconsumer.handlers

Class TaggingHandler

java.lang.Object

org.odpi.openmetadata.accessservices.assetconsumer.handlers.TaggingHandler

All Implemented Interfaces:

AssetConsumerTaggingInterface

public class TaggingHandler
extends Object
implements AssetConsumerTaggingInterface

TaggingHandler provides the server-side support for the Asset Consumer OMAS's Tagging Interface. This provides methods for managing informal tags (both public and private) and attaching/detaching them to assets.

Constructor Summary

Constructors

Constructor and Description
TaggingHandler(String serviceName, OMRSRepositoryConnector repositoryConnector) Construct the feedback handler with a link to the property server's connector and this access service's official name.

Method Summary

Modifier and Type	Method and Description
void	addTagToAsset(String userId, String assetGUID, String tagGUID) Adds a tag (either private of public) to an asset.
String	createPrivateTag(String userId, String tagName, String tagDescription) Creates a new private informal tag and returns the unique identifier for it.
String	createPublicTag(String userId, String tagName, String tagDescription) Creates a new public informal tag and returns the unique identifier for it.
void	deleteTag(String userId, String tagGUID) Removes a tag from the repository.
Tag	getTag(String userId, String guid) Return the tag for the supplied unique identifier (guid).
List<Tag>	getTagsByName(String userId, String tag, int startFrom, int pageSize) Return the list of tags matching the supplied name.
void	removeTagFromAsset(String userId, String assetGUID, String tagGUID) Removes a tag from the asset that was added by this user.
void	updateTagDescription(String userId, String tagGUID, String tagDescription) Updates the description of an existing tag (either private of public).

Methods inherited from class java.lang.Object

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

Constructor Detail

TaggingHandler

public TaggingHandler(String serviceName,
                      OMRSRepositoryConnector repositoryConnector)

Construct the feedback handler with a link to the property server's connector and this access service's official name.

Parameters:

serviceName - name of this service

repositoryConnector - connector to the property server.

Method Detail

createPublicTag

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

Creates a new public informal tag and returns the unique identifier for it.

Specified by:

createPublicTag in interface AssetConsumerTaggingInterface

Parameters:

userId - userId of user making request.

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.

createPrivateTag

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

Creates a new private informal tag and returns the unique identifier for it.

Specified by:

createPrivateTag in interface AssetConsumerTaggingInterface

Parameters:

userId - userId of user making request.

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.

updateTagDescription

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

Updates the description of an existing tag (either private of public).

Specified by:

updateTagDescription in interface AssetConsumerTaggingInterface

Parameters:

userId - userId of user making request.

tagGUID - unique identifier for the tag.

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

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.

deleteTag

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

Removes a tag from the repository. All of the relationships to assets are lost.

Specified by:

deleteTag in interface AssetConsumerTaggingInterface

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.

getTag

public Tag getTag(String userId,
                  String guid)
           throws InvalidParameterException,
                  PropertyServerException,
                  UserNotAuthorizedException

Return the tag for the supplied unique identifier (guid).

Specified by:

getTag in interface AssetConsumerTaggingInterface

Parameters:

userId - userId of the user making the request.

guid - unique identifier of the tag.

Returns:

tag

Throws:

InvalidParameterException - the userId is null or invalid.

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

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

getTagsByName

public List<Tag> getTagsByName(String userId,
                               String tag,
                               int startFrom,
                               int pageSize)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Return the list of tags matching the supplied name.

Specified by:

getTagsByName in interface AssetConsumerTaggingInterface

Parameters:

userId - the name of the calling user.

tag - name of tag. This may include wild card characters.

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

pageSize - maximum number of elements to return.

Returns:

tag list

Throws:

InvalidParameterException - the userId is null or invalid.

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

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

addTagToAsset

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

Adds a tag (either private of public) to an asset.

Specified by:

addTagToAsset in interface AssetConsumerTaggingInterface

Parameters:

userId - userId of user making request.

assetGUID - unique id for the asset.

tagGUID - unique id of the 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.

removeTagFromAsset

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

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

Specified by:

removeTagFromAsset in interface AssetConsumerTaggingInterface

Parameters:

userId - userId of user making request.

assetGUID - unique id for the asset.

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.