org.odpi.openmetadata.repositoryservices.events

Class OMRSTypeDefEventProcessor

java.lang.Object

org.odpi.openmetadata.repositoryservices.events.OMRSTypeDefEventProcessor

All Implemented Interfaces:

OMRSTypeDefEventProcessorInterface

public abstract class OMRSTypeDefEventProcessor
extends Object
implements OMRSTypeDefEventProcessorInterface

OMRSTypeDefEventProcessor is an interface implemented by a component that is able to process incoming TypeDef events for an Open Metadata Repository. TypeDef events are used to synchronize TypeDefs across an Open Metadata Repository Cohort.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	eventProcessorName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OMRSTypeDefEventProcessor(String eventProcessorName) Constructor to initialize the name of the processor.

Method Summary

Modifier and Type	Method and Description
String	getEventProcessorName() Return the name of the event processor.
abstract void	processAttributeTypeDefConflictEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, AttributeTypeDef originatorAttributeTypeDef, String otherMetadataCollectionId, AttributeTypeDef conflictingAttributeTypeDef, String errorMessage) Process a detected conflict in the attribute type definitions (AttributeTypeDefs) used in the cohort.
abstract void	processDeletedAttributeTypeDefEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String attributeTypeDefGUID, String attributeTypeDefName) An existing AttributeTypeDef has been deleted in an open metadata repository.
abstract void	processDeletedTypeDefEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String typeDefGUID, String typeDefName) An existing TypeDef has been deleted in an open metadata repository.
abstract void	processNewAttributeTypeDefEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, AttributeTypeDef attributeTypeDef) A new AttributeTypeDef has been defined in an open metadata repository.
abstract void	processNewTypeDefEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, TypeDef typeDef) A new TypeDef has been defined in an open metadata repository.
abstract void	processReIdentifiedAttributeTypeDefEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, AttributeTypeDef originalAttributeTypeDef, AttributeTypeDef attributeTypeDef) Process an event that changes either the name or guid of an AttributeTypeDef.
abstract void	processReIdentifiedTypeDefEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, TypeDefSummary originalTypeDef, TypeDef typeDef) Process an event that changes either the name or guid of a TypeDef.
abstract void	processTypeDefConflictEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, TypeDefSummary originatorTypeDef, String otherMetadataCollectionId, TypeDefSummary conflictingTypeDef, String errorMessage) Process a detected conflict in the type definitions (TypeDefs) used in the cohort.
abstract void	processTypeDefPatchMismatchEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String targetMetadataCollectionId, TypeDefSummary targetTypeDef, TypeDef otherTypeDef, String errorMessage) A TypeDef from another member in the cohort is at a different version than the local repository.
abstract void	processUpdatedTypeDefEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, TypeDefPatch typeDefPatch) An existing TypeDef has been updated in an open metadata repository.
abstract void	sendTypeDefEvent(String sourceName, OMRSTypeDefEvent typeDefEvent) Send the TypeDef event to the OMRS Topic connector (providing TypeDef Events are enabled).

Methods inherited from class java.lang.Object

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

Field Detail

eventProcessorName

protected String eventProcessorName

Constructor Detail

OMRSTypeDefEventProcessor

protected OMRSTypeDefEventProcessor(String eventProcessorName)

Constructor to initialize the name of the processor.

Parameters:

eventProcessorName - string name

Method Detail

getEventProcessorName

public String getEventProcessorName()

Return the name of the event processor.

Returns:

event processor name

sendTypeDefEvent

public abstract void sendTypeDefEvent(String sourceName,
                                      OMRSTypeDefEvent typeDefEvent)

Send the TypeDef event to the OMRS Topic connector (providing TypeDef Events are enabled).

Specified by:

sendTypeDefEvent in interface OMRSTypeDefEventProcessorInterface

Parameters:

sourceName - source of the event

typeDefEvent - properties of the event to send

processNewTypeDefEvent

public abstract void processNewTypeDefEvent(String sourceName,
                                            String originatorMetadataCollectionId,
                                            String originatorServerName,
                                            String originatorServerType,
                                            String originatorOrganizationName,
                                            TypeDef typeDef)

A new TypeDef has been defined in an open metadata repository.

Specified by:

processNewTypeDefEvent in interface OMRSTypeDefEventProcessorInterface

Parameters:

sourceName - name of the source of the event. It may be the cohort name for incoming events or the local repository, or event mapper name.

originatorMetadataCollectionId - unique identifier for the metadata collection hosted by the server that sent the event.

originatorServerName - name of the server that the event came from.

originatorServerType - type of server that the event came from.

originatorOrganizationName - name of the organization that owns the server that sent the event.

typeDef - details of the new TypeDef.

processNewAttributeTypeDefEvent

public abstract void processNewAttributeTypeDefEvent(String sourceName,
                                                     String originatorMetadataCollectionId,
                                                     String originatorServerName,
                                                     String originatorServerType,
                                                     String originatorOrganizationName,
                                                     AttributeTypeDef attributeTypeDef)

A new AttributeTypeDef has been defined in an open metadata repository.

Specified by:

processNewAttributeTypeDefEvent in interface OMRSTypeDefEventProcessorInterface

Parameters:

sourceName - name of the source of the event. It may be the cohort name for incoming events or the local repository, or event mapper name.

originatorMetadataCollectionId - unique identifier for the metadata collection hosted by the server that sent the event.

originatorServerName - name of the server that the event came from.

originatorServerType - type of server that the event came from.

originatorOrganizationName - name of the organization that owns the server that sent the event.

attributeTypeDef - details of the new AttributeTypeDef.

processUpdatedTypeDefEvent

public abstract void processUpdatedTypeDefEvent(String sourceName,
                                                String originatorMetadataCollectionId,
                                                String originatorServerName,
                                                String originatorServerType,
                                                String originatorOrganizationName,
                                                TypeDefPatch typeDefPatch)

An existing TypeDef has been updated in an open metadata repository.

Specified by:

processUpdatedTypeDefEvent in interface OMRSTypeDefEventProcessorInterface

Parameters:

sourceName - name of the source of the event. It may be the cohort name for incoming events or the local repository, or event mapper name.

originatorMetadataCollectionId - unique identifier for the metadata collection hosted by the server that sent the event.

originatorServerName - name of the server that the event came from.

originatorServerType - type of server that the event came from.

originatorOrganizationName - name of the organization that owns the server that sent the event.

typeDefPatch - details of the new version of the TypeDef

processDeletedTypeDefEvent

public abstract void processDeletedTypeDefEvent(String sourceName,
                                                String originatorMetadataCollectionId,
                                                String originatorServerName,
                                                String originatorServerType,
                                                String originatorOrganizationName,
                                                String typeDefGUID,
                                                String typeDefName)

An existing TypeDef has been deleted in an open metadata repository. Both the name and the GUID are provided to ensure the right TypeDef is deleted in other cohort member repositories.

Specified by:

processDeletedTypeDefEvent in interface OMRSTypeDefEventProcessorInterface

Parameters:

sourceName - name of the source of the event. It may be the cohort name for incoming events or the local repository, or event mapper name.

originatorMetadataCollectionId - unique identifier for the metadata collection hosted by the server that sent the event.

originatorServerName - name of the server that the event came from.

originatorServerType - type of server that the event came from.

originatorOrganizationName - name of the organization that owns the server that sent the event.

typeDefGUID - unique identifier of the TypeDef

typeDefName - unique name of the TypeDef

processDeletedAttributeTypeDefEvent

public abstract void processDeletedAttributeTypeDefEvent(String sourceName,
                                                         String originatorMetadataCollectionId,
                                                         String originatorServerName,
                                                         String originatorServerType,
                                                         String originatorOrganizationName,
                                                         String attributeTypeDefGUID,
                                                         String attributeTypeDefName)

An existing AttributeTypeDef has been deleted in an open metadata repository. Both the name and the GUID are provided to ensure the right AttributeTypeDef is deleted in other cohort member repositories.

Specified by:

processDeletedAttributeTypeDefEvent in interface OMRSTypeDefEventProcessorInterface

Parameters:

sourceName - name of the source of the event. It may be the cohort name for incoming events or the local repository, or event mapper name.

originatorMetadataCollectionId - unique identifier for the metadata collection hosted by the server that sent the event.

originatorServerName - name of the server that the event came from.

originatorServerType - type of server that the event came from.

originatorOrganizationName - name of the organization that owns the server that sent the event.

attributeTypeDefGUID - unique identifier of the AttributeTypeDef

attributeTypeDefName - unique name of the AttributeTypeDef

processReIdentifiedTypeDefEvent

public abstract void processReIdentifiedTypeDefEvent(String sourceName,
                                                     String originatorMetadataCollectionId,
                                                     String originatorServerName,
                                                     String originatorServerType,
                                                     String originatorOrganizationName,
                                                     TypeDefSummary originalTypeDef,
                                                     TypeDef typeDef)

Process an event that changes either the name or guid of a TypeDef. It is resolving a Conflicting TypeDef Error.

Specified by:

processReIdentifiedTypeDefEvent in interface OMRSTypeDefEventProcessorInterface

Parameters:

sourceName - name of the source of the event. It may be the cohort name for incoming events or the local repository, or event mapper name.

originatorMetadataCollectionId - unique identifier for the metadata collection hosted by the server that sent the event.

originatorServerName - name of the server that the event came from.

originatorServerType - type of server that the event came from.

originatorOrganizationName - name of the organization that owns the server that sent the event.

originalTypeDef - description of original TypeDef

typeDef - updated TypeDef with new identifiers inside.

processReIdentifiedAttributeTypeDefEvent

public abstract void processReIdentifiedAttributeTypeDefEvent(String sourceName,
                                                              String originatorMetadataCollectionId,
                                                              String originatorServerName,
                                                              String originatorServerType,
                                                              String originatorOrganizationName,
                                                              AttributeTypeDef originalAttributeTypeDef,
                                                              AttributeTypeDef attributeTypeDef)

Process an event that changes either the name or guid of an AttributeTypeDef. It is resolving a Conflicting AttributeTypeDef Error.

Specified by:

processReIdentifiedAttributeTypeDefEvent in interface OMRSTypeDefEventProcessorInterface

Parameters:

sourceName - name of the source of the event. It may be the cohort name for incoming events or the local repository, or event mapper name.

originatorMetadataCollectionId - unique identifier for the metadata collection hosted by the server that sent the event.

originatorServerName - name of the server that the event came from.

originatorServerType - type of server that the event came from.

originatorOrganizationName - name of the organization that owns the server that sent the event.

originalAttributeTypeDef - description of original AttributeTypeDef

attributeTypeDef - updated AttributeTypeDef with new identifiers inside.

processTypeDefConflictEvent

public abstract void processTypeDefConflictEvent(String sourceName,
                                                 String originatorMetadataCollectionId,
                                                 String originatorServerName,
                                                 String originatorServerType,
                                                 String originatorOrganizationName,
                                                 TypeDefSummary originatorTypeDef,
                                                 String otherMetadataCollectionId,
                                                 TypeDefSummary conflictingTypeDef,
                                                 String errorMessage)

Process a detected conflict in the type definitions (TypeDefs) used in the cohort.

Specified by:

processTypeDefConflictEvent in interface OMRSTypeDefEventProcessorInterface

Parameters:

sourceName - name of the source of the event. It may be the cohort name for incoming events or the local repository, or event mapper name.

originatorMetadataCollectionId - unique identifier for the metadata collection hosted by the server that sent the event.

originatorServerName - name of the server that the event came from.

originatorServerType - type of server that the event came from.

originatorOrganizationName - name of the organization that owns the server that sent the event.

originatorTypeDef - description of the TypeDef in the event originator.

otherMetadataCollectionId - the metadataCollection using the conflicting TypeDef.

conflictingTypeDef - description of the TypeDef in the other metadata collection.

errorMessage - details of the error that occurs when the connection is used.

processAttributeTypeDefConflictEvent

public abstract void processAttributeTypeDefConflictEvent(String sourceName,
                                                          String originatorMetadataCollectionId,
                                                          String originatorServerName,
                                                          String originatorServerType,
                                                          String originatorOrganizationName,
                                                          AttributeTypeDef originatorAttributeTypeDef,
                                                          String otherMetadataCollectionId,
                                                          AttributeTypeDef conflictingAttributeTypeDef,
                                                          String errorMessage)

Process a detected conflict in the attribute type definitions (AttributeTypeDefs) used in the cohort.

Specified by:

processAttributeTypeDefConflictEvent in interface OMRSTypeDefEventProcessorInterface

Parameters:

sourceName - name of the source of the event. It may be the cohort name for incoming events or the local repository, or event mapper name.

originatorMetadataCollectionId - unique identifier for the metadata collection hosted by the server that sent the event.

originatorServerName - name of the server that the event came from.

originatorServerType - type of server that the event came from.

originatorOrganizationName - name of the organization that owns the server that sent the event.

originatorAttributeTypeDef - description of the AttributeTypeDef in the event originator.

otherMetadataCollectionId - the metadataCollection using the conflicting AttributeTypeDef.

conflictingAttributeTypeDef - description of the AttributeTypeDef in the other metadata collection.

errorMessage - details of the error that occurs when the connection is used.

processTypeDefPatchMismatchEvent

public abstract void processTypeDefPatchMismatchEvent(String sourceName,
                                                      String originatorMetadataCollectionId,
                                                      String originatorServerName,
                                                      String originatorServerType,
                                                      String originatorOrganizationName,
                                                      String targetMetadataCollectionId,
                                                      TypeDefSummary targetTypeDef,
                                                      TypeDef otherTypeDef,
                                                      String errorMessage)

A TypeDef from another member in the cohort is at a different version than the local repository. This may create some inconsistencies in the different copies of instances of this type in different members of the cohort. The recommended action is to update all TypeDefs to the latest version.

Specified by:

processTypeDefPatchMismatchEvent in interface OMRSTypeDefEventProcessorInterface

Parameters:

sourceName - name of the source of the event. It may be the cohort name for incoming events or the local repository, or event mapper name.

originatorMetadataCollectionId - unique identifier for the metadata collection hosted by the server that sent the event.

originatorServerName - name of the server that the event came from.

originatorServerType - type of server that the event came from.

originatorOrganizationName - name of the organization that owns the server that sent the event.

targetMetadataCollectionId - identifier of the metadata collection that is reporting a TypeDef at a different level to the reporting repository.

targetTypeDef - details of the TypeDef in the target repository.

otherTypeDef - details of the TypeDef in the other repository.

errorMessage - details of the error that occurs when the connection is used.