com.ibm.connectors

Interface OutputInteraction

  • All Known Implementing Classes:
    AbstractOutputInteraction


    public interface OutputInteraction
    Base interface for objects that send an output message to a remote system but doesn't expect a response. There is a synchronous version which returns the status of the output message directly, or an asynchronous version which will return a java long ticket as an interaction id, and notify the host application of the output status via the ConnectorCallback interface which was used to initialise the owning OutputConnector.
    Note that this interface may be implemented by the OutputConnector itself if compressing the connector and interaction into one object makes sense for a particular provider.
    • 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
      long asyncSend(java.util.Properties overrideProperties, java.lang.Object data, ConnectorCallback callback)
      Send an output message asynchronously using the provided configuration properties which may augment or override the properties set on the connector.
      void initialise(OutputConnector connector)
      Initialise the interaction by passing in the owning connector
      java.util.Properties send(java.util.Properties overrideProperties, java.lang.Object data)
      Send an output message using the provided configuration properties which may augment or override the properties set on the connector.
      void terminate()
      Called to allow the interaction to close any resources it may have created.
    • Method Detail

      • send

        java.util.Properties send(java.util.Properties overrideProperties,
                                  java.lang.Object data)
                           throws ConnectorException
        Send an output message using the provided configuration properties which may augment or override the properties set on the connector. This allows the host application to dynamically set endpoint properties such as remote server or queue names, based on values provided by the currently executing process.
        Parameters:
        overrideProperties - the properties used to configure the sending operation
        data - the data to send
        Returns:
        properties describing the status of the message (eg success, failure)
        Throws:
        ConnectorException
      • asyncSend

        long asyncSend(java.util.Properties overrideProperties,
                       java.lang.Object data,
                       ConnectorCallback callback)
                throws ConnectorException
        Send an output message asynchronously using the provided configuration properties which may augment or override the properties set on the connector. This allows the host application to dynamically set endpoint properties such as remote server or queue names, based on values provided by the currently executing process.
        Parameters:
        overrideProperties - the properties used to configure the sending operation
        data - the data to send
        Returns:
        a ticket number used to reconcile against the response sent asynchronously to the ConnectorCallback
        Throws:
        ConnectorException
IBM TM
CommonTM Connector API