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
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.1 setControlParameters(...)
- 2.2 setHeaders(...)
- 2.3 convertFromNativeData(...)
- 2.4 isBusinessException()
- 2.5 getDataObject()
- 2.6 getControlParameters()
- 2.7 getHeaders()
- static
- java.lang.String
- void
- void
- boolean
- void
- void
- void
- void
- static final java.lang.String COPYRIGHT
- HTTPControl getControlParameters( )
- void setControlParameters(HTTPControl cp)
- HTTPHeaders getHeaders()
- void setHeaders(HTTPHeaders headers)
- void convertFromNativeData(HTTPInputStream input)
- throws commonj.connector.runtime.DataBindingException
- java.io.IOException
- void convertToNativeData()
- throws commonj.connector.runtime.DataBindingException
- void write(HTTPOutputStream output)
- throws java.io.IOException
- void setBusinessException(boolean isBusinessException)
- boolean isBusinessException()
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
convertFromNativeData(HTTPInputStream input)
Convert native data to SDO.
|
|
convertToNativeData()
Convert SDO to native data.
|
getControlParameters()
Get HTTP control parameters.
|
|
getHeaders()
Get HTTP headers.
|
|
|
isBusinessException()
Determines whether the message is a fault.
|
|
setBusinessException(boolean isBusinessException)
Indicate to the Data Binding that data is a fault object.
|
|
setControlParameters(HTTPControl cp)
Set HTTP control parameters.
|
|
setHeaders(HTTPHeaders headers)
Set HTTP headers.
|
|
write(HTTPOutputStream output)
Write native data to HTTPOutputStream after it has been converted by convertToNativeData() method.
|
Methods inherited from interface commonj.connector.runtime.DataBinding |
---|
getDataObject, setDataObject |
Field Detail
COPYRIGHT
See Also:
Method Detail
getControlParameters
Get HTTP control parameters.
Returns:
HTTP control parameters
setControlParameters
Set HTTP control parameters.
getHeaders
Get HTTP headers.
Returns:
HTTP headers
setHeaders
Set HTTP headers.
convertFromNativeData
Convert native data to SDO.
Throws:
commonj.connector.runtime.DataBindingException,java.io.IOException
- Thrown if error occurs during conversion. commonj.connector.runtime.DataBindingException
java.io.IOException
convertToNativeData
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
Write native data to HTTPOutputStream after it has been converted by convertToNativeData() method.
Throws:
java.io.IOException
setBusinessException
Indicate to the Data Binding that data is a fault object.
Parameters:
isBusinessException
- True or false, specified by the caller isBusinessException
Determines whether the message is a fault.
Returns:
A boolean value stating whether the message payload is a fault.