Package org.odpi.openmetadata.commonservices.generichandlers

Class GovernanceDomainHandler<B>

java.lang.Object

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

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

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

Type Parameters:

B - class that represents the governance domain

public class GovernanceDomainHandler<B>
extends ReferenceableHandler<B>

GovernanceDomainHandler provides the exchange of metadata about governance domains between the repository and the OMAS. Note governanceDomains are governance metadata and are always defined with LOCAL-COHORT provenance. There is no support for effectivity dating.

Constructor Summary

Constructors

Constructor

Description

GovernanceDomainHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, 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 handler with information needed to work with B objects.

Method Summary

Modifier and Type	Method	Description
String	createGovernanceDomain(String userId, String qualifiedName, String displayName, String description, int domainIdentifier, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, Date effectiveTime, String methodName)	Create the anchor object that all elements in a governance domain (terms and categories) are linked to.
List<B>	findGovernanceDomains(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, String methodName)	Retrieve the list of governance domain metadata elements that contain the search string.
List<B>	getDomainsInSet(String userId, String startingGUID, String startingGUIDParameterName, int startingFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Return the keywords attached to a supplied entity.
B	getGovernanceDomainByDomainIdentifier(String userId, int domainIdentifier, String methodName)	Retrieve the governance domain metadata element with the supplied unique domainIdentifier.
B	getGovernanceDomainByGUID(String userId, String guid, String guidParameterName, String methodName)	Retrieve the governance domain metadata element with the supplied unique identifier.
List<B>	getGovernanceDomainsByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, String methodName)	Retrieve the list of governance domain metadata elements with a matching qualified or display name.
void	removeGovernanceDomain(String userId, String governanceDomainGUID, String governanceDomainGUIDParameterName, String methodName)	Remove the metadata element representing a governance domain.
void	updateGovernanceDomain(String userId, String governanceDomainGUID, String governanceDomainGUIDParameterName, String qualifiedName, String displayName, String description, int domainIdentifier, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, String methodName)	Update the anchor object that all elements in a governance domain (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, getCollectionMembers, getCommissionedByStakeholder, getDataFieldValuesClassifiedElement, getDescriptiveElements, getElementsSourceFrom, getEntityByUniqueQualifiedName, getGovernanceActionClassifiedElements, getGovernanceDefinitionScope, getGovernedElements, getMeanings, getMoreInformation, getMoreInformation, getOwnersElements, getReferenceValueAssignees, getResourceList, getRetentionClassifiedElements, getSecurityTagsClassifiedElements, getSemanticAssignments, getSourceElements, getStakeholders, getSubjectAreaMembers, getSubjectAreaMembers, getSupportedByResource, getValidValueConsumers, getVendorProperties, linkConsolidatedDuplicate, linkElementsAsPeerDuplicates, removeAssignmentScope, removeDataFieldValuesClassification, removeGovernanceActionClassification, removeGovernanceDefinitionScope, removeGovernanceExpectationsClassification, removeGovernanceMeasurementsClassification, removeGovernedBy, removeImplementedBy, removeMoreInformation, removeOwner, removeResourceListMember, removeRetentionClassification, removeSecurityTags, removeSemanticAssignment, removeStakeholder, removeSubjectAreaClassification, removeTemplateClassification, saveResourceListMember, saveSemanticAssignment, saveSemanticAssignment, saveSemanticAssignments, setBusinessSignificant, setVendorProperties, unlinkElementsAsPeerDuplicates

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

addAnchorsClassification, archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanFromTemplate, createBeanFromTemplate, 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, getAttachedFilteredEntities, getAttachedFilteredEntities, getAttachedFilteredEntities, getAttachmentLink, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanHistory, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getConverter, getEntitiesByIntValue, getEntitiesByType, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHandler, getRepositoryHelper, getServerName, getServiceName, getSupplementaryProperties, getSupportedZones, getTypeDefByName, getUniqueAttachmentLink, getUniqueAttachmentLink, isBeanIsolated, isEntityATypeOf, linkElementToElement, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, multiLinkElementToElement, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, 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 java.lang.Object

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

Constructor Details

GovernanceDomainHandler

public GovernanceDomainHandler(OpenMetadataAPIGenericConverter<B> converter,
 Class<B> beanClass,
 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 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

createGovernanceDomain

public String createGovernanceDomain(String userId,
 String qualifiedName,
 String displayName,
 String description,
 int domainIdentifier,
 Map<String,String> additionalProperties,
 String suppliedTypeName,
 Map<String,Object> extendedProperties,
 Date effectiveTime,
 String methodName)
                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Create the anchor object that all elements in a governance domain (terms and categories) are linked to.

Parameters:

userId - calling user

qualifiedName - unique name for the governance domain - used in other configuration

displayName - short display name for the governance domain

description - description of the governance domain

domainIdentifier - the domain identifier used in the governance domain definitions

additionalProperties - additional properties for a governance domain

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

extendedProperties - properties for a governance domain subtype

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 governance domain object

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

updateGovernanceDomain

public void updateGovernanceDomain(String userId,
 String governanceDomainGUID,
 String governanceDomainGUIDParameterName,
 String qualifiedName,
 String displayName,
 String description,
 int domainIdentifier,
 Map<String,String> additionalProperties,
 String suppliedTypeName,
 Map<String,Object> extendedProperties,
 String methodName)
                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

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

Parameters:

userId - calling user

governanceDomainGUID - unique identifier of the governance domain to update

governanceDomainGUIDParameterName - parameter passing the governance domainGUID

qualifiedName - unique name for the governance domain - used in other configuration

displayName - short display name for the governance domain

description - description of the governance domain

domainIdentifier - the domain identifier used in the governance domain definitions

additionalProperties - additional properties for a governance domain

suppliedTypeName - type of governance domain

extendedProperties - properties for a governance domain subtype

methodName - calling method

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

removeGovernanceDomain

public void removeGovernanceDomain(String userId,
 String governanceDomainGUID,
 String governanceDomainGUIDParameterName,
 String methodName)
                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

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

Parameters:

userId - calling user

governanceDomainGUID - unique identifier of the metadata element to remove

governanceDomainGUIDParameterName - parameter supplying the governance domainGUID

methodName - calling method

Throws:

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

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

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

findGovernanceDomains

public List<B> findGovernanceDomains(String userId,
 String searchString,
 String searchStringParameterName,
 int startFrom,
 int pageSize,
 String methodName)
                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the list of governance domain 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

methodName - calling method

Returns:

list of matching metadata elements

Throws:

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

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

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

getGovernanceDomainsByName

public List<B> getGovernanceDomainsByName(String userId,
 String name,
 String nameParameterName,
 int startFrom,
 int pageSize,
 String methodName)
                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the list of governance domain 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

methodName - calling method

Returns:

list of matching metadata elements

Throws:

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

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

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

getDomainsInSet

public List<B> getDomainsInSet(String userId,
 String startingGUID,
 String startingGUIDParameterName,
 int startingFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                        throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Return the keywords attached to a supplied entity.

Parameters:

userId - calling user

startingGUID - identifier for the entity that the keyword is attached to

startingGUIDParameterName - name of parameter supplying the GUID

startingFrom - start position for results

pageSize - maximum number of results

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the input properties are invalid

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

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

getGovernanceDomainByGUID

public B getGovernanceDomainByGUID(String userId,
 String guid,
 String guidParameterName,
 String methodName)
                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the governance domain metadata element with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

guidParameterName - parameter name of guid

methodName - calling method

Returns:

matching metadata element

Throws:

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

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

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

getGovernanceDomainByDomainIdentifier

public B getGovernanceDomainByDomainIdentifier(String userId,
 int domainIdentifier,
 String methodName)
                                        throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the governance domain metadata element with the supplied unique domainIdentifier.

Parameters:

userId - calling user

domainIdentifier - identifier used to identify the domain

methodName - calling method

Returns:

matching metadata element

Throws:

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

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

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