com.bea.wli.sb.transports
Interface InboundTransportMessageContext

All Superinterfaces:

TransportMessageContext

All Known Implementing Classes:

CoLocatedMessageContext

public interface InboundTransportMessageContext
extends TransportMessageContext

Inbound Transport Message Context implements the message context abstraction for incoming messages

Method Summary

void	close(TransportOptions options) Commits the contents of this context and clean up any resources used by this context
ResponseMetaData	createResponseMetaData() Creates a new (empty) response meta data POJO
ResponseMetaData	createResponseMetaData(org.apache.xmlbeans.XmlObject rmdXML) Creates a new response meta data POJO
TransportEndPoint	getEndPoint()
RequestMetaData	getRequestMetaData()
Source	getRequestPayload()
void	setResponseMetaData(ResponseMetaData rmd) Sets the meta-data for the response part of the message, e.g.
void	setResponsePayload(Source src) Sets the response payload into the message context

Methods inherited from interface com.bea.wli.sb.transports.TransportMessageContext

getMessageId, getURI

Method Detail

getEndPoint

TransportEndPoint getEndPoint()
                              throws TransportException

Returns:

the service endpoint object which has received this incoming message

Throws:

TransportException

getRequestMetaData

RequestMetaData getRequestMetaData()
                                   throws TransportException

Returns:

the meta-data for the request part of the message, e.g. headers, etc. Returns null if there is no request meta-data

Throws:

TransportException

getRequestPayload

Source getRequestPayload()
                         throws TransportException

Returns:

returns a source (e.g. input stream or a DOM object) for reading data in the body of the request of an inbound message or null if there is no body of the request. Note that the entire body of the payload is retrieved.

Throws:

TransportException

createResponseMetaData

ResponseMetaData createResponseMetaData()
                                        throws TransportException

Creates a new (empty) response meta data POJO

Returns:

empty (new) meta-data for the response part of the message, e.g. headers, etc. Used for initializing the inbound response

Throws:

TransportException

createResponseMetaData

ResponseMetaData createResponseMetaData(org.apache.xmlbeans.XmlObject rmdXML)
                                        throws TransportException

Creates a new response meta data POJO

Parameters:

rmdXML - transport provider-specific XML Bean that represents the provider-specific meta data

Returns:

meta-data for the response part of the message, e.g. headers, etc initialized according to XML bean. Used for initializing the inbound response

Throws:

TransportException

setResponseMetaData

void setResponseMetaData(ResponseMetaData rmd)
                         throws TransportException

Sets the meta-data for the response part of the message, e.g. headers, etc.

Parameters:

rmd - Transport Provider-specific POJO that represents response meta data

Throws:

TransportException

setResponsePayload

void setResponsePayload(Source src)
                        throws TransportException

Sets the response payload into the message context

Parameters:

src - source containing the response payload

Throws:

TransportException

close

void close(TransportOptions options)

Commits the contents of this context and clean up any resources used by this context

Parameters:

options - specifies additional run-time parameters with respect to processing of inbound response. E.g. it can signal the mode of a given message: one-way versus request/response