org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers

Class InformalTagHandler

java.lang.Object

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.AttachmentHandlerBase

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.FeedbackHandlerBase

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.InformalTagHandler

public class InformalTagHandler
extends FeedbackHandlerBase

InformalTagHandler manages InformalTag objects. These are user controlled semantic tags. InformalTagHandler runs server-side in the OMAG Server Platform and retrieves InformalTag entities through the OMRSRepositoryConnector.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.AttachmentHandlerBase

invalidParameterHandler, lastAttachmentHandler, repositoryHandler, repositoryHelper, serverName, serviceName

Constructor Summary

Constructors

Constructor and Description
InformalTagHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, LastAttachmentHandler lastAttachmentHandler) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
void	addTagToAnchor(String userId, String anchorGUID, String anchorType, String tagGUID, boolean isPublic, String methodName) Adds a tag (either private of public) to an anchor.
int	countTags(String userId, String anchorGUID, String methodName) Count the number of informal tags attached to an anchor entity.
String	createTag(String userId, String tagName, String tagDescription, boolean isPublic, String methodName) Creates a new informal tag and returns the unique identifier for it.
void	deleteTag(String userId, String tagGUID, String methodName) Removes a tag from the repository.
List<InformalTag>	findMyTags(String userId, String searchString, int startFrom, int pageSize, String methodName) Return the list of private tags for the user matching the supplied searchString.
List<InformalTag>	findTags(String userId, String searchString, int startFrom, int pageSize, String methodName) Return the list of tags matching the supplied searchString.
List<InformalTag>	getAttachedTags(String userId, String anchorGUID, String anchorTypeName, int startingFrom, int pageSize, String methodName) Return the informal tags attached to an anchor entity.
List<InformalTag>	getMyTagsByName(String userId, String name, int startFrom, int pageSize, String methodName) Return the list of tags exactly matching the supplied name.
InformalTag	getTag(String userId, String guid, String methodName) Return the tag for the supplied unique identifier (guid).
List<InformalTag>	getTagsByName(String userId, String name, int startFrom, int pageSize, String methodName) Return the list of tags exactly matching the supplied name.
void	removeTagFromAnchor(String userId, String anchorGUID, String anchorType, String tagGUID, String methodName) Removes a tag from the anchor that was added by this user.
void	updateTagDescription(String userId, String tagGUID, String tagDescription, String methodName) Updates the description of an existing tag (either private of public).

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.FeedbackHandlerBase

countAttachments, getAttachmentLinks, getAttachments, visibleToUser

Methods inherited from class java.lang.Object

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

Constructor Detail

InformalTagHandler

public InformalTagHandler(String serviceName,
                          String serverName,
                          InvalidParameterHandler invalidParameterHandler,
                          RepositoryHandler repositoryHandler,
                          OMRSRepositoryHelper repositoryHelper,
                          LastAttachmentHandler lastAttachmentHandler)

Construct the handler information needed to interact with the repository services

Parameters:

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

lastAttachmentHandler - handler for recording last attachment

Method Detail

countTags

public int countTags(String userId,
                     String anchorGUID,
                     String methodName)
              throws InvalidParameterException,
                     PropertyServerException,
                     UserNotAuthorizedException

Count the number of informal tags attached to an anchor entity.

Parameters:

userId - calling user

anchorGUID - identifier for the entity that the object is attached to

methodName - calling method

Returns:

count of attached objects

Throws:

InvalidParameterException - the parameters are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getAttachedTags

public List<InformalTag> getAttachedTags(String userId,
                                         String anchorGUID,
                                         String anchorTypeName,
                                         int startingFrom,
                                         int pageSize,
                                         String methodName)
                                  throws InvalidParameterException,
                                         PropertyServerException,
                                         UserNotAuthorizedException

Return the informal tags attached to an anchor entity.

Parameters:

userId - calling user

anchorGUID - identifier for the entity that the identifier is attached to

anchorTypeName - type name for anchor

startingFrom - start position for results

pageSize - maximum number of results

methodName - calling method

Returns:

list of retrieved objects or null if none found

Throws:

InvalidParameterException - the input properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createTag

public String createTag(String userId,
                        String tagName,
                        String tagDescription,
                        boolean isPublic,
                        String methodName)
                 throws InvalidParameterException,
                        PropertyServerException,
                        UserNotAuthorizedException

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

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.

isPublic - flag indicating whether the attachment of the tag is public or not

methodName - calling method

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,
                                 String methodName)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Updates the description of an existing tag (either private of public). Private tags can only be updated by their creator.

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.

methodName - calling method

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,
                      String methodName)
               throws InvalidParameterException,
                      PropertyServerException,
                      UserNotAuthorizedException

Removes a tag from the repository. A private tag can be deleted by its creator and all of the references are lost; a public tag can be deleted by anyone, but only if it is not attached to any referenceable.

Parameters:

userId - userId of user making request.

tagGUID - unique id for the tag.

methodName - calling method

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 InformalTag getTag(String userId,
                          String guid,
                          String methodName)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException

Return the tag for the supplied unique identifier (guid). The tag is only returned if

Parameters:

userId - userId of the user making the request.

guid - unique identifier of the tag.

methodName - calling method

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<InformalTag> getTagsByName(String userId,
                                       String name,
                                       int startFrom,
                                       int pageSize,
                                       String methodName)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Return the list of tags exactly matching the supplied name.

Parameters:

userId - the name of the calling user.

name - name of tag.

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

pageSize - maximum number of elements to return.

methodName - calling method

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.

getMyTagsByName

public List<InformalTag> getMyTagsByName(String userId,
                                         String name,
                                         int startFrom,
                                         int pageSize,
                                         String methodName)
                                  throws InvalidParameterException,
                                         PropertyServerException,
                                         UserNotAuthorizedException

Return the list of tags exactly matching the supplied name.

Parameters:

userId - the name of the calling user.

name - name of tag.

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

pageSize - maximum number of elements to return.

methodName - calling method

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.

findTags

public List<InformalTag> findTags(String userId,
                                  String searchString,
                                  int startFrom,
                                  int pageSize,
                                  String methodName)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Return the list of tags matching the supplied searchString.

Parameters:

userId - the searchString of the calling user.

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

methodName - calling method

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.

findMyTags

public List<InformalTag> findMyTags(String userId,
                                    String searchString,
                                    int startFrom,
                                    int pageSize,
                                    String methodName)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Return the list of private tags for the user matching the supplied searchString.

Parameters:

userId - the searchString of the calling user.

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

methodName - calling method

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.

addTagToAnchor

public void addTagToAnchor(String userId,
                           String anchorGUID,
                           String anchorType,
                           String tagGUID,
                           boolean isPublic,
                           String methodName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

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

Parameters:

userId - userId of user making request.

anchorGUID - unique id for the anchor.

anchorType - type of the anchor.

tagGUID - unique id of the tag.

isPublic - flag indicating whether the attachment of the tag is public or not

methodName - calling method

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.

removeTagFromAnchor

public void removeTagFromAnchor(String userId,
                                String anchorGUID,
                                String anchorType,
                                String tagGUID,
                                String methodName)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

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

Parameters:

userId - userId of user making request.

anchorGUID - unique id for the asset.

anchorType - type of the anchor.

tagGUID - unique id for the tag.

methodName - calling method

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.