B - class that represents the governance definitionpublic class GovernanceDefinitionHandler<B> extends ReferenceableHandler<B>
auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones| Constructor and Description |
|---|
GovernanceDefinitionHandler(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.
|
| Modifier and Type | Method and Description |
|---|---|
void |
clearDefinitionRelationship(String userId,
String definitionParentGUID,
String definitionParentGUIDParameterName,
String definitionParentTypeName,
String definitionChildGUID,
String definitionChildGUIDParameterName,
String definitionChildTypeGUID,
String definitionChildTypeName,
String relationshipTypeGUID,
String relationshipTypeName,
String methodName)
Remove a relationship between two definitions.
|
String |
createGovernanceDefinition(String userId,
String qualifiedName,
String title,
String summary,
String description,
String scope,
int domainIdentifier,
String priority,
List<String> implications,
List<String> outcomes,
List<String> results,
List<String> businessImperatives,
String jurisdiction,
String implementationDescription,
String namePattern,
String details,
Map<String,String> additionalProperties,
String suppliedTypeName,
Map<String,Object> extendedProperties,
String methodName)
Create the governance definition object.
|
List<B> |
findGovernanceDefinitions(String userId,
String typeGUID,
String typeName,
String searchString,
String searchStringParameterName,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of governance definition metadata elements that contain the search string.
|
B |
getGovernanceDefinitionByGUID(String userId,
String guid,
String guidParameterName,
String methodName)
Retrieve the definition metadata element with the supplied unique identifier.
|
List<B> |
getGovernanceDefinitions(String userId,
String typeGUID,
String typeName,
int startFrom,
int pageSize,
String methodName)
Return information about the defined governance definitions.
|
List<B> |
getGovernanceDefinitionsByDomain(String userId,
String typeGUID,
String typeName,
int domainIdentifier,
int startFrom,
int pageSize,
String methodName)
Return information about the defined governance zones for a specific domain.
|
List<B> |
getGovernanceDefinitionsByName(String userId,
String typeGUID,
String typeName,
String name,
String nameParameterName,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of definition metadata elements with a matching qualified or title.
|
List<Relationship> |
getGoverningDefinitionLinks(String userId,
String elementGUID,
String elementGUIDParameterName,
String elementTypeName,
String governanceDefinitionTypeName,
int startFrom,
int pageSize,
String methodName)
Retrieve the links to the governance definitions that define the governance for an element.
|
List<B> |
getGoverningDefinitions(String userId,
String elementGUID,
String elementGUIDParameterName,
String elementTypeName,
String governanceDefinitionTypeName,
int startFrom,
int pageSize,
String methodName)
Retrieve the governance definitions that define the governance for an element.
|
List<B> |
getLinkedDefinitions(String userId,
String definitionGUID,
String definitionGUIDParameterName,
String definitionTypeName,
String relationshipTypeGUID,
String relationshipTypeName,
String targetElementType,
int startFrom,
int pageSize,
String methodName)
Return the list of elements associated with a definition.
|
void |
removeGovernanceDefinition(String userId,
String definitionGUID,
String definitionGUIDParameterName,
String methodName)
Remove the metadata element representing a governance definition.
|
void |
setupDelegationRelationship(String userId,
String definitionParentGUID,
String definitionParentGUIDParameterName,
String definitionParentTypeName,
String definitionChildGUID,
String definitionChildGUIDParameterName,
String definitionChildTypeName,
String relationshipTypeGUID,
String relationshipTypeName,
String rationale,
String methodName)
Create a parent-child relationship between two definitions - for example, between a governance policy and an governance control.
|
void |
setupPeerRelationship(String userId,
String definitionParentGUID,
String definitionParentGUIDParameterName,
String definitionParentTypeName,
String definitionChildGUID,
String definitionChildGUIDParameterName,
String definitionChildTypeName,
String relationshipTypeGUID,
String relationshipTypeName,
String description,
String methodName)
Create a parent-child relationship between two definitions - for example, between two governance policies.
|
void |
updateGovernanceDefinition(String userId,
String definitionGUID,
String definitionGUIDParameterName,
String qualifiedName,
String title,
String summary,
String description,
String scope,
int domainIdentifier,
String priority,
List<String> implications,
List<String> outcomes,
List<String> results,
List<String> businessImperatives,
String jurisdiction,
String implementationDescription,
String namePattern,
String details,
Map<String,String> additionalProperties,
String suppliedTypeName,
Map<String,Object> extendedProperties,
boolean isMergeUpdate,
String methodName)
Update the governance definition.
|
addOwner, addSecurityTags, addTemplateClassification, clearBusinessSignificant, findBeanGUIDsByQualifiedName, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getCollectionMembers, getEntityByUniqueQualifiedName, getMoreInformation, getMoreInformation, getVendorProperties, linkElementsAsDuplicates, removeOwner, removeResourceListMember, removeSecurityTags, removeSemanticAssignment, removeTemplateClassification, saveResourceListMember, saveSemanticAssignment, saveSemanticAssignment, setBusinessSignificant, unlinkElementsAsDuplicatesarchiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByIntValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkAllElements, unlinkConnectedElement, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentitypublic GovernanceDefinitionHandler(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)
converter - specific converter for this bean classbeanClass - name of bean class that is represented by the generic class BserviceName - name of this serviceserverName - name of the local serverinvalidParameterHandler - handler for managing parameter errorsrepositoryHandler - manages calls to the repository servicesrepositoryHelper - provides utilities for manipulating the repository services objectslocalServerUserId - userId for this serversecurityVerifier - open metadata security services verifiersupportedZones - list of zones that the access service is allowed to serve B instances fromdefaultZones - list of zones that the access service should set in all new B instancespublishZones - list of zones that the access service sets up in published B instancesauditLog - destination for audit log eventspublic String createGovernanceDefinition(String userId, String qualifiedName, String title, String summary, String description, String scope, int domainIdentifier, String priority, List<String> implications, List<String> outcomes, List<String> results, List<String> businessImperatives, String jurisdiction, String implementationDescription, String namePattern, String details, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userqualifiedName - unique name for the definition - used in other configurationtitle - short display name for the governance definitionsummary - brief description of the governance definitiondescription - description of the governance definitionscope - breadth of coverage of the governance definitiondomainIdentifier - identifier that indicates which governance domain this definition belongs to (0=all)priority - relative importance of the governance definitionimplications - implications to the business in adopting this governance definitionoutcomes - expected outcomes from implementing this governance definitionresults - actual results achieved from implementing this governance definitionbusinessImperatives - for the GovernanceStrategy - how does it link to business imperativesjurisdiction - for Regulations - where does this regulation applyimplementationDescription - for GovernanceControl - how should this be implementednamePattern - for NamingStandardsRule - the pattern used to for new namesdetails - for License or Certification - additional details about the definitionadditionalProperties - additional properties for a definitionsuppliedTypeName - type name from the caller (enables creation of subtypes)extendedProperties - properties for a definition subtypemethodName - calling methodInvalidParameterException - qualifiedName or userId is nullPropertyServerException - problem accessing property serverUserNotAuthorizedException - security access problempublic void updateGovernanceDefinition(String userId, String definitionGUID, String definitionGUIDParameterName, String qualifiedName, String title, String summary, String description, String scope, int domainIdentifier, String priority, List<String> implications, List<String> outcomes, List<String> results, List<String> businessImperatives, String jurisdiction, String implementationDescription, String namePattern, String details, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, boolean isMergeUpdate, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdefinitionGUID - unique identifier for the definition to updatedefinitionGUIDParameterName - parameter supplying the definitionqualifiedName - unique name for the definition - used in other configurationtitle - short display name for the governance definitionsummary - brief description of the governance definitiondescription - description of the governance definitionscope - breadth of coverage of the governance definitiondomainIdentifier - identifier that indicates which governance domain this definition belongs to (0=all)priority - relative importance of the governance definitionimplications - implications to the business in adopting this governance definitionoutcomes - expected outcomes from implementing this governance definitionresults - actual results achieved from implementing this governance definitionbusinessImperatives - for the GovernanceStrategy - how does it link to business imperativesjurisdiction - for Regulations - where does this regulation applyimplementationDescription - for GovernanceControl - how should this be implementednamePattern - for NamingStandardsRule - the pattern used to for new namesdetails - for License or Certification - additional details about the definitionadditionalProperties - additional properties for a governance definitionsuppliedTypeName - type of termextendedProperties - properties for a governance definition subtypeisMergeUpdate - should the supplied properties be merged with the existing or replace themmethodName - calling methodInvalidParameterException - qualifiedName or userId is nullPropertyServerException - problem accessing property serverUserNotAuthorizedException - security access problempublic void setupDelegationRelationship(String userId, String definitionParentGUID, String definitionParentGUIDParameterName, String definitionParentTypeName, String definitionChildGUID, String definitionChildGUIDParameterName, String definitionChildTypeName, String relationshipTypeGUID, String relationshipTypeName, String rationale, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdefinitionParentGUID - unique identifier of the definition super-definitiondefinitionParentGUIDParameterName - parameter supplying the super-definitiondefinitionParentTypeName - typename of super-definitiondefinitionChildGUID - unique identifier of the definition sub-definitiondefinitionChildGUIDParameterName - parameter supplying the sub-definitiondefinitionChildTypeName - type name of the sub-definitionrelationshipTypeGUID - unique identifier of the relationship typerelationshipTypeName - unique name of the relationship typerationale - why are these definitions linkedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void setupPeerRelationship(String userId, String definitionParentGUID, String definitionParentGUIDParameterName, String definitionParentTypeName, String definitionChildGUID, String definitionChildGUIDParameterName, String definitionChildTypeName, String relationshipTypeGUID, String relationshipTypeName, String description, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdefinitionParentGUID - unique identifier of the definition super-definitiondefinitionParentGUIDParameterName - parameter supplying the super-definitiondefinitionParentTypeName - typename of super-definitiondefinitionChildGUID - unique identifier of the definition sub-definitiondefinitionChildGUIDParameterName - parameter supplying the sub-definitiondefinitionChildTypeName - type name of the sub-definitionrelationshipTypeGUID - unique identifier of the relationship typerelationshipTypeName - unique name of the relationship typedescription - why are these definitions linkedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void clearDefinitionRelationship(String userId, String definitionParentGUID, String definitionParentGUIDParameterName, String definitionParentTypeName, String definitionChildGUID, String definitionChildGUIDParameterName, String definitionChildTypeGUID, String definitionChildTypeName, String relationshipTypeGUID, String relationshipTypeName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdefinitionParentGUID - unique identifier of the definition super-definitiondefinitionParentGUIDParameterName - parameter supplying the super-definitiondefinitionParentTypeName - typename of super-definitiondefinitionChildGUID - unique identifier of the definition sub-definitiondefinitionChildGUIDParameterName - parameter supplying the sub-definitiondefinitionChildTypeGUID - type guid of the sub-definitiondefinitionChildTypeName - type name of the sub-definitionrelationshipTypeGUID - unique identifier of the relationship typerelationshipTypeName - unique name of the relationship typemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public void removeGovernanceDefinition(String userId, String definitionGUID, String definitionGUIDParameterName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdefinitionGUID - unique identifier of the metadata element to removedefinitionGUIDParameterName - parameter for definitionGUIDmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<B> findGovernanceDefinitions(String userId, String typeGUID, String typeName, String searchString, String searchStringParameterName, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling usertypeGUID - GUID of the type of governance definitiontypeName - name of the type of governance definitionsearchString - string to find in the propertiessearchStringParameterName - name of parameter supplying the search stringstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<B> getLinkedDefinitions(String userId, String definitionGUID, String definitionGUIDParameterName, String definitionTypeName, String relationshipTypeGUID, String relationshipTypeName, String targetElementType, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdefinitionGUID - unique identifier of the definition to querydefinitionGUIDParameterName - name of the parameter supplying definitionGUIDdefinitionTypeName - type of the starting elementrelationshipTypeGUID - unique identifier of the relationship (null if any relationship)relationshipTypeName - unique name of the relationship (null if any relationship)targetElementType - type of the target elementstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<B> getGovernanceDefinitions(String userId, String typeGUID, String typeName, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling usertypeGUID - GUID of the type of governance definitiontypeName - name of the type of governance definitionstartFrom - position in the list (used when there are so many reports that paging is neededpageSize - maximum number of elements to return an this callmethodName - calling methodInvalidParameterException - qualifiedName or userId is nullPropertyServerException - problem accessing property serverUserNotAuthorizedException - security access problempublic List<B> getGovernanceDefinitionsByDomain(String userId, String typeGUID, String typeName, int domainIdentifier, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling usertypeGUID - GUID of the type of governance definitiontypeName - name of the type of governance definitiondomainIdentifier - identifier of domain - 0 is for all domainsstartFrom - position in the list (used when there are so many reports that paging is neededpageSize - maximum number of elements to return an this callmethodName - calling methodInvalidParameterException - qualifiedName or userId is nullPropertyServerException - problem accessing property serverUserNotAuthorizedException - security access problempublic List<B> getGovernanceDefinitionsByName(String userId, String typeGUID, String typeName, String name, String nameParameterName, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling usertypeGUID - GUID of the type of governance definitiontypeName - name of the type of governance definitionname - name to search fornameParameterName - parameter supplying namestartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<Relationship> getGoverningDefinitionLinks(String userId, String elementGUID, String elementGUIDParameterName, String elementTypeName, String governanceDefinitionTypeName, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling usergovernanceDefinitionTypeName - name of the type of required governance definitionselementGUID - unique identifier of the requested metadata elementelementGUIDParameterName - parameter name of the elementGUIDelementTypeName - name of the type of the starting elementstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<B> getGoverningDefinitions(String userId, String elementGUID, String elementGUIDParameterName, String elementTypeName, String governanceDefinitionTypeName, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling usergovernanceDefinitionTypeName - name of the type of required governance definitionselementGUID - unique identifier of the requested metadata elementelementGUIDParameterName - parameter name of the elementGUIDelementTypeName - name of the type of the starting elementstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public B getGovernanceDefinitionByGUID(String userId, String guid, String guidParameterName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userguid - unique identifier of the requested metadata elementguidParameterName - parameter name of guidmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)Copyright © 2018–2021 LF AI & Data Foundation. All rights reserved.