Package org.odpi.openmetadata.commonservices.generichandlers

Class GovernanceActionTypeHandler<B>

java.lang.Object

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

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

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

public class GovernanceActionTypeHandler<B>
extends OpenMetadataAPIGenericHandler<B>

GovernanceActionTypeHandler manages GovernanceActionType entities and their relationships.

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

GovernanceActionTypeHandler(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 for metadata elements.

Method Summary

Modifier and Type	Method	Description
String	createGovernanceActionType(String userId, String qualifiedName, int domainIdentifier, String displayName, String description, Map<String,String> additionalProperties, String governanceEngineGUID, String calledRequestType, Map<String,String> fixedRequestParameters, int waitTime, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName)	Create a new metadata element to represent a governance action type.
List<B>	findGovernanceActionTypes(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName)	Retrieve the list of governance action type metadata elements that contain the search string.
B	getGovernanceActionTypeByGUID(String userId, String governanceActionTypeGUID, List<String> serviceSupportedZones, Date effectiveTime, String methodName)	Retrieve the governance action type metadata element with the supplied unique identifier.
List<B>	getGovernanceActionTypesByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, List<String> serviceSupportedZones, Date effectiveTime, String methodName)	Retrieve the list of governance action type metadata elements with a matching qualified or display name.
void	removeGovernanceActionType(String userId, String governanceActionTypeGUID, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName)	Remove the metadata element representing a governance action type.
void	updateGovernanceActionType(String userId, String governanceActionTypeGUID, boolean isMergeUpdate, String qualifiedName, int domainIdentifier, String displayName, String description, Map<String,String> additionalProperties, String governanceEngineGUID, String requestType, Map<String,String> requestParameters, int waitTime, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName)	Update the metadata element representing a governance action type.

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

GovernanceActionTypeHandler

public GovernanceActionTypeHandler(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 for metadata elements.

Parameters:

converter - specific converter for this bean class

beanClass - name of bean class that is represented by the generic class B

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

supportedZones - list of zones that the access service is allowed to serve Asset instances from.

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

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

auditLog - destination for audit log events.

Method Details

createGovernanceActionType

public String createGovernanceActionType(String userId,
 String qualifiedName,
 int domainIdentifier,
 String displayName,
 String description,
 Map<String,String> additionalProperties,
 String governanceEngineGUID,
 String calledRequestType,
 Map<String,String> fixedRequestParameters,
 int waitTime,
 Date effectiveFrom,
 Date effectiveTo,
 boolean forLineage,
 boolean forDuplicateProcessing,
 List<String> serviceSupportedZones,
 Date effectiveTime,
 String methodName)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a governance action type.

Parameters:

userId - calling user

qualifiedName - unique name for the governance action

domainIdentifier - governance domain for this governance action

displayName - short display name for the governance action

description - description of the governance action

additionalProperties - additional properties for a governance action

governanceEngineGUID - unique identifier of governance engine to execute the request

calledRequestType - type of request

fixedRequestParameters - properties for the request type

waitTime - minimum number of minutes to wait before running the governance action

effectiveFrom - starting time for this relationship (null for all time)

effectiveTo - ending time for this relationship

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

serviceSupportedZones - supported zones for calling service

effectiveTime - what is the effective time for related queries needed to do the update

methodName - calling method

Returns:

unique identifier of the new governance action type

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)

updateGovernanceActionType

public void updateGovernanceActionType(String userId,
 String governanceActionTypeGUID,
 boolean isMergeUpdate,
 String qualifiedName,
 int domainIdentifier,
 String displayName,
 String description,
 Map<String,String> additionalProperties,
 String governanceEngineGUID,
 String requestType,
 Map<String,String> requestParameters,
 int waitTime,
 Date effectiveFrom,
 Date effectiveTo,
 boolean forLineage,
 boolean forDuplicateProcessing,
 List<String> serviceSupportedZones,
 Date effectiveTime,
 String methodName)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a governance action type.

Parameters:

userId - calling user

governanceActionTypeGUID - unique identifier of the metadata element to update

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

qualifiedName - unique name for the governance action

domainIdentifier - governance domain for this governance action

displayName - short display name for the governance action

description - description of the governance action

additionalProperties - additional properties for a governance action

governanceEngineGUID - unique identifier of governance engine to execute the request

requestType - type of request

requestParameters - properties for the request type

waitTime - minimum number of minutes to wait before running the governance action

effectiveFrom - starting time for this relationship (null for all time)

effectiveTo - ending time for this relationship

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

serviceSupportedZones - supported zones for calling service

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)

removeGovernanceActionType

public void removeGovernanceActionType(String userId,
 String governanceActionTypeGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 List<String> serviceSupportedZones,
 Date effectiveTime,
 String methodName)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a governance action type.

Parameters:

userId - calling user

governanceActionTypeGUID - unique identifier of the metadata element to remove

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

serviceSupportedZones - supported zones for calling service

effectiveTime - what is the effective time for related queries needed to do the update

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)

findGovernanceActionTypes

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

Retrieve the list of governance action type 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 - parameter supplying 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?

serviceSupportedZones - supported zones for calling service

effectiveTime - what is the effective time for related queries needed to do the update

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)

getGovernanceActionTypesByName

public List<B> getGovernanceActionTypesByName(String userId,
 String name,
 String nameParameterName,
 int startFrom,
 int pageSize,
 List<String> serviceSupportedZones,
 Date effectiveTime,
 String methodName)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action type 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 - name of parameter supplying name

startFrom - paging start point

pageSize - maximum results that can be returned

serviceSupportedZones - supported zones for calling service

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)

getGovernanceActionTypeByGUID

public B getGovernanceActionTypeByGUID(String userId,
 String governanceActionTypeGUID,
 List<String> serviceSupportedZones,
 Date effectiveTime,
 String methodName)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance action type metadata element with the supplied unique identifier.

Parameters:

userId - calling user

governanceActionTypeGUID - unique identifier of the governance action type

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

serviceSupportedZones - supported zones for calling service

methodName - calling method

Returns:

requested 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)