Package org.apache.axis2.format

Class PlainTextBuilder

java.lang.Object

org.apache.axis2.format.PlainTextBuilder

All Implemented Interfaces:

Builder, DataSourceMessageBuilder, TextMessageBuilder

public class PlainTextBuilder
extends Object
implements TextMessageBuilder, DataSourceMessageBuilder

Message builder for plain text payloads.

This builder processes the input message as plain text and wraps the text in a wrapper element. The name of the wrapper element can be configured as a service parameter (see BaseConstants.WRAPPER_PARAM). It defaults to BaseConstants.DEFAULT_TEXT_WRAPPER. If the content is provided as an InputStream and the content type specifies a charset parameter (e.g. text/plain; charset=ISO-8859-15), this information is used to decode the text. If the content is provided as an InputStream but no charset parameter is specified on the content type, the default charset encoding specified by MessageContext.DEFAULT_CHAR_SET_ENCODING is used.

Constructor Summary

Constructors

Constructor	Description
PlainTextBuilder()

Method Summary

Modifier and Type	Method	Description
OMElement	processDocument(InputStream inputStream, String contentType, MessageContext msgContext)	Process a message.
OMElement	processDocument(Reader reader, String contentType, MessageContext msgContext)
OMElement	processDocument(String content, String contentType, MessageContext msgContext)
OMElement	processDocument(DataSource dataSource, String contentType, MessageContext msgContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlainTextBuilder

public PlainTextBuilder()

Method Detail

processDocument

public OMElement processDocument(InputStream inputStream,
                                 String contentType,
                                 MessageContext msgContext)
                          throws AxisFault

Description copied from interface: Builder

Process a message.

The raw content of the message is provided as an input stream. It is the responsibility of the caller (typically a transport implementation) to close the stream after the message has been processed (more precisely after the SOAP infoset returned by this method is no longer used). This implies that implementations are not required to consume the input stream during the execution of this method. This enables deferred parsing of the message.

Specified by:

processDocument in interface Builder

Parameters:

inputStream - the byte stream with the raw payload

Returns:

The SOAP infoset for the given message.

Throws:

AxisFault

processDocument

public OMElement processDocument(Reader reader,
                                 String contentType,
                                 MessageContext msgContext)
                          throws AxisFault

Specified by:

processDocument in interface TextMessageBuilder

Throws:

AxisFault

processDocument

public OMElement processDocument(String content,
                                 String contentType,
                                 MessageContext msgContext)
                          throws AxisFault

Specified by:

processDocument in interface TextMessageBuilder

Throws:

AxisFault

processDocument

public OMElement processDocument(DataSource dataSource,
                                 String contentType,
                                 MessageContext msgContext)
                          throws AxisFault

Specified by:

processDocument in interface DataSourceMessageBuilder

Throws:

AxisFault