Package org.odpi.openmetadata.accessservices.dataengine.server.handlers

Class DataEngineTopicHandler

java.lang.Object
org.odpi.openmetadata.accessservices.dataengine.server.handlers.DataEngineTopicHandler
public class DataEngineTopicHandler extends Object
DataEngineTopicHandler manages topic objects. It runs server-side in the DataEngine OMAS and creates and retrieves collections entities through the OMRSRepositoryConnector.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TOPIC_GUID_PARAMETER_NAME
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    DataEngineTopicHandler(org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.commonservices.generichandlers.AssetHandler<org.odpi.openmetadata.accessservices.dataengine.model.Topic> topicHandler, DataEngineRegistrationHandler dataEngineRegistrationHandler, DataEngineCommonHandler dataEngineCommonHandler)
    Construct the handler information needed to interact with the repository services

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail>
    findTopicEntity(String userId, String qualifiedName)
    Find out if the Topic object is already stored in the repository.
    void
    removeTopic(String userId, String topicGUID, String externalSourceName, org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic)
    Remove the topic
    String
    upsertTopic(String userId, org.odpi.openmetadata.accessservices.dataengine.model.Topic topic, String externalSourceName)
    Create or update the topic with event types

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • DataEngineTopicHandler

      public DataEngineTopicHandler(org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.commonservices.generichandlers.AssetHandler<org.odpi.openmetadata.accessservices.dataengine.model.Topic> topicHandler, DataEngineRegistrationHandler dataEngineRegistrationHandler, DataEngineCommonHandler dataEngineCommonHandler)
      Construct the handler information needed to interact with the repository services
      Parameters:
      invalidParameterHandler - handler for managing parameter errors
      topicHandler - provides utilities specific for manipulating topic entities
      dataEngineCommonHandler - provides utilities for manipulating entities
      dataEngineRegistrationHandler - provides utilities for engine entities

  • Method Details

    • upsertTopic

      public String upsertTopic(String userId, org.odpi.openmetadata.accessservices.dataengine.model.Topic topic, String externalSourceName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Create or update the topic with event types
      Parameters:
      userId - the name of the calling user
      topic - the values of the topic
      externalSourceName - the unique name of the external source
      Returns:
      unique identifier of the topic in the repository
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • findTopicEntity

      public Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail> findTopicEntity(String userId, String qualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Find out if the Topic object is already stored in the repository. It uses the fully qualified name to retrieve the entity
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualifiedName name of the process to be searched
      Returns:
      optional with entity details if found, empty optional if not found
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • removeTopic

      public void removeTopic(String userId, String topicGUID, String externalSourceName, org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic) throws org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Remove the topic
      Parameters:
      userId - the name of the calling user
      topicGUID - unique identifier of the topic to be removed
      externalSourceName - the external data engine name
      deleteSemantic - the delete semantic
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server
      org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException - the repository does not support this call.