Package org.odpi.openmetadata.accessservices.assetmanager.handlers

Class CommentExchangeHandler

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.handlers.CommentExchangeHandler

public class CommentExchangeHandler
extends Object

CommentExchangeHandler is the server side handler for managing comments.

Constructor Summary

Constructors

Constructor

Description

CommentExchangeHandler(String serviceName, String serverName, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandler repositoryHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String localServerUserId, org.odpi.openmetadata.metadatasecurity.server.OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)

Construct the comment exchange handler with information needed to work with comment related objects for Asset Manager OMAS.

Method Summary

Modifier and Type	Method	Description
String	createComment(String userId, String guid, String guidParameterName, org.odpi.openmetadata.frameworks.openmetadata.properties.MetadataCorrelationProperties correlationProperties, boolean isPublic, org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.CommentProperties commentProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Create a new comment.
List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.CommentElement>	getAttachedComments(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Return the comments attached to an element.
org.odpi.openmetadata.accessservices.assetmanager.metadataelements.CommentElement	getCommentByGUID(String userId, String assetManagerGUID, String assetManagerName, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Retrieve the comment metadata element with the supplied unique identifier.
void	removeComment(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.MetadataCorrelationProperties correlationProperties, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Remove the metadata element representing a comment.
void	updateComment(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.MetadataCorrelationProperties correlationProperties, String commentGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.CommentProperties commentProperties, boolean isMergeUpdate, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Update the metadata element representing a comment.

Methods inherited from class java.lang.Object

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

Constructor Details

CommentExchangeHandler

public CommentExchangeHandler(String serviceName,
 String serverName,
 org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler,
 org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandler repositoryHandler,
 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper,
 String localServerUserId,
 org.odpi.openmetadata.metadatasecurity.server.OpenMetadataServerSecurityVerifier securityVerifier,
 List<String> supportedZones,
 List<String> defaultZones,
 List<String> publishZones,
 org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)

Construct the comment exchange handler with information needed to work with comment related objects for Asset Manager OMAS.

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

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

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

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

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

auditLog - destination for audit log events.

Method Details

createComment

public String createComment(String userId,
 String guid,
 String guidParameterName,
 org.odpi.openmetadata.frameworks.openmetadata.properties.MetadataCorrelationProperties correlationProperties,
 boolean isPublic,
 org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.CommentProperties commentProperties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                     throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException

Create a new comment.

Parameters:

userId - calling user

guid - unique identifier of the element to attach the comment to

guidParameterName - parameter for guid

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

isPublic - is this visible to other people

commentProperties - properties to store

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

effectiveTime - when should the elements be effected for - null is anytime; new Date() is now

methodName - calling method

Returns:

unique identifier of the new metadata element

Throws:

org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

updateComment

public void updateComment(String userId,
 org.odpi.openmetadata.frameworks.openmetadata.properties.MetadataCorrelationProperties correlationProperties,
 String commentGUID,
 org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.CommentProperties commentProperties,
 boolean isMergeUpdate,
 boolean isPublic,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                   throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException

Update the metadata element representing a comment.

Parameters:

userId - calling user

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

commentGUID - unique identifier of the metadata element to update

commentProperties - new properties for this element

isMergeUpdate - should the properties be merged with the existing properties or completely over-write them

isPublic - is this visible to other people

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

effectiveTime - when should the elements be effected for - null is anytime; new Date() is now

methodName - calling method

Throws:

org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

removeComment

public void removeComment(String userId,
 org.odpi.openmetadata.frameworks.openmetadata.properties.MetadataCorrelationProperties correlationProperties,
 String commentGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                   throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException

Remove the metadata element representing a comment. This will delete the comment and all comment replies.

Parameters:

userId - calling user

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

commentGUID - unique identifier of the metadata element to remove

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

effectiveTime - optional date for effective time of the query. Null means any effective time

methodName - calling method

Throws:

org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

getAttachedComments

public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.CommentElement> getAttachedComments(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String elementGUID,
 String elementGUIDParameterName,
 int startFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                                                                                                            throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException

Return the comments attached to an element.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

elementGUID - unique identifier for the element where the like is attached.

elementGUIDParameterName - name of parameter for elementGUID

startFrom - paging start point

pageSize - maximum results that can be returned

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

methodName - calling method

Returns:

list of matching metadata elements

Throws:

org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

getCommentByGUID

public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.CommentElement getCommentByGUID(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String commentGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                                                                                                   throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException

Retrieve the comment metadata element with the supplied unique identifier.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

commentGUID - unique identifier of the requested metadata element

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

effectiveTime - when should the elements be effected for - null is anytime; new Date() is now

methodName - calling method

Returns:

matching metadata element

Throws:

org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)