Package org.odpi.openmetadata.repositoryservices.connectors.omrstopic

Class OMRSTopicListenerBase

java.lang.Object
org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicListenerBase
All Implemented Interfaces:
OMRSTopicListener, OMRSTopicRepositoryEventListener
Direct Known Subclasses:
AssetCatalogOMRSTopicListener, AssetConsumerOMRSTopicListener, AssetManagerOMRSTopicListener, AssetOwnerOMRSTopicListener, CommunityProfileOMRSTopicListener, DataManagerOMRSTopicListener, DataPrivacyOMRSTopicListener, DataScienceOMRSTopicListener, DesignModelOMRSTopicListener, DevOpsOMRSTopicListener, DigitalArchitectureOMRSTopicListener, DigitalServiceOMRSTopicListener, GovernanceEngineOMRSTopicListener, GovernanceServerOMRSTopicListener, ITInfrastructureOMRSTopicListener, ProjectManagementOMRSTopicListener, SecurityManagerOMRSTopicListener, SecurityOfficerOMRSTopicListener, SoftwareDeveloperOMRSTopicListener, StewardshipActionOMRSTopicListener
public class OMRSTopicListenerBase extends Object implements OMRSTopicListener
OMRSTopicListenerBase provides a base class for a topic listener, so it only needs to override the methods for the events it cares about.

  • Field Details

    • serviceName

      protected String serviceName

    • auditLog

      protected AuditLog auditLog

  • Constructor Details

    • OMRSTopicListenerBase

      public OMRSTopicListenerBase(String serviceName)
      Name of the service that this is listening on behalf of.
      Parameters:
      serviceName - name of service

    • OMRSTopicListenerBase

      public OMRSTopicListenerBase(String serviceName, AuditLog auditLog)
      Name of the service that this is listening on behalf of.
      Parameters:
      serviceName - name of service
      auditLog - logging destination

  • Method Details

    • getInstanceTypeName

      protected String getInstanceTypeName(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, InstanceHeader instance, String actionDescription)
      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.
      instance - details of the instance from the event
      actionDescription - description of overall processing
      Returns:
      typeName

    • processRegistryEvent

      public void processRegistryEvent(OMRSRegistryEvent registryEvent)
      Method to pass a Registry event received on topic.
      Specified by:
      processRegistryEvent in interface OMRSTopicListener
      Parameters:
      registryEvent - inbound event

    • processTypeDefEvent

      public void processTypeDefEvent(OMRSTypeDefEvent typeDefEvent)
      Method to pass a TypeDef event received on topic.
      Specified by:
      processTypeDefEvent in interface OMRSTopicRepositoryEventListener
      Parameters:
      typeDefEvent - inbound event

    • processInstanceEvent

      public void processInstanceEvent(OMRSInstanceEvent instanceEvent)
      Method to pass an Instance event received on topic.
      Specified by:
      processInstanceEvent in interface OMRSTopicRepositoryEventListener
      Parameters:
      instanceEvent - inbound event

    • processRegistrationEvent

      protected void processRegistrationEvent(String sourceName, String metadataCollectionId, String metadataCollectionName, String originatorServerName, String originatorServerType, String originatorOrganizationName, Date registrationTimestamp, Connection remoteConnection)
      Introduces a new server/repository to the metadata repository 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.
      metadataCollectionId - unique identifier of metadata collection of originator.
      metadataCollectionName - display name of metadata collection of originator.
      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.
      registrationTimestamp - the time that the server/repository issued the registration request.
      remoteConnection - the Connection properties for the connector used to call the registering server.

    • processRegistrationRefreshRequest

      protected void processRegistrationRefreshRequest(String sourceName, String originatorServerName, String originatorServerType, String originatorOrganizationName)
      Requests that the other servers in the cohort send re-registration 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.
      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.

    • processReRegistrationEvent

      protected void processReRegistrationEvent(String sourceName, String metadataCollectionId, String metadataCollectionName, String originatorServerName, String originatorServerType, String originatorOrganizationName, Date registrationTimestamp, Connection remoteConnection)
      Refreshes the other servers in the cohort with the originating server's registration.
      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.
      metadataCollectionId - unique identifier of metadata collection of originator.
      metadataCollectionName - display name of metadata collection of originator.
      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.
      registrationTimestamp - the time that the server/repository first registered with the cohort.
      remoteConnection - the Connection properties for the connector used to call the registering server.

    • processUnRegistrationEvent

      protected void processUnRegistrationEvent(String sourceName, String metadataCollectionId, String metadataCollectionName, String originatorServerName, String originatorServerType, String originatorOrganizationName)
      A server/repository is being removed from the metadata repository 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.
      metadataCollectionId - unique identifier of metadata collection of originator.
      metadataCollectionName - display name of metadata collection of originator.
      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.

    • processConflictingCollectionIdEvent

      protected void processConflictingCollectionIdEvent(String sourceName, String originatorMetadataCollectionId, String originatorMetadataCollectionName, String originatorServerName, String originatorServerType, String originatorOrganizationName, String conflictingMetadataCollectionId, String errorMessage)
      There is more than one member of the open metadata repository cohort that is using the same metadata collection id. This means that their metadata instances can be updated in more than one server and there is a potential for data integrity issues.
      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 of metadata collection of originator.
      originatorMetadataCollectionName - display name of metadata collection of originator.
      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.
      conflictingMetadataCollectionId - unique identifier for the metadata collection that is registering with the cohort.
      errorMessage - details of the conflict

    • processBadConnectionEvent

      protected void processBadConnectionEvent(String sourceName, String originatorMetadataCollectionId, String originatorMetadataCollectionName, String originatorServerName, String originatorServerType, String originatorOrganizationName, String targetMetadataCollectionId, Connection remoteConnection, String errorMessage)
      A connection to one of the members of the open metadata repository cohort is not usable by one of the members.
      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 of metadata collection of originator.
      originatorMetadataCollectionName - display name of metadata collection of originator.
      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 - id for the repository with the bad remote connection.
      remoteConnection - the Connection properties for the connector used to call the registering server.
      errorMessage - details of the error that occurs when the connection is used.

    • processNewTypeDefEvent

      public void processNewTypeDefEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, TypeDef typeDef)
      A new TypeDef has been defined.
      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 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.
      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 void processUpdatedTypeDefEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, TypeDefPatch typeDefPatch)
      An existing TypeDef 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.
      typeDefPatch - details of the new version of the TypeDef

    • processDeletedTypeDefEvent

      public void processDeletedTypeDefEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String typeDefGUID, String typeDefName)
      An existing TypeDef has been deleted. Both the name and the GUID are provided to ensure the right TypeDef is deleted in 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 of the TypeDef
      typeDefName - unique name of the TypeDef

    • processDeletedAttributeTypeDefEvent

      public 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.
      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 void processReIdentifiedTypeDefEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, TypeDefSummary originalTypeDefSummary, TypeDef typeDef)
      The guid or name of an existing TypeDef has been changed to a new value. This is used if two different Typedefs are discovered to have either the same guid or, most likely, the same name. This type of conflict is rare but typically occurs when a new repository joins 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.
      originalTypeDefSummary - the details for the original TypeDef.
      typeDef - updated TypeDef with new identifiers

    • processReIdentifiedAttributeTypeDefEvent

      public 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.
      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 void processTypeDefConflictEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, TypeDefSummary originatorTypeDefSummary, String otherMetadataCollectionId, TypeDefSummary conflictingTypeDefSummary, String errorMessage)
      Process a detected conflict in type definitions (TypeDefs) used 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.
      originatorTypeDefSummary - details of the TypeDef in the event originator
      otherMetadataCollectionId - the metadataCollection using the conflicting TypeDef
      conflictingTypeDefSummary - the details of the TypeDef in the other metadata collection
      errorMessage - details of the error that occurs when the connection is used.

    • processAttributeTypeDefConflictEvent

      public 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.
      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 void processTypeDefPatchMismatchEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String targetMetadataCollectionId, TypeDefSummary targetTypeDefSummary, 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.
      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 local repository.
      targetTypeDefSummary - details of the TypeDef being patched
      otherTypeDef - details of the TypeDef in the local repository.
      errorMessage - descriptive message

    • processNewEntityEvent

      public 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

      public 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 values for the entity.
      newEntity - details of the new version of the entity.

    • processUndoneEntityEvent

      public 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

      public void processClassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity, Classification classification)
      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. No guarantee this is all the classifications.
      classification - new classification

    • processClassifiedEntityEvent

      public void processClassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityProxy entity, Classification classification)
      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. No guarantee this is all the classifications.
      classification - new classification

    • processClassifiedEntityEvent

      @Deprecated public void processClassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity)
      Deprecated.
      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

      public void processDeclassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity, Classification originalClassification)
      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. No guarantee this is all the classifications.
      originalClassification - classification that was removed

    • processDeclassifiedEntityEvent

      public void processDeclassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityProxy entity, Classification originalClassification)
      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. No guarantee this is all the classifications.
      originalClassification - classification that was removed

    • processDeclassifiedEntityEvent

      @Deprecated public void processDeclassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity)
      Deprecated.
      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

      public void processReclassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity, Classification originalClassification, Classification classification)
      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. No guarantee this is all the classifications.
      originalClassification - classification that was removed
      classification - new classification

    • processReclassifiedEntityEvent

      public void processReclassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityProxy entity, Classification originalClassification, Classification classification)
      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. No guarantee this is all the classifications.
      originalClassification - classification that was removed
      classification - new classification

    • processReclassifiedEntityEvent

      @Deprecated public void processReclassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity)
      Deprecated.
      An existing classification has been changed on an entity. Only implement one of the processReclassifiedEntityEvent methods
      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

      public 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

    • processPurgedEntityEvent

      public 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

      public 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

    • processRestoredEntityEvent

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

    • processReIdentifiedEntityEvent

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

    • processReTypedEntityEvent

      public void processReTypedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, TypeDefSummary originalTypeDefSummary, 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.
      originalTypeDefSummary - original details of this entity's TypeDef.
      entity - new values for this entity, including the new type information.

    • processReHomedEntityEvent

      public 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 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.
      originalHomeMetadataCollectionId - unique identifier for the original home repository.
      entity - new values for this entity, including the new home information.

    • processRefreshEntityRequested

      public void processRefreshEntityRequested(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String typeDefGUID, String typeDefName, String instanceGUID, String homeMetadataCollectionId)
      The remote repository is requesting that an entity from this repository's metadata collection is refreshed so the remote 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

      public 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

      public 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

      public 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

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

    • processDeletedRelationshipEvent

      public 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

      public 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

      public 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

    • processRestoredRelationshipEvent

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

    • processReIdentifiedRelationshipEvent

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

    • processReTypedRelationshipEvent

      public void processReTypedRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, TypeDefSummary originalTypeDefSummary, 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.
      originalTypeDefSummary - original details of this relationship's TypeDef.
      relationship - new values for this relationship, including the new type information.

    • processReHomedRelationshipEvent

      public void processReHomedRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String originalHomeMetadataCollection, 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 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.
      originalHomeMetadataCollection - unique identifier for the original home repository.
      relationship - new values for this relationship, including the new home information.

    • processRefreshRelationshipRequest

      public void processRefreshRelationshipRequest(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String typeDefGUID, String typeDefName, String instanceGUID, String homeMetadataCollectionId)
      A repository has requested the home repository of a relationship send details of the relationship so the local repository 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

      public void processRefreshRelationshipEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, Relationship relationship)
      The local 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

      public 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

      public void processConflictingInstancesEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String targetMetadataCollectionId, TypeDefSummary targetTypeDefSummary, String targetInstanceGUID, String otherMetadataCollectionId, InstanceProvenanceType otherOrigin, TypeDefSummary otherTypeDefSummary, 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
      targetTypeDefSummary - 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
      otherTypeDefSummary - details of the other (older) instance's TypeDef
      otherInstanceGUID - unique identifier for the other (older) instance
      errorMessage - description of the error.

    • processConflictingTypeEvent

      public void processConflictingTypeEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, String targetMetadataCollectionId, TypeDefSummary targetTypeDefSummary, String targetInstanceGUID, TypeDefSummary otherTypeDefSummary, String errorMessage)
      An open metadata repository has detected an inconsistency in the version 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
      targetTypeDefSummary - details of the target instance's TypeDef
      targetInstanceGUID - unique identifier for the source instance
      otherTypeDefSummary - details of the local copy of the instance's TypeDef
      errorMessage - description of the error.