com.ibm.connectors

Interface ConnectorFactory

  • All Known Implementing Classes:
    AbstractConnectorFactory


    public interface ConnectorFactory
    Base interface for factory objects that can create connectors for a particular provider. Connectors for a provider are normally related, eg by type of endpoint such as JMS, HTTP or a proprietary protocol). Connector factories are identified by a provider name. The connector factory may also reference resources that are common to all connectors created by it, such as shared connections or file systems.
    • Method Detail

      • initialise

        void initialise(java.lang.String providerName,
                        java.util.Properties properties,
                        ConnectorServices services)
                 throws ConnectorException
        Initialise the provider with properties obtained from the factory metadata via the ConnectorRegistry. Shared resources may be established here, or made ready to do so on demand.
        Parameters:
        providerName - the name of the provider
        properties - the properties from the factory metadata
        services - application services
        Throws:
        ConnectorException
      • getInfo

        java.lang.String getInfo()
        Freeform info about the factory. The content returned is up to the connector developer.
        Returns:
        factory info
      • getProviderName

        java.lang.String getProviderName()
        The identifying name of the provider
        Returns:
        provider name
      • getProperties

        java.util.Properties getProperties()
        The metadata properties used to configure the factory
        Returns:
        metadata properties
      • getConnectorServices

        ConnectorServices getConnectorServices()
        Application services
        Returns:
        application services
      • createInputConnector

        InputConnector createInputConnector(java.lang.String name)
                                     throws ConnectorException
        Create an event input connector for this provider
        Parameters:
        name - the name of the input connector
        Returns:
        the input connector
        Throws:
        ConnectorException
      • createOutputConnector

        OutputConnector createOutputConnector(java.lang.String name)
                                       throws ConnectorException
        Create an event output connector for this provider
        Parameters:
        name - the name of the output connector
        Returns:
        the output connector
        Throws:
        ConnectorException
      • createRequestConnector

        RequestConnector createRequestConnector(java.lang.String name)
                                         throws ConnectorException
        Create a request connector for this provider
        Parameters:
        name - the name of the request connector
        Returns:
        the request connector
        Throws:
        ConnectorException
IBM TM
CommonTM Connector API