Package org.odpi.openmetadata.commonservices.generichandlers

Class CommunityHandler<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.CommunityHandler<B>

Type Parameters:

B - class that represents the community

public class CommunityHandler<B>
extends ReferenceableHandler<B>

CommunityHandler provides the exchange of metadata about communities between the repository and the OMAS.

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

CommunityHandler(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 with information needed to work with B objects.

Method Summary

Modifier and Type	Method	Description
void	addRoleToCommunity(String userId, String externalSourceGUID, String externalSourceName, String communityGUID, String communityGUIDParameterName, String memberGUID, String memberGUIDParameterName, int membershipType, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Add a member (PersonRole) to community.
String	createCommunity(String userId, String externalSourceGUID, String externalSourceName, String qualifiedName, String displayName, String description, String mission, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName)	Create the community object.
String	createCommunityFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String qualifiedName, String displayName, String description, String methodName)	Create a new metadata element to represent a community using an existing metadata element as a template.
List<B>	findCommunities(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Retrieve the list of community metadata elements that contain the search string.
List<B>	getCommunities(String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Retrieve the list of community metadata elements.
List<B>	getCommunitiesByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Retrieve the list of community metadata elements with a matching qualified or display name.
B	getCommunityByGUID(String userId, String guid, String guidParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Retrieve the community metadata element with the supplied unique identifier.
void	removeCommunity(String userId, String externalSourceGUID, String externalSourceName, String communityGUID, String communityGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Remove the metadata element representing a community.
void	removeRoleFromCommunity(String userId, String externalSourceGUID, String externalSourceName, String communityGUID, String communityGUIDParameterName, String memberGUID, String memberGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Remove a member (PersonRole) from community.
void	updateCommunity(String userId, String externalSourceGUID, String externalSourceName, String communityGUID, String communityGUIDParameterName, String qualifiedName, String displayName, String description, String mission, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Update the anchor object that all elements in a community (terms and categories) are linked to.

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

CommunityHandler

public CommunityHandler(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 with information needed to work with B objects.

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 B instances from

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

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

auditLog - destination for audit log events

Method Details

createCommunity

public String createCommunity(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String qualifiedName,
 String displayName,
 String description,
 String mission,
 Map<String,String> additionalProperties,
 String suppliedTypeName,
 Map<String,Object> extendedProperties,
 Date effectiveFrom,
 Date effectiveTo,
 Date effectiveTime,
 String methodName)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create the community object.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of the software capability that owns this community

externalSourceName - unique name of the software capability that owns this community

qualifiedName - unique name for the community - used in other configuration

displayName - short display name for the community

description - description of the governance community

mission - purpose of the community

additionalProperties - additional properties for a community

suppliedTypeName - type name from the caller (enables creation of subtypes)

extendedProperties - properties for a governance community subtype

effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)

effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)

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

methodName - calling method

Returns:

unique identifier of the new community object

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

createCommunityFromTemplate

public String createCommunityFromTemplate(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String templateGUID,
 String qualifiedName,
 String displayName,
 String description,
 String methodName)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a community using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new community. All categories and terms are linked to a single community. They are owned by this community and if the community is deleted, any linked terms and categories are deleted as well.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of the software capability that owns this community

externalSourceName - unique name of the software capability that owns this community

templateGUID - unique identifier of the metadata element to copy

qualifiedName - unique name for the community - used in other configuration

displayName - short display name for the community

description - description of the governance community

methodName - calling method

Returns:

unique identifier of the new metadata element

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)

updateCommunity

public void updateCommunity(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String communityGUID,
 String communityGUIDParameterName,
 String qualifiedName,
 String displayName,
 String description,
 String mission,
 Map<String,String> additionalProperties,
 String suppliedTypeName,
 Map<String,Object> extendedProperties,
 Date effectiveFrom,
 Date effectiveTo,
 boolean isMergeUpdate,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the anchor object that all elements in a community (terms and categories) are linked to.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of the software capability that owns this community

externalSourceName - unique name of the software capability that owns this community

communityGUID - unique identifier of the community to update

communityGUIDParameterName - parameter passing the communityGUID

qualifiedName - unique name for the community - used in other configuration

displayName - short display name for the community

description - description of the governance community

mission - purpose of the community

additionalProperties - additional properties for a governance community

suppliedTypeName - type of community

extendedProperties - properties for a governance community subtype

effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)

effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)

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

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 - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addRoleToCommunity

public void addRoleToCommunity(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String communityGUID,
 String communityGUIDParameterName,
 String memberGUID,
 String memberGUIDParameterName,
 int membershipType,
 Date effectiveFrom,
 Date effectiveTo,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Add a member (PersonRole) to community.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of the software capability that owns this community

externalSourceName - unique name of the software capability that owns this community

communityGUID - unique identifier of the community

communityGUIDParameterName - parameter supplying the communityGUID

memberGUID - unique identifier of the element that is being added to the community

memberGUIDParameterName - parameter supplying the memberGUID

membershipType - why is the element a member? (optional)

effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)

effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)

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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

removeRoleFromCommunity

public void removeRoleFromCommunity(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String communityGUID,
 String communityGUIDParameterName,
 String memberGUID,
 String memberGUIDParameterName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a member (PersonRole) from community.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of the software capability that owns this community

externalSourceName - unique name of the software capability that owns this community

communityGUID - unique identifier of the community

communityGUIDParameterName - parameter supplying the communityGUID

memberGUID - unique identifier of the element that is being added to the community

memberGUIDParameterName - parameter supplying the memberGUID

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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

removeCommunity

public void removeCommunity(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String communityGUID,
 String communityGUIDParameterName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a community. This will delete the community and all categories and terms because the Anchors classifications are set up in these elements.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of the software capability that owns this community

externalSourceName - unique name of the software capability that owns this community

communityGUID - unique identifier of the metadata element to remove

communityGUIDParameterName - parameter supplying the communityGUID

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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

findCommunities

public List<B> findCommunities(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 community 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)

getCommunitiesByName

public List<B> getCommunitiesByName(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 community metadata elements with a matching qualified or display name. 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)

getCommunities

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

Retrieve the list of community metadata elements.

Parameters:

userId - calling user

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)

getCommunityByGUID

public B getCommunityByGUID(String userId,
 String guid,
 String guidParameterName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the community metadata element with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

guidParameterName - parameter name of guid

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:

matching metadata element

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)