Package org.odpi.openmetadata.commonservices.generichandlers

Class GovernanceZoneHandler<B>

java.lang.Object

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

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

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

public class GovernanceZoneHandler<B>
extends OpenMetadataAPIGenericHandler<B>

GovernanceZoneHandler provides the exchange of metadata about governance zones between the repository and the OMAS. There is no support for effectivity dating because just too difficult to manage the zone look up for Assets. They are also supposed to be long-lived.

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

GovernanceZoneHandler(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 governance zone handler with information needed to work with B objects.

Method Summary

Modifier and Type	Method	Description
String	createGovernanceZone(String userId, String externalSourceGUID, String externalSourceName, String qualifiedName, String zoneName, String displayName, String description, String criteria, String scope, int domainIdentifier, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, Date effectiveTime, String methodName)	Create a definition of a governance zone.
B	getGovernanceZone(String userId, String name, String nameParameter, String methodName)	Return information about a specific governance zone.
List<Relationship>	getGovernanceZoneChildrenGUIDs(String userId, String zoneGUID, String zoneGUIDParameter, String methodName)	Return information about a specific governance zone's child (nested) zones.
Relationship	getGovernanceZoneParentGUID(String userId, String zoneGUID, String zoneGUIDParameter, String methodName)	Return information about a specific governance zone's parent.
List<B>	getGovernanceZones(String userId, int startFrom, int pageSize, String methodName)	Return information about the defined governance zones.
List<B>	getGovernanceZonesByDomain(String userId, int domainIdentifier, int startFrom, int pageSize, String methodName)	Return information about the defined governance zones for a specific domain.
void	updateGovernanceZone(String userId, String externalSourceGUID, String externalSourceName, String zoneGUID, String zoneGUIDParameterName, String qualifiedName, String zoneName, String displayName, String description, String criteria, String scope, int domainIdentifier, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, boolean isMergeUpdate, String methodName)	Create a definition of a governance zone.

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

addAnchorGUIDToBuilder, addAnchorsClassification, archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanInRepository, createBeanInRepository, deleteAnchoredEntity, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteRelationship, findAttachmentLinks, findBeans, findBeans, findBeans, findEntities, findEntities, findEntities, findEntities, getAllAttachmentLinks, getAnchorGUIDForEntity, getAnchorGUIDFromAnchorsClassification, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLink, getAttachmentLink, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanHistory, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getDomainName, getDomainName, getEntitiesByIntValue, getEntitiesByType, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRelationshipHistory, getSpecification, getSupplementaryProperties, getUniqueAttachmentLink, getUniqueAttachmentLink, getValidatedBeans, getValidatedEntities, linkElementToElement, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, multiLinkElementToElement, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, uncheckedLinkElementToElement, undoBeanUpdateInRepository, undoBeanUpdateInRepository, undoBeanUpdateInRepository, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, updateRelationshipProperties, validateAnchorEntity, validateAnchorForEntities, validateAnchorForEntity, validateAnchorForEntity, validateAnchorGUID, validateRelationship, 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

GovernanceZoneHandler

public GovernanceZoneHandler(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 governance zone 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

createGovernanceZone

public String createGovernanceZone(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String qualifiedName,
 String zoneName,
 String displayName,
 String description,
 String criteria,
 String scope,
 int domainIdentifier,
 Map<String,String> additionalProperties,
 String suppliedTypeName,
 Map<String,Object> extendedProperties,
 Date effectiveTime,
 String methodName)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a definition of a governance zone. The qualified name of these governance zones can be added to the supportedZones and defaultZones properties of an OMAS to control which assets are processed and how they are set up. In addition, the qualified names of zones can be added to Asset definitions to indicate which zone(s) they belong to.

Parameters:

userId - calling user

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

qualifiedName - unique name for the zone entity

zoneName - unique name for the zone - used in other configuration

displayName - short display name for the zone

description - description of the governance zone

criteria - the criteria for inclusion in a governance zone

scope - scope of the organization that this some applies to

domainIdentifier - the identifier of the governance domain where the zone is managed

additionalProperties - additional properties for a governance zone

suppliedTypeName - type name of the zone definition (null for GovernanceZone)

extendedProperties - properties for a governance zone 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 zone

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateGovernanceZone

public void updateGovernanceZone(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String zoneGUID,
 String zoneGUIDParameterName,
 String qualifiedName,
 String zoneName,
 String displayName,
 String description,
 String criteria,
 String scope,
 int domainIdentifier,
 Map<String,String> additionalProperties,
 String suppliedTypeName,
 Map<String,Object> extendedProperties,
 boolean isMergeUpdate,
 String methodName)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a definition of a governance zone. The qualified name of these governance zones can be added to the supportedZones and defaultZones properties of an OMAS to control which assets are processed and how they are set up. In addition, the qualified names of zones can be added to Asset definitions to indicate which zone(s) they belong to.

Parameters:

userId - calling user

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

zoneGUID - unique identifier for the zone to change

zoneGUIDParameterName - parameter supplying the zoneGUID

qualifiedName - unique name for the zone entity

zoneName - unique name for the zone - used in other configuration

displayName - short display name for the zone

description - description of the governance zone

criteria - the criteria for inclusion in a governance zone

scope - scope of the organization that this some applies to

domainIdentifier - the identifier of the governance domain where the zone is managed

additionalProperties - additional properties for a governance zone

suppliedTypeName - type name of the zone definition (null for GovernanceZone)

extendedProperties - properties for a governance zone subtype

isMergeUpdate - should the supplied properties be merged with or replace existing properties

methodName - calling method

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceZone

public B getGovernanceZone(String userId,
 String name,
 String nameParameter,
 String methodName)
                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about a specific governance zone.

Parameters:

userId - calling user

name - unique name for the zone

nameParameter - name of parameter supplying the name

methodName - calling method

Returns:

properties of the governance zone

Throws:

InvalidParameterException - name or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceZoneParentGUID

public Relationship getGovernanceZoneParentGUID(String userId,
 String zoneGUID,
 String zoneGUIDParameter,
 String methodName)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about a specific governance zone's parent.

Parameters:

userId - calling user

zoneGUID - unique identifier for the zone

zoneGUIDParameter - name of parameter supplying the zoneGUID

methodName - calling method

Returns:

Relationship to the parent

Throws:

InvalidParameterException - zoneGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceZoneChildrenGUIDs

public List<Relationship> getGovernanceZoneChildrenGUIDs(String userId,
 String zoneGUID,
 String zoneGUIDParameter,
 String methodName)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about a specific governance zone's child (nested) zones.

Parameters:

userId - calling user

zoneGUID - unique identifier for the zone

zoneGUIDParameter - name of parameter supplying the zoneGUID

methodName - calling method

Returns:

list of relationships of the child governance zones

Throws:

InvalidParameterException - zoneGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceZones

public List<B> getGovernanceZones(String userId,
 int startFrom,
 int pageSize,
 String methodName)
                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the defined governance zones.

Parameters:

userId - calling user

startFrom - position in the list (used when there are so many reports that paging is needed

pageSize - maximum number of elements to return on this call

methodName - calling method

Returns:

properties of the governance zone

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceZonesByDomain

public List<B> getGovernanceZonesByDomain(String userId,
 int domainIdentifier,
 int startFrom,
 int pageSize,
 String methodName)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the defined governance zones for a specific domain.

Parameters:

userId - calling user

domainIdentifier - identifier of domain - 0 is for all domains

startFrom - position in the list (used when there are so many reports that paging is needed

pageSize - maximum number of elements to return on this call

methodName - calling method

Returns:

properties of the governance zone

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem