org.odpi.openmetadata.commonservices.generichandlers

Class CommentHandler<B>

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.CommentHandler<B>

public class CommentHandler<B>
extends ReferenceableHandler<B>

CommentHandler manages Comment objects. It runs server-side in the OMAG Server Platform and retrieves Comment entities through the OMRSRepositoryConnector.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors

Constructor and Description

CommentHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
String	attachNewComment(String userId, String externalSourceGUID, String externalSourceName, String anchorGUID, String parentGUID, String guidParameter, int commentType, String commentText, boolean isPublic, String methodName) Adds a comment and link it to the supplied parent entity.
int	countAttachedComments(String userId, String elementGUID, String methodName) Count the number of comments attached to an anchor entity.
List<B>	getComments(String userId, String elementGUID, String elementGUIDParameterName, String elementTypeName, int startingFrom, int pageSize, String methodName) Return the comments attached to an anchor entity.
List<B>	getComments(String userId, String elementGUID, String elementGUIDParameterName, String elementTypeName, List<String> serviceSupportedZones, int startingFrom, int pageSize, String methodName) Return the comments attached to an entity.
List<B>	getComments(String userId, String anchorGUID, String anchorGUIDParameterName, String elementGUID, String elementGUIDParameterName, String elementTypeName, List<String> serviceSupportedZones, int startingFrom, int pageSize, String methodName) Return the comments attached to an entity.
void	removeCommentFromElement(String userId, String externalSourceGUID, String externalSourceName, String commentGUID, String commentGUIDParameterName, String methodName) Removes a comment added to the parent by this user.
void	updateComment(String userId, String externalSourceGUID, String externalSourceName, String commentGUID, String commentGUIDParameterName, int commentType, String commentText, boolean isPublic, String methodName) Update an existing comment.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler

addSecurityTags, addTemplateClassification, findBeanGUIDsByQualifiedName, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getMoreInformation, getMoreInformation, getVendorProperties, linkElementsAsDuplicates, removeSecurityTags, removeSemanticAssignment, removeTemplateClassification, saveSemanticAssignment, saveSemanticAssignment, unlinkElementsAsDuplicates

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkAllElements, unlinkConnectedElement, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentHandler

public CommentHandler(OpenMetadataAPIGenericConverter<B> converter,
                      Class<B> beanClass,
                      String serviceName,
                      String serverName,
                      InvalidParameterHandler invalidParameterHandler,
                      RepositoryHandler repositoryHandler,
                      OMRSRepositoryHelper repositoryHelper,
                      String localServerUserId,
                      OpenMetadataServerSecurityVerifier securityVerifier,
                      List<String> supportedZones,
                      List<String> defaultZones,
                      List<String> publishZones,
                      AuditLog auditLog)

Construct the handler information needed to interact with the repository services

Parameters:

converter - specific converter for this bean class

beanClass - name of bean class that is represented by the generic class B

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

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

supportedZones - list of zones that the access service is allowed to serve Asset instances from.

defaultZones - list of zones that the access service should set in all new Asset instances.

publishZones - list of zones that the access service sets up in published Asset instances.

auditLog - destination for audit log events.

Method Detail

countAttachedComments

public int countAttachedComments(String userId,
                                 String elementGUID,
                                 String methodName)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Count the number of comments attached to an anchor entity.

Parameters:

userId - calling user

elementGUID - 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

attachNewComment

public String attachNewComment(String userId,
                               String externalSourceGUID,
                               String externalSourceName,
                               String anchorGUID,
                               String parentGUID,
                               String guidParameter,
                               int commentType,
                               String commentText,
                               boolean isPublic,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Adds a comment and link it to the supplied parent entity.

Parameters:

userId - String - userId of user making request.

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

anchorGUID - head of the comment chain

parentGUID - String - unique id for a referenceable entity that the comment is to be attached to.

guidParameter - name of parameter that supplied the entity's unique identifier.

commentType - ordinal of comment enum.

commentText - String - the text of the comment.

isPublic - should this be visible to all or private to the caller

methodName - calling method

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.

updateComment

public void updateComment(String userId,
                          String externalSourceGUID,
                          String externalSourceName,
                          String commentGUID,
                          String commentGUIDParameterName,
                          int commentType,
                          String commentText,
                          boolean isPublic,
                          String methodName)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException

Update an existing comment.

Parameters:

userId - userId of user making request.

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

commentGUID - unique identifier for the comment to change

commentGUIDParameterName - name of parameter for commentGUID

commentType - type of comment enum.

commentText - the text of the comment.

isPublic - indicates whether the feedback should be shared or only be visible to the originating user

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.

removeCommentFromElement

public void removeCommentFromElement(String userId,
                                     String externalSourceGUID,
                                     String externalSourceName,
                                     String commentGUID,
                                     String commentGUIDParameterName,
                                     String methodName)
                              throws InvalidParameterException,
                                     PropertyServerException,
                                     UserNotAuthorizedException

Removes a comment added to the parent by this user.

Parameters:

userId - userId of user making request.

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

commentGUIDParameterName - parameter supplying the

commentGUID - unique identifier for the comment object.

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 user does not have permission to perform this request.

getComments

public List<B> getComments(String userId,
                           String anchorGUID,
                           String anchorGUIDParameterName,
                           String elementGUID,
                           String elementGUIDParameterName,
                           String elementTypeName,
                           List<String> serviceSupportedZones,
                           int startingFrom,
                           int pageSize,
                           String methodName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Return the comments attached to an entity.

Parameters:

userId - calling user

anchorGUID - expected anchorGUID for this element

anchorGUIDParameterName - parameter supplying anchorGUID

elementGUID - identifier for the entity that the comment is attached to

elementGUIDParameterName - name of the parameter providing the element GUID

elementTypeName - name of the type of the anchor entity

serviceSupportedZones - supported zones for the particular service

startingFrom - where to start from in the list

pageSize - maximum number of results that can be returned

methodName - calling method

Returns:

list of retrieved objects

Throws:

InvalidParameterException - the input properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getComments

public List<B> getComments(String userId,
                           String elementGUID,
                           String elementGUIDParameterName,
                           String elementTypeName,
                           List<String> serviceSupportedZones,
                           int startingFrom,
                           int pageSize,
                           String methodName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Return the comments attached to an entity. (No special security checking is required).

Parameters:

userId - calling user

elementGUID - identifier for the entity that the comment is attached to

elementGUIDParameterName - name of the parameter providing the element GUID

elementTypeName - name of the type of the anchor entity

serviceSupportedZones - supported zones for the particular service

startingFrom - where to start from in the list

pageSize - maximum number of results that can be returned

methodName - calling method

Returns:

list of retrieved objects

Throws:

InvalidParameterException - the input properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getComments

public List<B> getComments(String userId,
                           String elementGUID,
                           String elementGUIDParameterName,
                           String elementTypeName,
                           int startingFrom,
                           int pageSize,
                           String methodName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Return the comments attached to an anchor entity. (No special security checking is required).

Parameters:

userId - calling user

elementGUID - identifier for the entity that the comment is attached to

elementGUIDParameterName - name of the parameter providing the element GUID

elementTypeName - name of the type of the anchor entity

startingFrom - where to start from in the list

pageSize - maximum number of results that can be returned

methodName - calling method

Returns:

list of retrieved objects

Throws:

InvalidParameterException - the input properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server