Package org.odpi.openmetadata.commonservices.generichandlers

Class NoteLogHandler<B>

java.lang.Object

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

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

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

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

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

public class NoteLogHandler<B>
extends ReferenceableHandler<B>

NoteLogHandler manages NoteLog objects. It runs server-side in the OMAG Server Platform and retrieves NoteEntry entities through the OMRSRepositoryConnector.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

OpenMetadataAPIGenericHandler.AnchorIdentifiers

Field Summary

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

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

Constructor Summary

Constructors

Constructor

Description

NoteLogHandler(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	Description
String	attachNewNoteLog(String userId, String externalSourceGUID, String externalSourceName, String anchorGUID, String parentGUID, String parentGUIDParameterName, String qualifiedName, String name, String description, boolean isPublic, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Adds a noteLog and link it to the supplied parent entity.
List<B>	findNoteLogs(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Retrieve the list of metadata elements that contain the search string.
List<B>	getAttachedNoteLogs(String userId, String elementGUID, String elementGUIDParameterName, String elementTypeName, int startingFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Return the note logs attached to an anchor entity.
List<B>	getAttachedNoteLogs(String userId, String elementGUID, String elementGUIDParameterName, String elementTypeName, List<String> serviceSupportedZones, int startingFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Return the note logs attached to an anchor entity.
List<B>	getNoteLogsByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Retrieve the list of metadata elements with a matching qualified name, display name or network address.
void	removeNoteLogFromElement(String userId, String externalSourceGUID, String externalSourceName, String noteLogGUID, String noteLogGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Removes a noteLog added to the parent by this user.
void	updateNoteLog(String userId, String externalSourceGUID, String externalSourceName, String noteLogGUID, String noteLogGUIDParameterName, String qualifiedName, String noteLogType, String noteLogText, boolean isPublic, boolean isMergeUpdate, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Update an existing noteLog.

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

addAssignmentScope, addDataFieldValuesClassification, addGovernanceActionClassification, addGovernanceDefinitionScope, addGovernanceExpectationsClassification, addGovernanceMeasurementsClassification, addGovernedBy, addImplementedBy, addMoreInformation, addOwner, addRetentionClassification, addSecurityTags, addStakeholder, addSubjectAreaClassification, addTemplateClassification, clearBusinessSignificant, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getAssignedActors, getAssignmentScope, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getCatalogTemplateList, getCollectionMembers, getCommissionedByStakeholder, getDataFieldValuesClassifiedElement, getDescriptiveElements, getElementsSourceFrom, getEntityByUniqueQualifiedName, getGovernanceActionClassifiedElements, getGovernanceDefinitionScope, getGovernedElements, getMeanings, getMoreInformation, getMoreInformation, getOwnersElements, getReferenceValueAssignees, getResourceList, getRetentionClassifiedElements, getSecurityTagsClassifiedElements, getSemanticAssignments, getSourceElements, getStakeholders, getSubjectAreaMembers, getSubjectAreaMembers, getSupportedByResource, getSupportedByTemplate, getValidValueConsumers, getVendorProperties, linkConsolidatedDuplicate, linkElementsAsPeerDuplicates, removeAssignmentScope, removeCatalogTemplate, removeDataFieldValuesClassification, removeGovernanceActionClassification, removeGovernanceDefinitionScope, removeGovernanceExpectationsClassification, removeGovernanceMeasurementsClassification, removeGovernedBy, removeImplementedBy, removeMoreInformation, removeOwner, removeResourceListMember, removeRetentionClassification, removeSecurityTags, removeSemanticAssignment, removeStakeholder, removeSubjectAreaClassification, removeTemplateClassification, saveCatalogTemplate, saveResourceListMember, saveSemanticAssignment, saveSemanticAssignment, saveSemanticAssignments, setBusinessSignificant, setVendorProperties, unlinkElementsAsPeerDuplicates

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

createBeanFromTemplate, createBeanFromTemplate

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

addAnchorGUIDToBuilder, addAnchorsClassification, archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanInRepository, createBeanInRepository, deleteAnchoredEntity, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteRelationship, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findEntities, findEntities, findEntities, findEntities, getAllAttachmentLinks, getAnchorGUIDFromAnchorsClassification, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntitiesFromUser, getAttachedEntity, getAttachedEntity, getAttachedEntityFromUser, getAttachmentLink, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getAttachmentsForType, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanHistory, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getDomainName, getDomainName, getEntitiesByIntValue, getEntitiesByType, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getSpecification, getSupplementaryProperties, getUniqueAttachmentLink, getUniqueAttachmentLink, isBeanIsolated, isEntityATypeOf, linkElementToElement, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, multiLinkElementToElement, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, uncheckedLinkElementToElement, undoBeanUpdateInRepository, undoBeanUpdateInRepository, undoBeanUpdateInRepository, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipEffectivityDates, updateRelationshipProperties, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, validateUniqueProperty, verifyExternalSourceIdentity

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

getConverter, getElementStub, getRepositoryHandler, getRepositoryHelper, getServerName, getServiceName, getSupportedZones, getTypeDefByName, setSecurityVerifier

Methods inherited from class java.lang.Object

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

Constructor Details

NoteLogHandler

public NoteLogHandler(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 Details

attachNewNoteLog

public String attachNewNoteLog(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String anchorGUID,
 String parentGUID,
 String parentGUIDParameterName,
 String qualifiedName,
 String name,
 String description,
 boolean isPublic,
 Date effectiveFrom,
 Date effectiveTo,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

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

Parameters:

userId - String - userId of user making request.

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

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

anchorGUID - head of the noteLog chain

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

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

qualifiedName - unique name of the note log

name - name of the note log

description - String - the text of the noteLog.

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

effectiveFrom - the date when this element is active - null for active now

effectiveTo - the date when this element becomes inactive - null for active until deleted

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:

guid of new noteLog.

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.

updateNoteLog

public void updateNoteLog(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String noteLogGUID,
 String noteLogGUIDParameterName,
 String qualifiedName,
 String noteLogType,
 String noteLogText,
 boolean isPublic,
 boolean isMergeUpdate,
 Date effectiveFrom,
 Date effectiveTo,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update an existing noteLog.

Parameters:

userId - userId of user making request.

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

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

noteLogGUID - unique identifier for the noteLog to change

noteLogGUIDParameterName - name of parameter for noteLogGUID

qualifiedName - unique name of the noteLog

noteLogType - type of noteLog enum.

noteLogText - the text of the noteLog.

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

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

effectiveFrom - the date when this element is active - null for active now

effectiveTo - the date when this element becomes inactive - null for active until deleted

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

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.

removeNoteLogFromElement

public void removeNoteLogFromElement(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String noteLogGUID,
 String noteLogGUIDParameterName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                              throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Removes a noteLog added to the parent by this user.

Parameters:

userId - userId of user making request.

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

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

noteLogGUIDParameterName - parameter supplying the

noteLogGUID - unique identifier for the noteLog object.

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

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.

getAttachedNoteLogs

public List<B> getAttachedNoteLogs(String userId,
 String elementGUID,
 String elementGUIDParameterName,
 String elementTypeName,
 List<String> serviceSupportedZones,
 int startingFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the note logs attached to an anchor entity.

Parameters:

userId - calling user

elementGUID - identifier for the entity that the note log is attached to

elementGUIDParameterName - name of parameter supplying the GUID

elementTypeName - name of the type of object being attached to

serviceSupportedZones - supported zones for calling service

startingFrom - where to start from in the list

pageSize - maximum number of 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 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

getAttachedNoteLogs

public List<B> getAttachedNoteLogs(String userId,
 String elementGUID,
 String elementGUIDParameterName,
 String elementTypeName,
 int startingFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the note logs attached to an anchor entity.

Parameters:

userId - calling user

elementGUID - identifier for the entity that the note log is attached to

elementGUIDParameterName - name of parameter supplying the GUID

elementTypeName - name of the type of object being attached to

startingFrom - where to start from in the list

pageSize - maximum number of 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 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

findNoteLogs

public List<B> findNoteLogs(String userId,
 String searchString,
 String searchStringParameterName,
 int startFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

searchStringParameterName - name of parameter supplying the search string

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:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getNoteLogsByName

public List<B> getNoteLogsByName(String userId,
 String name,
 String nameParameterName,
 int startFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of metadata elements with a matching qualified name, display name or network address. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

nameParameterName - parameter supplying name

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:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)