org.odpi.openmetadata.repositoryservices.events

Interface OMRSInstanceEventProcessorInterface

All Known Implementing Classes:

OMRSInstanceEventProcessor, OMRSRepositoryEventProcessor

public interface OMRSInstanceEventProcessorInterface

OMRSInstanceEventProcessor is an interface implemented by a component that is able to process incoming metadata instance events for an Open Metadata Repository. Instance events are used to replicate metadata instances across an Open Metadata Repository Cohort.

Method Summary

Modifier and Type	Method and Description
void	processClassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity) A new classification has been added to an entity.
void	processConflictingInstancesEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String targetMetadataCollectionId, TypeDefSummary targetTypeDef, String targetInstanceGUID, String otherMetadataCollectionId, InstanceProvenanceType otherOrigin, TypeDefSummary otherTypeDef, String otherInstanceGUID, String errorMessage) An open metadata repository has detected two metadata instances with the same identifier (guid).
void	processConflictingTypeEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String targetMetadataCollectionId, TypeDefSummary targetTypeDef, String targetInstanceGUID, TypeDefSummary otherTypeDef, String errorMessage) An open metadata repository has detected an inconsistency in the version number of the type used in an updated metadata instance compared to its stored version.
void	processDeclassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity) A classification has been removed from an entity.
void	processDeletedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity) An existing entity has been deleted.
void	processDeletedRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, Relationship relationship) An existing relationship has been deleted.
void	processDeletePurgedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity) An existing entity has been deleted and purged in a single action.
void	processDeletePurgedRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, Relationship relationship) An active relationship has been deleted and purged from the repository.
void	processInstanceBatchEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, InstanceGraph instances) An open metadata repository is passing information about a collection of entities and relationships with the other repositories in the cohort.
void	processNewEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity) A new entity has been created.
void	processNewRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, Relationship relationship) A new relationship has been created.
void	processPurgedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity) An entity has been permanently removed from the repository.
void	processPurgedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String typeDefGUID, String typeDefName, String instanceGUID) A deleted entity has been permanently removed from the repository.
void	processPurgedRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, Relationship relationship) A relationship has been permanently removed from the repository.
void	processPurgedRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String typeDefGUID, String typeDefName, String instanceGUID) A deleted relationship has been permanently removed from the repository.
void	processReclassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity) An existing classification has been changed on an entity.
void	processRefreshEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity) A remote repository in the cohort has sent entity details in response to a refresh request.
void	processRefreshEntityRequested(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String typeDefGUID, String typeDefName, String instanceGUID, String homeMetadataCollectionId) The local repository is requesting that an entity from another repository's metadata collection is refreshed so the local repository can create a reference copy.
void	processRefreshRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, Relationship relationship) An open metadata repository is refreshing the information about a relationship for the other repositories in the cohort.
void	processRefreshRelationshipRequest(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String typeDefGUID, String typeDefName, String instanceGUID, String homeMetadataCollectionId) An open metadata repository has requested the home repository of a relationship send details of the relationship so its local metadata collection can create a reference copy of the instance.
void	processReHomedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String originalHomeMetadataCollectionId, EntityDetail entity) An existing entity has changed home repository.
void	processReHomedRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String originalHomeMetadataCollectionId, Relationship relationship) An existing relationship has changed home repository.
void	processReIdentifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String originalEntityGUID, EntityDetail entity) The guid of an existing entity has been changed to a new value.
void	processReIdentifiedRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String originalRelationshipGUID, Relationship relationship) The guid of an existing relationship has changed.
void	processRestoredEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity) A deleted entity has been restored to the state it was before it was deleted.
void	processRestoredRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, Relationship relationship) A deleted relationship has been restored to the state it was before it was deleted.
void	processReTypedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, TypeDefSummary originalTypeDef, EntityDetail entity) An existing entity has had its type changed.
void	processReTypedRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, TypeDefSummary originalTypeDef, Relationship relationship) An existing relationship has had its type changed.
void	processUndoneEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity) An update to an entity has been undone.
void	processUndoneRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, Relationship relationship) An update to a relationship has been undone.
void	processUpdatedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail oldEntity, EntityDetail newEntity) An existing entity has been updated.
void	processUpdatedRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, Relationship oldRelationship, Relationship newRelationship) An existing relationship has been updated.
void	sendInstanceEvent(String sourceName, OMRSInstanceEvent instanceEvent) Process the instance event directly.

Method Detail

sendInstanceEvent

void sendInstanceEvent(String sourceName,
                       OMRSInstanceEvent instanceEvent)

Process the instance event directly.

Parameters:

sourceName - source of the event

instanceEvent - properties of the event to send

processNewEntityEvent

void processNewEntityEvent(String sourceName,
                           String originatorMetadataCollectionId,
                           String originatorServerName,
                           String originatorServerType,
                           String originatorOrganizationName,
                           EntityDetail entity)

A new entity has been created.

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.

entity - details of the new entity

processUpdatedEntityEvent

void processUpdatedEntityEvent(String sourceName,
                               String originatorMetadataCollectionId,
                               String originatorServerName,
                               String originatorServerType,
                               String originatorOrganizationName,
                               EntityDetail oldEntity,
                               EntityDetail newEntity)

An existing entity has been updated.

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.

oldEntity - original entity before update.

newEntity - details of the new version of the entity.

processUndoneEntityEvent

void processUndoneEntityEvent(String sourceName,
                              String originatorMetadataCollectionId,
                              String originatorServerName,
                              String originatorServerType,
                              String originatorOrganizationName,
                              EntityDetail entity)

An update to an entity has been undone.

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.

entity - details of the version of the entity that has been restored.

processClassifiedEntityEvent

void processClassifiedEntityEvent(String sourceName,
                                  String originatorMetadataCollectionId,
                                  String originatorServerName,
                                  String originatorServerType,
                                  String originatorOrganizationName,
                                  EntityDetail entity)

A new classification has been added to an entity.

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.

entity - details of the entity with the new classification added.

processDeclassifiedEntityEvent

void processDeclassifiedEntityEvent(String sourceName,
                                    String originatorMetadataCollectionId,
                                    String originatorServerName,
                                    String originatorServerType,
                                    String originatorOrganizationName,
                                    EntityDetail entity)

A classification has been removed from an entity.

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.

entity - details of the entity after the classification has been removed.

processReclassifiedEntityEvent

void processReclassifiedEntityEvent(String sourceName,
                                    String originatorMetadataCollectionId,
                                    String originatorServerName,
                                    String originatorServerType,
                                    String originatorOrganizationName,
                                    EntityDetail entity)

An existing classification has been changed on an entity.

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.

entity - details of the entity after the classification has been changed.

processDeletedEntityEvent

void processDeletedEntityEvent(String sourceName,
                               String originatorMetadataCollectionId,
                               String originatorServerName,
                               String originatorServerType,
                               String originatorOrganizationName,
                               EntityDetail entity)

An existing entity has been deleted. This is a soft delete. This means it is still in the repository but it is no longer returned on queries. All relationships to the entity are also soft-deleted and will no longer be usable. These deleted relationships will be notified through separate events. Details of the TypeDef are included with the entity's unique id (guid) to ensure the right entity is deleted in the remote repositories.

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.

entity - deleted entity

processRestoredEntityEvent

void processRestoredEntityEvent(String sourceName,
                                String originatorMetadataCollectionId,
                                String originatorServerName,
                                String originatorServerType,
                                String originatorOrganizationName,
                                EntityDetail entity)

A deleted entity has been restored to the state it was before it was deleted.

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.

entity - details of the version of the entity that has been restored.

processPurgedEntityEvent

void processPurgedEntityEvent(String sourceName,
                              String originatorMetadataCollectionId,
                              String originatorServerName,
                              String originatorServerType,
                              String originatorOrganizationName,
                              EntityDetail entity)

An entity has been permanently removed from the repository. This request can not be undone.

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.

entity - details of the version of the entity that has been purged.

processPurgedEntityEvent

void processPurgedEntityEvent(String sourceName,
                              String originatorMetadataCollectionId,
                              String originatorServerName,
                              String originatorServerType,
                              String originatorOrganizationName,
                              String typeDefGUID,
                              String typeDefName,
                              String instanceGUID)

A deleted entity has been permanently removed from the repository. This request can not be undone. Details of the TypeDef are included with the entity's unique id (guid) to ensure the right entity is purged in the remote repositories.

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 for this entity's TypeDef

typeDefName - name of this entity's TypeDef

instanceGUID - unique identifier for the entity

processDeletePurgedEntityEvent

void processDeletePurgedEntityEvent(String sourceName,
                                    String originatorMetadataCollectionId,
                                    String originatorServerName,
                                    String originatorServerType,
                                    String originatorOrganizationName,
                                    EntityDetail entity)

An existing entity has been deleted and purged in a single action. All relationships to the entity are also deleted and purged and will no longer be usable. These deleted relationships will be notified through separate events.

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.

entity - deleted entity

processReTypedEntityEvent

void processReTypedEntityEvent(String sourceName,
                               String originatorMetadataCollectionId,
                               String originatorServerName,
                               String originatorServerType,
                               String originatorOrganizationName,
                               TypeDefSummary originalTypeDef,
                               EntityDetail entity)

An existing entity has had its type changed. Typically this action is taken to move an entity's type to either a super type (so the subtype can be deleted) or a new subtype (so additional properties can be added.) However, the type can be changed to any compatible type.

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 this entity's original TypeDef.

entity - new values for this entity, including the new type information.

processReHomedEntityEvent

void processReHomedEntityEvent(String sourceName,
                               String originatorMetadataCollectionId,
                               String originatorServerName,
                               String originatorServerType,
                               String originatorOrganizationName,
                               String originalHomeMetadataCollectionId,
                               EntityDetail entity)

An existing entity has changed home repository. This action is taken for example, if a repository becomes permanently unavailable, or if the user community updating this entity move to working from a different repository in the open metadata repository cluster.

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.

originalHomeMetadataCollectionId - unique identifier for the original home metadata collection/repository.

entity - new values for this entity, including the new home information.

processReIdentifiedEntityEvent

void processReIdentifiedEntityEvent(String sourceName,
                                    String originatorMetadataCollectionId,
                                    String originatorServerName,
                                    String originatorServerType,
                                    String originatorOrganizationName,
                                    String originalEntityGUID,
                                    EntityDetail entity)

The guid of an existing entity has been changed to a new value. This is used if two different entities are discovered to have the same guid. This is extremely unlikely but not impossible so the open metadata protocol has provision for this.

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.

originalEntityGUID - the existing identifier for the entity.

entity - new values for this entity, including the new guid.

processRefreshEntityRequested

void processRefreshEntityRequested(String sourceName,
                                   String originatorMetadataCollectionId,
                                   String originatorServerName,
                                   String originatorServerType,
                                   String originatorOrganizationName,
                                   String typeDefGUID,
                                   String typeDefName,
                                   String instanceGUID,
                                   String homeMetadataCollectionId)

The local repository is requesting that an entity from another repository's metadata collection is refreshed so the local repository can create a reference copy.

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 for this entity's TypeDef

typeDefName - name of this entity's TypeDef

instanceGUID - unique identifier for the entity

homeMetadataCollectionId - metadata collection id for the home of this instance.

processRefreshEntityEvent

void processRefreshEntityEvent(String sourceName,
                               String originatorMetadataCollectionId,
                               String originatorServerName,
                               String originatorServerType,
                               String originatorOrganizationName,
                               EntityDetail entity)

A remote repository in the cohort has sent entity details in response to a refresh request.

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.

entity - details of the requested entity

processNewRelationshipEvent

void processNewRelationshipEvent(String sourceName,
                                 String originatorMetadataCollectionId,
                                 String originatorServerName,
                                 String originatorServerType,
                                 String originatorOrganizationName,
                                 Relationship relationship)

A new relationship has been created.

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.

relationship - details of the new relationship

processUpdatedRelationshipEvent

void processUpdatedRelationshipEvent(String sourceName,
                                     String originatorMetadataCollectionId,
                                     String originatorServerName,
                                     String originatorServerType,
                                     String originatorOrganizationName,
                                     Relationship oldRelationship,
                                     Relationship newRelationship)

An existing relationship has been updated.

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.

oldRelationship - original details of the relationship.

newRelationship - details of the new version of the relationship.

processUndoneRelationshipEvent

void processUndoneRelationshipEvent(String sourceName,
                                    String originatorMetadataCollectionId,
                                    String originatorServerName,
                                    String originatorServerType,
                                    String originatorOrganizationName,
                                    Relationship relationship)

An update to a relationship has been undone.

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.

relationship - details of the version of the relationship that has been restored.

processRestoredRelationshipEvent

void processRestoredRelationshipEvent(String sourceName,
                                      String originatorMetadataCollectionId,
                                      String originatorServerName,
                                      String originatorServerType,
                                      String originatorOrganizationName,
                                      Relationship relationship)

A deleted relationship has been restored to the state it was before it was deleted.

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.

relationship - details of the version of the relationship that has been restored.

processDeletedRelationshipEvent

void processDeletedRelationshipEvent(String sourceName,
                                     String originatorMetadataCollectionId,
                                     String originatorServerName,
                                     String originatorServerType,
                                     String originatorOrganizationName,
                                     Relationship relationship)

An existing relationship has been deleted. This is a soft delete. This means it is still in the repository but it is no longer returned on queries. Details of the TypeDef are included with the relationship's unique id (guid) to ensure the right relationship is deleted in the remote repositories.

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.

relationship - deleted relationship

processPurgedRelationshipEvent

void processPurgedRelationshipEvent(String sourceName,
                                    String originatorMetadataCollectionId,
                                    String originatorServerName,
                                    String originatorServerType,
                                    String originatorOrganizationName,
                                    Relationship relationship)

A relationship has been permanently removed from the repository. This request can not be undone.

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.

relationship - details of the relationship that has been purged.

processPurgedRelationshipEvent

void processPurgedRelationshipEvent(String sourceName,
                                    String originatorMetadataCollectionId,
                                    String originatorServerName,
                                    String originatorServerType,
                                    String originatorOrganizationName,
                                    String typeDefGUID,
                                    String typeDefName,
                                    String instanceGUID)

A deleted relationship has been permanently removed from the repository. This request can not be undone. Details of the TypeDef are included with the relationship's unique id (guid) to ensure the right relationship is purged in the remote repositories.

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 for this relationship's TypeDef.

typeDefName - name of this relationship's TypeDef.

instanceGUID - unique identifier for the relationship.

processDeletePurgedRelationshipEvent

void processDeletePurgedRelationshipEvent(String sourceName,
                                          String originatorMetadataCollectionId,
                                          String originatorServerName,
                                          String originatorServerType,
                                          String originatorOrganizationName,
                                          Relationship relationship)

An active relationship has been deleted and purged from the repository. This request can not be undone.

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.

relationship - deleted relationship

processReTypedRelationshipEvent

void processReTypedRelationshipEvent(String sourceName,
                                     String originatorMetadataCollectionId,
                                     String originatorServerName,
                                     String originatorServerType,
                                     String originatorOrganizationName,
                                     TypeDefSummary originalTypeDef,
                                     Relationship relationship)

An existing relationship has had its type changed. Typically this action is taken to move a relationship's type to either a super type (so the subtype can be deleted) or a new subtype (so additional properties can be added.) However, the type can be changed to any compatible type.

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 this relationship's original TypeDef.

relationship - new values for this relationship, including the new type information.

processReHomedRelationshipEvent

void processReHomedRelationshipEvent(String sourceName,
                                     String originatorMetadataCollectionId,
                                     String originatorServerName,
                                     String originatorServerType,
                                     String originatorOrganizationName,
                                     String originalHomeMetadataCollectionId,
                                     Relationship relationship)

An existing relationship has changed home repository. This action is taken for example, if a repository becomes permanently unavailable, or if the user community updating this relationship move to working from a different repository in the open metadata repository cluster.

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.

originalHomeMetadataCollectionId - unique identifier for the original home repository.

relationship - new values for this relationship, including the new home information.

processReIdentifiedRelationshipEvent

void processReIdentifiedRelationshipEvent(String sourceName,
                                          String originatorMetadataCollectionId,
                                          String originatorServerName,
                                          String originatorServerType,
                                          String originatorOrganizationName,
                                          String originalRelationshipGUID,
                                          Relationship relationship)

The guid of an existing relationship has changed. This is used if two different relationships are discovered to have the same guid. This is extremely unlikely but not impossible so the open metadata protocol has provision for this.

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.

originalRelationshipGUID - the existing identifier for the relationship.

relationship - new values for this relationship, including the new guid.

processRefreshRelationshipRequest

void processRefreshRelationshipRequest(String sourceName,
                                       String originatorMetadataCollectionId,
                                       String originatorServerName,
                                       String originatorServerType,
                                       String originatorOrganizationName,
                                       String typeDefGUID,
                                       String typeDefName,
                                       String instanceGUID,
                                       String homeMetadataCollectionId)

An open metadata repository has requested the home repository of a relationship send details of the relationship so its local metadata collection can create a reference copy of the instance.

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 for this instance's TypeDef

typeDefName - name of this relationship's TypeDef

instanceGUID - unique identifier for the instance

homeMetadataCollectionId - metadata collection id for the home of this instance.

processRefreshRelationshipEvent

void processRefreshRelationshipEvent(String sourceName,
                                     String originatorMetadataCollectionId,
                                     String originatorServerName,
                                     String originatorServerType,
                                     String originatorOrganizationName,
                                     Relationship relationship)

An open metadata repository is refreshing the information about a relationship for the other repositories in the cohort.

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.

relationship - relationship details

processInstanceBatchEvent

void processInstanceBatchEvent(String sourceName,
                               String originatorMetadataCollectionId,
                               String originatorServerName,
                               String originatorServerType,
                               String originatorOrganizationName,
                               InstanceGraph instances)

An open metadata repository is passing information about a collection of entities and relationships with the other repositories in the cohort.

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.

instances - multiple entities and relationships for sharing.

processConflictingInstancesEvent

void processConflictingInstancesEvent(String sourceName,
                                      String originatorMetadataCollectionId,
                                      String originatorServerName,
                                      String originatorServerType,
                                      String originatorOrganizationName,
                                      String targetMetadataCollectionId,
                                      TypeDefSummary targetTypeDef,
                                      String targetInstanceGUID,
                                      String otherMetadataCollectionId,
                                      InstanceProvenanceType otherOrigin,
                                      TypeDefSummary otherTypeDef,
                                      String otherInstanceGUID,
                                      String errorMessage)

An open metadata repository has detected two metadata instances with the same identifier (guid). This is a serious error because it could lead to corruption of the metadata collections within the cohort. When this occurs, all repositories in the cohort delete their reference copies of the metadata instances and at least one of the instances has its GUID changed in its respective home repository. The updated instance(s) are redistributed around the cohort.

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 - metadata collection id of the repository reporting the conflicting instance

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 - metadata collection id of other repository with the conflicting instance

targetTypeDef - details of the target instance's TypeDef

targetInstanceGUID - unique identifier for the source instance

otherOrigin - origin of the other (older) metadata instance

otherMetadataCollectionId - metadata collection of the other (older) metadata instance

otherTypeDef - details of the other (older) instance's TypeDef

otherInstanceGUID - unique identifier for the other (older) instance

errorMessage - description of the error.

processConflictingTypeEvent

void processConflictingTypeEvent(String sourceName,
                                 String originatorMetadataCollectionId,
                                 String originatorServerName,
                                 String originatorServerType,
                                 String originatorOrganizationName,
                                 String targetMetadataCollectionId,
                                 TypeDefSummary targetTypeDef,
                                 String targetInstanceGUID,
                                 TypeDefSummary otherTypeDef,
                                 String errorMessage)

An open metadata repository has detected an inconsistency in the version number of the type used in an updated metadata instance compared to its stored version.

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 - metadata collection id of the repository reporting the conflicting instance

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 - metadata collection id of other repository with the conflicting instance

targetTypeDef - description of the target instance's TypeDef

targetInstanceGUID - unique identifier for the source instance

otherTypeDef - details of the other (older) instance's TypeDef

errorMessage - description of the error.