Package org.odpi.openmetadata.frameworks.integration.bitol

Interface BitolDocumentManager

All Known Implementing Classes:
IntegrationContextManager, OIFContextManager
public interface BitolDocumentManager
BitolDocumentManager distributes Bitol documents (Open Data Contract Standard data contracts and Open Data Product Standard data products) to the integration connectors that have registered a BitolDocumentListener. It is implemented by the integration context manager and made available to integration connectors through the integration context. Documents may be published in their raw form (YAML or JSON) or as beans.

  • Method Details

    • registerListener

      void registerListener(BitolDocumentListener listener)
      Register a listener to receive Bitol documents. The listener is implemented by an integration connector.
      Parameters:
      listener - listener to call

    • publishBitolDocument

      void publishBitolDocument(String rawDocument)
      Publish a Bitol document of either kind. The document is parsed and routed to the listeners according to its "kind" property.
      Parameters:
      rawDocument - document in YAML or JSON format

    • publishDataContract

      void publishDataContract(String rawDocument)
      Publish an Open Data Contract Standard (ODCS) data contract.
      Parameters:
      rawDocument - document in YAML or JSON format

    • publishDataContract

      void publishDataContract(DataContract dataContract)
      Publish an Open Data Contract Standard (ODCS) data contract.
      Parameters:
      dataContract - bean for the document

    • publishDataProduct

      void publishDataProduct(String rawDocument)
      Publish an Open Data Product Standard (ODPS) data product.
      Parameters:
      rawDocument - document in YAML or JSON format

    • publishDataProduct

      void publishDataProduct(DataProduct dataProduct)
      Publish an Open Data Product Standard (ODPS) data product.
      Parameters:
      dataProduct - bean for the document

    • publishGeneratedDataContract

      void publishGeneratedDataContract(DataContract dataContract)
      Publish an Open Data Contract Standard (ODCS) data contract that was generated from open metadata. It is not sent to the listeners that catalogue documents into open metadata, since it describes elements that are already catalogued.
      Parameters:
      dataContract - bean for the document

    • publishGeneratedDataProduct

      void publishGeneratedDataProduct(DataProduct dataProduct)
      Publish an Open Data Product Standard (ODPS) data product that was generated from open metadata. It is not sent to the listeners that catalogue documents into open metadata, since it describes elements that are already catalogued.
      Parameters:
      dataProduct - bean for the document