com.ibm.websphere.http.data.bindings

Interface HTTPStreamDataBinding

  • All Superinterfaces:
    commonj.connector.runtime.DataBinding, java.io.Serializable


    public interface HTTPStreamDataBinding
    extends commonj.connector.runtime.DataBinding
    A DataBinding maps between a native data format and an SDO DataObject, and vice-versa. This interface is an extension of commonj.connector.runtime.DataBinding, and presents a HTTP-specific view which should be implemented for use in HTTP Binding Exports and Imports.

    HTTP Binding will invoke Data Binding in the following order:

      1. Outbound processing (SDO to Native format):
      • 1.1 setDataObject (...)
      • 1.2 setHeaders(...)
      • 1.3 setControlParameters(...)
      • 1.4 setBusinessException(...)
      • 1.5 convertToNativeData()
      • 1.6 getControlParameters()
      • 1.7 getHeaders()
      • 1.8 write(...)
      2. Inbound processing (Native format to SDO):
      • 2.1 setControlParameters(...)
      • 2.2 setHeaders(...)
      • 2.3 convertFromNativeData(...)
      • 2.4 isBusinessException()
      • 2.5 getDataObject()
      • 2.6 getControlParameters()
      • 2.7 getHeaders()
    • Method Detail

      • getControlParameters

        HTTPControl getControlParameters()
        Get HTTP control parameters.
        Returns:
        HTTP control parameters
      • setControlParameters

        void setControlParameters(HTTPControl cp)
        Set HTTP control parameters.
        Parameters:
        HTTPControl - HTTP control parameters
      • getHeaders

        HTTPHeaders getHeaders()
        Get HTTP headers.
        Returns:
        HTTP headers
      • setHeaders

        void setHeaders(HTTPHeaders headers)
        Set HTTP headers.
        Parameters:
        HTTPHeaders - HTTP headers
      • convertFromNativeData

        void convertFromNativeData(HTTPInputStream input)
                                   throws commonj.connector.runtime.DataBindingException,
                                          java.io.IOException
        Convert native data to SDO.
        Parameters:
        HTTPInputStream - HTTP input stream
        Throws:
        commonj.connector.runtime.DataBindingException,java.io.IOException - Thrown if error occurs during conversion.
        commonj.connector.runtime.DataBindingException
        java.io.IOException
      • convertToNativeData

        void convertToNativeData()
                                 throws commonj.connector.runtime.DataBindingException
        Convert SDO to native data. Note: this method will not write to the output stream.
        Throws:
        commonj.connector.runtime.DataBindingException - Thrown if error occurs during conversion.
      • write

        void write(HTTPOutputStream output)
                   throws java.io.IOException
        Write native data to HTTPOutputStream after it has been converted by convertToNativeData() method.
        Parameters:
        HTTPOutputStream - HTTP output stream
        Throws:
        java.io.IOException
      • setBusinessException

        void setBusinessException(boolean isBusinessException)
        Indicate to the Data Binding that data is a fault object.
        Parameters:
        isBusinessException - True or false, specified by the caller
      • isBusinessException

        boolean isBusinessException()
        Determines whether the message is a fault.
        Returns:
        A boolean value stating whether the message payload is a fault.
IBM Business Process ManagerTM
Release 8