Interface IntegrationConnector

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void disconnect()
      Free up any resources held since the connector is no longer needed.
      void engage()
      This method is for blocking calls to wait for new metadata.
      void refresh()
      Requests that the connector does a comparison of the metadata in the third party technology and open metadata repositories.
      void setConnectorName​(java.lang.String connectorName)
      Set up the connector name for logging (called just before start()).
      void start()
      Indicates that the connector is completely configured and can begin processing.
    • Method Detail

      • setConnectorName

        void setConnectorName​(java.lang.String connectorName)
        Set up the connector name for logging (called just before start()).
        Parameters:
        connectorName - connector name from the configuration
      • start

        void start()
            throws ConnectorCheckedException
        Indicates that the connector is completely configured and can begin processing. This call can be used to register with non-blocking services.
        Throws:
        ConnectorCheckedException - there is a problem within the connector.
      • engage

        void engage()
             throws ConnectorCheckedException
        This method is for blocking calls to wait for new metadata. It is called from its own thread if the connector is configured to have its own thread. It is recommended that the engage() method returns when each blocking call completes. The integration daemon will pause a second and then call engage() again. This pattern enables the calling thread to detect the shutdown of the integration daemon.
        Throws:
        ConnectorCheckedException - there is a problem within the connector.
      • refresh

        void refresh()
              throws ConnectorCheckedException
        Requests that the connector does a comparison of the metadata in the third party technology and open metadata repositories. Refresh is called when the integration connector first starts and then at intervals defined in the connector's configuration as well as any external REST API calls to explicitly refresh the connector.
        Throws:
        ConnectorCheckedException - there is a problem with the connector. It is not able to refresh the metadata.