org.odpi.openmetadata.commonservices.generichandlers

Class GovernanceActionTypeHandler<B>

java.lang.Object

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.

Field Summary

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

auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors

Constructor and 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 and Description
String	createGovernanceActionType(String userId, String qualifiedName, int domainIdentifier, String displayName, String description, String owner, int ownerType, List<String> supportedGuards, Map<String,String> additionalProperties, String governanceEngineGUID, String requestType, Map<String,String> requestParameters, 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, String methodName) Retrieve the list of governance action type metadata elements that contain the search string.
B	getFirstActionType(String userId, String processGUID, Relationship firstActionTypeLink, String methodName) Return the governance action type that is the first step in a governance action process.
Relationship	getFirstActionTypeLink(String userId, String processGUID, String methodName) Return the governance action type that is the first step in a governance action process.
B	getGovernanceActionTypeByGUID(String userId, String actionTypeGUID, 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, String methodName) Retrieve the list of governance action type metadata elements with a matching qualified or display name.
List<Relationship>	getNextGovernanceActionTypes(String userId, String actionTypeGUID, int startFrom, int pageSize, String methodName) Return the list of next action type defined for the governance action process.
void	removeFirstActionType(String userId, String processGUID, String methodName) Remove the link between a governance process and that governance action type that defines its first step.
void	removeGovernanceActionType(String userId, String actionTypeGUID, String methodName) Remove the metadata element representing a governance action type.
void	removeNextActionType(String userId, String actionLinkGUID, String methodName) Remove a follow on step from a governance action process.
void	setupFirstActionType(String userId, String processGUID, String actionTypeGUID, String guard, String methodName) Set up a link between an governance action process and a governance action type.
String	setupNextActionType(String userId, String currentActionTypeGUID, String nextActionTypeGUID, String guard, boolean mandatoryGuard, boolean ignoreMultipleTriggers, String methodName) Add a link between two governance action types to show that one follows on from the other when a governance action process is executing.
void	updateGovernanceActionType(String userId, String actionTypeGUID, boolean isMergeUpdate, String qualifiedName, int domainIdentifier, String displayName, String description, String owner, int ownerType, List<String> supportedGuards, Map<String,String> additionalProperties, String governanceEngineGUID, String requestType, Map<String,String> requestParameters, String methodName) Update the metadata element representing a governance action type.
void	updateNextActionType(String userId, String nextActionLinkGUID, String guard, boolean mandatoryGuard, boolean ignoreMultipleTriggers, String methodName) Update the properties of the link between two governance action types that shows that one follows on from the other when a governance action process is executing.

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

archiveBeanInRepository, 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, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByType, 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, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

createGovernanceActionType

public String createGovernanceActionType(String userId,
                                         String qualifiedName,
                                         int domainIdentifier,
                                         String displayName,
                                         String description,
                                         String owner,
                                         int ownerType,
                                         List<String> supportedGuards,
                                         Map<String,String> additionalProperties,
                                         String governanceEngineGUID,
                                         String requestType,
                                         Map<String,String> requestParameters,
                                         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

owner - identifier of the owner of this governance action

ownerType - type of owner (userId or actor profile)

supportedGuards - list of guards that triggered this 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

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 actionTypeGUID,
                                       boolean isMergeUpdate,
                                       String qualifiedName,
                                       int domainIdentifier,
                                       String displayName,
                                       String description,
                                       String owner,
                                       int ownerType,
                                       List<String> supportedGuards,
                                       Map<String,String> additionalProperties,
                                       String governanceEngineGUID,
                                       String requestType,
                                       Map<String,String> requestParameters,
                                       String methodName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Update the metadata element representing a governance action type.

Parameters:

userId - calling user

actionTypeGUID - 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

owner - identifier of the owner of this governance action

ownerType - type of owner (userId or actor profile)

supportedGuards - list of guards that triggered this 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

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 actionTypeGUID,
                                       String methodName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Remove the metadata element representing a governance action type.

Parameters:

userId - calling user

actionTypeGUID - unique identifier of the metadata element to remove

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,
                                         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

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,
                                              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

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 actionTypeGUID,
                                       String methodName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

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

Parameters:

userId - calling user

actionTypeGUID - unique identifier of the governance action type

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)

setupFirstActionType

public void setupFirstActionType(String userId,
                                 String processGUID,
                                 String actionTypeGUID,
                                 String guard,
                                 String methodName)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Set up a link between an governance action process and a governance action type. This defines the first step in the process.

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

actionTypeGUID - unique identifier of the governance action type

guard - initial guard to pass to the first governance service called

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)

getFirstActionType

public B getFirstActionType(String userId,
                            String processGUID,
                            Relationship firstActionTypeLink,
                            String methodName)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Return the governance action type that is the first step in a governance action process.

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

firstActionTypeLink - Governance Action Flow relationship (if known)

methodName - calling method

Returns:

properties of the 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)

getFirstActionTypeLink

public Relationship getFirstActionTypeLink(String userId,
                                           String processGUID,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Return the governance action type that is the first step in a governance action process.

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

methodName - calling method

Returns:

properties of the 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)

removeFirstActionType

public void removeFirstActionType(String userId,
                                  String processGUID,
                                  String methodName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Remove the link between a governance process and that governance action type that defines its first step.

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

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)

setupNextActionType

public String setupNextActionType(String userId,
                                  String currentActionTypeGUID,
                                  String nextActionTypeGUID,
                                  String guard,
                                  boolean mandatoryGuard,
                                  boolean ignoreMultipleTriggers,
                                  String methodName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Add a link between two governance action types to show that one follows on from the other when a governance action process is executing.

Parameters:

userId - calling user

currentActionTypeGUID - unique identifier of the governance action type that defines the previous step in the governance action process

nextActionTypeGUID - unique identifier of the governance action type that defines the next step in the governance action process

guard - guard required for this next step to proceed - or null for always run the next step.

mandatoryGuard - means that no next steps can run if this guard is not returned

ignoreMultipleTriggers - prevent multiple instances of the next step to run (or not)

methodName - calling method

Returns:

unique identifier of the new link

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)

updateNextActionType

public void updateNextActionType(String userId,
                                 String nextActionLinkGUID,
                                 String guard,
                                 boolean mandatoryGuard,
                                 boolean ignoreMultipleTriggers,
                                 String methodName)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Update the properties of the link between two governance action types that shows that one follows on from the other when a governance action process is executing.

Parameters:

userId - calling user

nextActionLinkGUID - unique identifier of the relationship between the governance action types

guard - guard required for this next step to proceed - or null for always run the next step.

mandatoryGuard - means that no next steps can run if this guard is not returned

ignoreMultipleTriggers - prevent multiple instances of the next step to run (or not)

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)

getNextGovernanceActionTypes

public List<Relationship> getNextGovernanceActionTypes(String userId,
                                                       String actionTypeGUID,
                                                       int startFrom,
                                                       int pageSize,
                                                       String methodName)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Return the list of next action type defined for the governance action process.

Parameters:

userId - calling user

actionTypeGUID - unique identifier of the current governance action type

startFrom - paging start point

pageSize - maximum results that can be returned

methodName - calling method

Returns:

return the list of relationships and attached governance action types.

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)

removeNextActionType

public void removeNextActionType(String userId,
                                 String actionLinkGUID,
                                 String methodName)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Remove a follow on step from a governance action process.

Parameters:

userId - calling user

actionLinkGUID - unique identifier of the relationship between the governance action types

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)