org.odpi.openmetadata.accessservices.discoveryengine.outtopic

Class DiscoveryEngineOMRSTopicListener

java.lang.Object

org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicListenerBase

org.odpi.openmetadata.accessservices.discoveryengine.outtopic.DiscoveryEngineOMRSTopicListener

All Implemented Interfaces:

OMRSTopicListener

public class DiscoveryEngineOMRSTopicListener
extends OMRSTopicListenerBase

DiscoveryEngineOMRSTopicListener is the listener that registers with the repository services (OMRS) to monitor changes to the metadata. This class is looking for changes to the discovery engines and discovery services configuration. When it detects an appropriate change it passes the update to the DiscoveryEngineOutTopicPublisher to publish a DiscoveryEngineEvent describing the change. These events are picked up by the Engine Host Server (See Asset Analysis OMES) to control the configuration of the discovery engines it is hosting.

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicListenerBase

auditLog, serviceName

Constructor Summary

Constructors

Constructor and Description
DiscoveryEngineOMRSTopicListener(String serviceName, DiscoveryEnginePublisher eventPublisher, OMRSRepositoryHelper repositoryHelper, AuditLog auditLog) Initialize the topic listener.

Method Summary

Modifier and Type	Method and Description
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.
void	processDeclassifiedEntityEvent(String sourceName, String originatorMetadataCollectionId, String originatorServerName, String originatorServerType, String originatorOrganizationName, EntityDetail entity, Classification originalClassification) 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	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.
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	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.

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicListenerBase

getInstanceTypeName, processAttributeTypeDefConflictEvent, processBadConnectionEvent, processClassifiedEntityEvent, processConflictingCollectionIdEvent, processConflictingInstancesEvent, processConflictingTypeEvent, processDeclassifiedEntityEvent, processDeletedAttributeTypeDefEvent, processDeletedTypeDefEvent, processInstanceEvent, processNewAttributeTypeDefEvent, processNewTypeDefEvent, processPurgedEntityEvent, processPurgedRelationshipEvent, processReclassifiedEntityEvent, processRefreshEntityEvent, processRefreshEntityRequested, processRefreshRelationshipEvent, processRefreshRelationshipRequest, processRegistrationEvent, processRegistrationRefreshRequest, processRegistryEvent, processReHomedEntityEvent, processReHomedRelationshipEvent, processReIdentifiedAttributeTypeDefEvent, processReIdentifiedEntityEvent, processReIdentifiedRelationshipEvent, processReIdentifiedTypeDefEvent, processReRegistrationEvent, processReTypedEntityEvent, processReTypedRelationshipEvent, processTypeDefConflictEvent, processTypeDefEvent, processTypeDefPatchMismatchEvent, processUnRegistrationEvent, processUpdatedTypeDefEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoveryEngineOMRSTopicListener

public DiscoveryEngineOMRSTopicListener(String serviceName,
                                        DiscoveryEnginePublisher eventPublisher,
                                        OMRSRepositoryHelper repositoryHelper,
                                        AuditLog auditLog)

Initialize the topic listener.

Parameters:

serviceName - this is the full name of the service - used for error logging in base class

eventPublisher - this is the out topic publisher.

repositoryHelper - repository helper

auditLog - logging destination

Method Detail

processNewEntityEvent

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

A new entity has been created.

Overrides:

processNewEntityEvent in class OMRSTopicListenerBase

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.

Overrides:

processUpdatedEntityEvent in class OMRSTopicListenerBase

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.

Overrides:

processUndoneEntityEvent in class OMRSTopicListenerBase

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.

Overrides:

processClassifiedEntityEvent in class OMRSTopicListenerBase

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 of the classifications.

classification - new classification

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.

Overrides:

processDeclassifiedEntityEvent in class OMRSTopicListenerBase

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 of the classifications.

originalClassification - classification that was 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.

Overrides:

processReclassifiedEntityEvent in class OMRSTopicListenerBase

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 of the classifications.

originalClassification - classification that was removed

classification - new classification

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.

Overrides:

processDeletedEntityEvent in class OMRSTopicListenerBase

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

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.

Overrides:

processDeletePurgedEntityEvent in class OMRSTopicListenerBase

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.

Overrides:

processRestoredEntityEvent in class OMRSTopicListenerBase

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.

processNewRelationshipEvent

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

A new relationship has been created.

Overrides:

processNewRelationshipEvent in class OMRSTopicListenerBase

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.

Overrides:

processUpdatedRelationshipEvent in class OMRSTopicListenerBase

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.

Overrides:

processUndoneRelationshipEvent in class OMRSTopicListenerBase

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.

Overrides:

processDeletedRelationshipEvent in class OMRSTopicListenerBase

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

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.

Overrides:

processDeletePurgedRelationshipEvent in class OMRSTopicListenerBase

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.

Overrides:

processRestoredRelationshipEvent in class OMRSTopicListenerBase

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.

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.

Overrides:

processInstanceBatchEvent in class OMRSTopicListenerBase

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.