org.apache.axis2.format

Class MessageFormatterExAdapter

java.lang.Object

org.apache.axis2.format.MessageFormatterExAdapter

All Implemented Interfaces:

MessageFormatterEx, MessageFormatter

public class MessageFormatterExAdapter
extends Object
implements MessageFormatterEx

Adapter to add the MessageFormatterEx interface to an existing MessageFormatter. It implements the MessageFormatterEx.getDataSource(MessageContext, OMOutputFormat, String) method using MessageFormatter.getBytes(MessageContext, OMOutputFormat) and MessageFormatter.getContentType(MessageContext, OMOutputFormat, String).

Constructor Summary

Constructors

Constructor and Description
MessageFormatterExAdapter(MessageFormatter messageFormatter)

Method Summary

Modifier and Type	Method and Description
String	formatSOAPAction(MessageContext messageContext, org.apache.axiom.om.OMOutputFormat format, String soapAction)
byte[]	getBytes(MessageContext messageContext, org.apache.axiom.om.OMOutputFormat format)
String	getContentType(MessageContext messageContext, org.apache.axiom.om.OMOutputFormat format, String soapAction) Different message formats can set their own content types Eg: JSONFormatter can set the content type as application/json
DataSource	getDataSource(MessageContext messageContext, org.apache.axiom.om.OMOutputFormat format, String soapAction) Get the formatted message as a DataSource object.
URL	getTargetAddress(MessageContext messageContext, org.apache.axiom.om.OMOutputFormat format, URL targetURL) Some message formats may want to alter the target url.
void	writeTo(MessageContext messageContext, org.apache.axiom.om.OMOutputFormat format, OutputStream outputStream, boolean preserve) To support deffered writing transports as in http chunking..

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageFormatterExAdapter

public MessageFormatterExAdapter(MessageFormatter messageFormatter)

Method Detail

getDataSource

public DataSource getDataSource(MessageContext messageContext,
                                org.apache.axiom.om.OMOutputFormat format,
                                String soapAction)
                         throws AxisFault

Description copied from interface: MessageFormatterEx

Get the formatted message as a DataSource object.

Specified by:

getDataSource in interface MessageFormatterEx

Returns:

Throws:

AxisFault

formatSOAPAction

public String formatSOAPAction(MessageContext messageContext,
                               org.apache.axiom.om.OMOutputFormat format,
                               String soapAction)

Specified by:

formatSOAPAction in interface MessageFormatter

Returns:

this only if you want set a transport header for SOAP Action

getBytes

public byte[] getBytes(MessageContext messageContext,
                       org.apache.axiom.om.OMOutputFormat format)
                throws AxisFault

Specified by:

getBytes in interface MessageFormatter

Returns:

a byte array of the message formatted according to the given message format.

Throws:

AxisFault

getContentType

public String getContentType(MessageContext messageContext,
                             org.apache.axiom.om.OMOutputFormat format,
                             String soapAction)

Description copied from interface: MessageFormatter

Different message formats can set their own content types Eg: JSONFormatter can set the content type as application/json

Specified by:

getContentType in interface MessageFormatter

getTargetAddress

public URL getTargetAddress(MessageContext messageContext,
                            org.apache.axiom.om.OMOutputFormat format,
                            URL targetURL)
                     throws AxisFault

Description copied from interface: MessageFormatter

Some message formats may want to alter the target url.

Specified by:

getTargetAddress in interface MessageFormatter

Returns:

the target URL

Throws:

AxisFault

writeTo

public void writeTo(MessageContext messageContext,
                    org.apache.axiom.om.OMOutputFormat format,
                    OutputStream outputStream,
                    boolean preserve)
             throws AxisFault

Description copied from interface: MessageFormatter

To support deffered writing transports as in http chunking.. Axis2 was doing this for some time..

Preserve flag can be used to preserve the envelope for later use. This is usefull when implementing authentication machnisms like NTLM.

Specified by:

writeTo in interface MessageFormatter

preserve - : do not consume the OM when this is set..

Throws:

AxisFault