Package org.odpi.openmetadata.commonservices.generichandlers

Class EventTypeHandler<B>

java.lang.Object

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

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

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

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

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

Type Parameters:

B - class that represents the event type

public class EventTypeHandler<B>
extends ReferenceableHandler<B>

EventTypeHandler provides the exchange of metadata about EventType schema types between the repository and the OMAS.

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

EventTypeHandler(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.

Method Summary

Modifier and Type	Method	Description
String	createEventType(String userId, String externalSourceGUID, String externalSourceName, String topicGUID, String topicGUIDParameterName, String qualifiedName, String displayName, String description, String versionNumber, boolean isDeprecated, String author, String usage, String encodingStandard, String namespace, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Create the event type object.
String	createEventTypeFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String topicGUID, String topicGUIDParameterName, String templateGUID, String qualifiedName, String displayName, String description, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Create an event type from a template.
List<B>	findEventTypes(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Retrieve the list of event types metadata elements that contain the search string.
B	getEventTypeByGUID(String userId, String guid, String guidParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Retrieve the event type metadata element with the supplied unique identifier.
List<B>	getEventTypesByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Retrieve the list of event type metadata elements with a matching qualified or display name.
List<B>	getEventTypesForEventSet(String userId, String eventSetGUID, String eventSetGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Return the list of the event types defined in an event set (collection).
List<B>	getEventTypesForTopic(String userId, String topicGUID, String topicGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Retrieve the event types metadata element with the supplied unique identifier.
void	removeEventType(String userId, String externalSourceGUID, String externalSourceName, String eventTypeGUID, String eventTypeGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Remove the metadata element representing an event types.
void	updateEventType(String userId, String externalSourceGUID, String externalSourceName, String eventTypeGUID, String eventTypeGUIDParameterName, String qualifiedName, String displayName, String description, String versionNumber, boolean isDeprecated, String author, String usage, String encodingStandard, String namespace, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName)	Update the event type.

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, getAssignedActors, getAssignmentScope, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getCatalogTemplateList, getCollectionMembers, getCommissionedByStakeholder, getDataFieldValuesClassifiedElement, getDescriptiveElements, getElementsSourceFrom, getEntityByUniqueQualifiedName, getGovernanceActionClassifiedElements, getGovernanceDefinitionScope, getGovernedElements, getMeanings, getMoreInformation, getMoreInformation, getOwnersElements, getReferenceValueAssignees, getResourceList, getRetentionClassifiedElements, getSecurityTagsClassifiedElements, getSemanticAssignments, getSourceElements, getStakeholders, getSubjectAreaMembers, getSubjectAreaMembers, getSupportedByResource, getSupportedByTemplate, getValidValueConsumers, getVendorProperties, linkConsolidatedDuplicate, linkElementsAsPeerDuplicates, removeAssignmentScope, removeCatalogTemplate, removeDataFieldValuesClassification, removeGovernanceActionClassification, removeGovernanceDefinitionScope, removeGovernanceExpectationsClassification, removeGovernanceMeasurementsClassification, removeGovernedBy, removeImplementedBy, removeMoreInformation, removeOwner, removeResourceListMember, removeRetentionClassification, removeSecurityTags, removeSemanticAssignment, removeStakeholder, removeSubjectAreaClassification, removeTemplateClassification, saveCatalogTemplate, saveResourceListMember, saveSemanticAssignment, saveSemanticAssignment, saveSemanticAssignments, setBusinessSignificant, setVendorProperties, unlinkElementsAsPeerDuplicates

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

createBeanFromTemplate, createBeanFromTemplate

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

EventTypeHandler

public EventTypeHandler(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.

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

createEventType

public String createEventType(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String topicGUID,
 String topicGUIDParameterName,
 String qualifiedName,
 String displayName,
 String description,
 String versionNumber,
 boolean isDeprecated,
 String author,
 String usage,
 String encodingStandard,
 String namespace,
 Map<String,String> additionalProperties,
 String suppliedTypeName,
 Map<String,Object> extendedProperties,
 Date effectiveFrom,
 Date effectiveTo,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create the event type object.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

topicGUID - unique identifier of the owning topic

topicGUIDParameterName - parameter supplying topicGUID

qualifiedName - unique name for the event type - used in other configuration

displayName - short display name for the event type

description - description of the event type

versionNumber - version of the schema type.

isDeprecated - is the schema type deprecated

author - name of the author

usage - guidance on how the schema should be used.

encodingStandard - format of the schema

namespace - namespace where the schema is defined.

additionalProperties - additional properties for an event type

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

extendedProperties - properties for an event type subtype

effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)

effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)

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:

unique identifier of the new event type object

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

createEventTypeFromTemplate

public String createEventTypeFromTemplate(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String topicGUID,
 String topicGUIDParameterName,
 String templateGUID,
 String qualifiedName,
 String displayName,
 String description,
 Date effectiveFrom,
 Date effectiveTo,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create an event type from a template.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

topicGUID - unique identifier of the owning topic

topicGUIDParameterName - parameter supplying topicGUID

templateGUID - unique identifier of the metadata element to copy

qualifiedName - unique name for the event type - used in other configuration

displayName - short display name for the event type

description - description of the event type

effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)

effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)

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:

unique identifier of the new 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)

updateEventType

public void updateEventType(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String eventTypeGUID,
 String eventTypeGUIDParameterName,
 String qualifiedName,
 String displayName,
 String description,
 String versionNumber,
 boolean isDeprecated,
 String author,
 String usage,
 String encodingStandard,
 String namespace,
 Map<String,String> additionalProperties,
 String suppliedTypeName,
 Map<String,Object> extendedProperties,
 Date effectiveFrom,
 Date effectiveTo,
 boolean isMergeUpdate,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the event type.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

eventTypeGUID - unique identifier for the event type to update

eventTypeGUIDParameterName - parameter supplying the event type

qualifiedName - unique name for the event type - used in other configuration

displayName - short display name for the event type

description - description of the governance event type

versionNumber - version of the schema type.

isDeprecated - is the schema type deprecated

author - name of the author

usage - guidance on how the schema should be used.

encodingStandard - format of the schema.

namespace - namespace where the schema is defined.

additionalProperties - additional properties for an event type

suppliedTypeName - type of term

extendedProperties - properties for a governance event type subtype

isMergeUpdate - are unspecified properties unchanged (true) or removed?

effectiveFrom - the time that the relationship element must be effective from (null for any time, new Date() for now)

effectiveTo - the time that the relationship must be effective to (null for any time, new Date() for now)

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

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeEventType

public void removeEventType(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String eventTypeGUID,
 String eventTypeGUIDParameterName,
 String qualifiedName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing an event types.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

eventTypeGUID - unique identifier of the metadata element to remove

eventTypeGUIDParameterName - parameter for eventTypeGUID

qualifiedName - validating property

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

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)

findEventTypes

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

Retrieve the list of event types 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

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

getEventTypesForEventSet

public List<B> getEventTypesForEventSet(String userId,
 String eventSetGUID,
 String eventSetGUIDParameterName,
 int startFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of the event types defined in an event set (collection).

Parameters:

userId - calling user

eventSetGUID - unique identifier of the event set to query

eventSetGUIDParameterName - name of the parameter supplying eventSetGUID

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?

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 metadata elements describing the event types associated with the requested event set

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)

getEventTypesByName

public List<B> getEventTypesByName(String userId,
 String name,
 String nameParameterName,
 int startFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of event 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 - parameter supplying name

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?

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)

getEventTypesForTopic

public List<B> getEventTypesForTopic(String userId,
 String topicGUID,
 String topicGUIDParameterName,
 int startFrom,
 int pageSize,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the event types metadata element with the supplied unique identifier.

Parameters:

userId - calling user

topicGUID - unique identifier of the requested metadata element

topicGUIDParameterName - parameter name of the topicGUID

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?

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 event types 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)

getEventTypeByGUID

public B getEventTypeByGUID(String userId,
 String guid,
 String guidParameterName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 String methodName)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the event type metadata element with the supplied unique identifier.

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

guidParameterName - parameter name of guid

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:

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