com.ibm.connectors

Interface Connector

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT 
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      ConnectorCallback getCallback()
      Returns a callback object that the connector can use to feed data and results back to the host application.
      ConnectorServices getConnectorServices()
      Services provided by the host application for use by the connector
      java.util.logging.Logger getLogger()
      Returns a java.util.Logger which uses the connector's name, to enable the connector to log to the host application's logging mechanism
      java.lang.String getName()
      Returns the name allocated by the runtime to this connector when it was initialsed.
      java.util.Properties getProperties()
      Returns the properties object passed to connector when it was initialised
      void initialise(java.lang.String name, java.util.Properties properties, ConnectorCallback callback, ConnectorServices services)
      Initialise the connector.
      void terminate()
      Reset the connector to an uninitialised state.
    • Method Detail

      • getName

        java.lang.String getName()
        Returns the name allocated by the runtime to this connector when it was initialsed.
        Returns:
        the name of the connector
      • getProperties

        java.util.Properties getProperties()
        Returns the properties object passed to connector when it was initialised
        Returns:
        the connector's properties
      • getLogger

        java.util.logging.Logger getLogger()
        Returns a java.util.Logger which uses the connector's name, to enable the connector to log to the host application's logging mechanism
        Returns:
        the connector's assigned logger object
      • getCallback

        ConnectorCallback getCallback()
        Returns a callback object that the connector can use to feed data and results back to the host application. Used mainly for event input, and the results of asynchronous output/request.
        Returns:
        the application callback
      • getConnectorServices

        ConnectorServices getConnectorServices()
        Services provided by the host application for use by the connector
        Returns:
        application services
      • initialise

        void initialise(java.lang.String name,
                        java.util.Properties properties,
                        ConnectorCallback callback,
                        ConnectorServices services)
                 throws ConnectorException
        Initialise the connector. This step in the connector's lifecycle moves it from newly-created and blank, to initialised and ready to run. It is expected that in this step, the connector will initialise its state and create resources (eg, open connections, create files, etc), or at least make itself ready to do so on demand.
        The property values will be those used to configure the connector, either at design-time or at runtime via policies.
        Parameters:
        name - the name of the connector
        properties - properties used to configure the connector
        callback - the host application's callback interface
        services - application services
        Throws:
        ConnectorException
      • terminate

        void terminate()
                throws ConnectorException
        Reset the connector to an uninitialised state. The connector should close or destroy any resources it created.
        Throws:
        ConnectorException
IBM TM
CommonTM Connector API