org.jibx.soap
Interface IMessageContext

All Known Implementing Classes:

SOAPContext

public interface IMessageContext

SOAP message context interface. This interface is implemented by the message context and passed to all message processors.

Version:

1.0

Author:

Dennis M. Sosnoski

Method Summary

SOAPFault	getFaultResponse() Gets the unmarshalled fault response from a receive message.
java.util.ArrayList	getReceiveHeaders() Gets the list of received message header objects.
java.lang.Object	getReceivePayload() Gets the unmarshalled payload object from the body context of the receive message.
java.util.ArrayList	getSendHeaders() Gets the list of send message header objects.
boolean	isInbound() Check if in inbound processing.
void	setFaultResponse(SOAPFault fault) Sets a fault response to be sent back from a receive message.
void	setHeaderUnderstood(java.lang.Object header) Reports that a header has been understood and processed.
void	setSendPayload(java.lang.Object obj) Sets the payload object to be marshalled as the body content for the send message.

Method Detail

isInbound

public boolean isInbound()

Check if in inbound processing.

Returns:

true if in inbound processing (before or during processing of message body object), false if in output processing (after processing of message body object)

getReceiveHeaders

public java.util.ArrayList getReceiveHeaders()

Gets the list of received message header objects.

Returns:

message header object list

setHeaderUnderstood

public void setHeaderUnderstood(java.lang.Object header)

Reports that a header has been understood and processed.

Parameters:

header - understood header object

getSendHeaders

public java.util.ArrayList getSendHeaders()

Gets the list of send message header objects.

Returns:

message header object list

getReceivePayload

public java.lang.Object getReceivePayload()
                                   throws SOAPException

Gets the unmarshalled payload object from the body context of the receive message.

Returns:

unmarshalled body object

Throws:

SOAPException - on error in getting the body object

getFaultResponse

public SOAPFault getFaultResponse()

Gets the unmarshalled fault response from a receive message.

Returns:

fault response received

setSendPayload

public void setSendPayload(java.lang.Object obj)
                    throws SOAPException

Sets the payload object to be marshalled as the body content for the send message.

Parameters:

obj - payload object to be marshalled

Throws:

SOAPException - on error in setting the send payload object

setFaultResponse

public void setFaultResponse(SOAPFault fault)

Sets a fault response to be sent back from a receive message.

Parameters:

fault - response to be set