Class DataEngineEventClient

java.lang.Object
org.odpi.openmetadata.accessservices.dataengine.client.DataEngineEventClient
All Implemented Interfaces:
DataEngineClient

public class DataEngineEventClient extends Object implements DataEngineClient
DataEngineEventClient implements Data Engine client side events interface using provided topic connector. For more information see DataEngineClient interface definition.
  • Constructor Details

    • DataEngineEventClient

      public DataEngineEventClient(org.odpi.openmetadata.accessservices.dataengine.connectors.intopic.DataEngineInTopicClientConnector dataEngineInTopicClientConnector)
      Constructor to create DataEngineEventClient with unauthenticated access to the server
      Parameters:
      dataEngineInTopicClientConnector - topic connector used to publish to InTopic
  • Method Details

    • getDeleteSemantic

      public org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic getDeleteSemantic()
      Gets the DeleteSemantic
      Returns:
      deleteSemantic used by the client for deletes
    • setDeleteSemantic

      public void setDeleteSemantic(org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic)
      Sets the DeleteSemantic for the client
    • createOrUpdateProcess

      public String createOrUpdateProcess(String userId, org.odpi.openmetadata.accessservices.dataengine.model.Process process) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Description copied from interface: DataEngineClient
      Create or update the process, with all the ports, schema types and corresponding relationships including the process hierarchy relationship.
      Specified by:
      createOrUpdateProcess in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      process - the process
      Returns:
      unique identifier of the process in the repository
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • deleteProcess

      public void deleteProcess(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Description copied from interface: DataEngineClient
      Delete a process
      Specified by:
      deleteProcess in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of the process to be deleted
      guid - the unique identifier of the process to be deleted
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • createExternalDataEngine

      public String createExternalDataEngine(String userId, org.odpi.openmetadata.accessservices.dataengine.model.Engine engine) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Create or update the engine entity
      Specified by:
      createExternalDataEngine in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      engine - the engine bean
      Returns:
      unique identifier of the server in the repository
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • deleteExternalDataEngine

      public void deleteExternalDataEngine(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Delete the external data engine
      Specified by:
      deleteExternalDataEngine in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of the external data engine
      guid - the unique identifier of the external data engine
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • createOrUpdateSchemaType

      public String createOrUpdateSchemaType(String userId, org.odpi.openmetadata.accessservices.dataengine.model.SchemaType schemaType) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Create or update the schema type entity, with the corresponding schema attributes and relationships
      Specified by:
      createOrUpdateSchemaType in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      schemaType - the schema type bean
      Returns:
      unique identifier of the schema type in the repository
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • deleteSchemaType

      public void deleteSchemaType(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Delete the schema type
      Specified by:
      deleteSchemaType in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of the schema type
      guid - the unique identifier of the schema type
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • createOrUpdatePortImplementation

      public String createOrUpdatePortImplementation(String userId, org.odpi.openmetadata.accessservices.dataengine.model.PortImplementation portImplementation, String processQualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Create or update the port implementation entity,with the corresponding schema type and port schema relationship. It attaches the port implementation to the provided process
      Specified by:
      createOrUpdatePortImplementation in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      portImplementation - the port implementation bean
      processQualifiedName - the process qualified name
      Returns:
      unique identifier of the port implementation in the repository
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • deletePortImplementation

      public void deletePortImplementation(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Delete the port implementation
      Specified by:
      deletePortImplementation in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of port implementation
      guid - the unique identifier of the port implementation
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • addProcessHierarchy

      public String addProcessHierarchy(String userId, org.odpi.openmetadata.accessservices.dataengine.model.ProcessHierarchy processHierarchy) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Add a ProcessHierarchy relationship to a process
      Specified by:
      addProcessHierarchy in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      processHierarchy - the process hierarchy bean
      Returns:
      the unique identifier (guid) of the child of the process hierarchy that was updated
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • addDataFlows

      public void addDataFlows(String userId, List<org.odpi.openmetadata.accessservices.dataengine.model.DataFlow> dataFlows) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Add data flow relationships between entities
      Specified by:
      addDataFlows in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      dataFlows - list of data flows
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • setExternalSourceName

      public void setExternalSourceName(String externalSourceName)
      Sets external source system name using the data engine client
      Specified by:
      setExternalSourceName in interface DataEngineClient
      Parameters:
      externalSourceName - Source system name
    • getExternalSourceName

      public String getExternalSourceName()
      Returns the name of the source system using data engine client
      Specified by:
      getExternalSourceName in interface DataEngineClient
      Returns:
      Source system name
    • upsertDatabase

      public String upsertDatabase(String userId, org.odpi.openmetadata.accessservices.dataengine.model.Database database) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Create or update the database entity
      Specified by:
      upsertDatabase in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      database - the database bean
      Returns:
      unique identifier of database in the repository
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - internal problem with the connector
    • upsertDatabaseSchema

      public String upsertDatabaseSchema(String userId, org.odpi.openmetadata.accessservices.dataengine.model.DatabaseSchema databaseSchema, String databaseQualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Create or update the database schema entity
      Specified by:
      upsertDatabaseSchema in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      databaseSchema - the database schema bean
      databaseQualifiedName - the qualified name of the database, in case it is known
      Returns:
      unique identifier of database schema in the repository
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - internal problem with the connector
    • upsertRelationalTable

      public String upsertRelationalTable(String userId, org.odpi.openmetadata.accessservices.dataengine.model.RelationalTable relationalTable, String databaseSchemaQualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Create or update the relational table entity
      Specified by:
      upsertRelationalTable in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      relationalTable - the relational table bean
      databaseSchemaQualifiedName - the qualified name of the database schema to which it will be related
      Returns:
      unique identifier of the relational table in the repository
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - internal problem with the connector
    • upsertDataFile

      public String upsertDataFile(String userId, org.odpi.openmetadata.accessservices.dataengine.model.DataFile dataFile) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Create or update the data file entity
      Specified by:
      upsertDataFile in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      dataFile - the data file bean
      Returns:
      unique identifier of the relational table in the repository
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - internal problem with the connector
    • deleteDatabase

      public void deleteDatabase(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Delete the database
      Specified by:
      deleteDatabase in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of the database
      guid - the unique identifier of the database
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • deleteDatabaseSchema

      public void deleteDatabaseSchema(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Delete the database schema
      Specified by:
      deleteDatabaseSchema in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of the database schema
      guid - the unique identifier of the database schema
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • deleteRelationalTable

      public void deleteRelationalTable(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Delete the relational table
      Specified by:
      deleteRelationalTable in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of the relational table
      guid - the unique identifier of the relational table
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • deleteDataFile

      public void deleteDataFile(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Delete the data file
      Specified by:
      deleteDataFile in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of the data file
      guid - the unique identifier of the data file
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • deleteFolder

      public void deleteFolder(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Delete the folder
      Specified by:
      deleteFolder in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of the data file
      guid - the unique identifier of the folder
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • deleteConnection

      public void deleteConnection(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Delete the connection
      Specified by:
      deleteConnection in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of the connection
      guid - the unique identifier of the connection
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • deleteEndpoint

      public void deleteEndpoint(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Delete the endpoint
      Specified by:
      deleteEndpoint in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of the endpoint
      guid - the unique identifier of the endpoint
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • find

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse find(String userId, org.odpi.openmetadata.accessservices.dataengine.rest.FindRequestBody findRequestBody) throws org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException
      Find an entity
      Specified by:
      find in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      findRequestBody - request body
      Returns:
      list of found entities
      Throws:
      org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException - this request is not supported in the target repositories
    • upsertTopic

      public String upsertTopic(String userId, org.odpi.openmetadata.accessservices.dataengine.model.Topic topic) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Create or update the topic entity
      Specified by:
      upsertTopic in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      topic - the topic bean
      Returns:
      unique identifier of topic in the repository
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - internal problem with the connector
    • upsertEventType

      public String upsertEventType(String userId, org.odpi.openmetadata.accessservices.dataengine.model.EventType eventType, String topicQualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Create or update the event type entity
      Specified by:
      upsertEventType in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      eventType - the event type bean
      topicQualifiedName - the qualified name of the topic
      Returns:
      unique identifier of event type in the repository
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - internal problem with the connector
    • deleteTopic

      public void deleteTopic(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Delete the topic
      Specified by:
      deleteTopic in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of the topic
      guid - the unique identifier of the topic
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • deleteEventType

      public void deleteEventType(String userId, String qualifiedName, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Delete the event type
      Specified by:
      deleteEventType in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualified name of the event type
      guid - the unique identifier of the event type
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - problem with the underlying connector (if used)
    • upsertProcessingState

      public void upsertProcessingState(String userId, Map<String,Long> properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Description copied from interface: DataEngineClient
      Create or update the engine's processing state classification with the provided properties
      Specified by:
      upsertProcessingState in interface DataEngineClient
      Parameters:
      userId - the name of the calling user
      properties - properties of the processing state
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
    • getProcessingState

      public Map<String,Long> getProcessingState(String userId)
      Description copied from interface: DataEngineClient
      Get the engine's processing state classification's properties
      Specified by:
      getProcessingState in interface DataEngineClient
      Parameters:
      userId - the name of the calling user