org.apache.axis2.json

Class AbstractJSONMessageFormatter

java.lang.Object

org.apache.axis2.json.AbstractJSONMessageFormatter

All Implemented Interfaces:

org.apache.axis2.transport.MessageFormatter

Direct Known Subclasses:

JSONBadgerfishMessageFormatter, JSONMessageFormatter

public abstract class AbstractJSONMessageFormatter
extends Object
implements org.apache.axis2.transport.MessageFormatter

Base class for JSON message formatters.

Constructor Summary

Constructors

Constructor and Description
AbstractJSONMessageFormatter(Class<? extends AbstractJSONDataSource> dataSourceClass) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	formatSOAPAction(org.apache.axis2.context.MessageContext msgCtxt, org.apache.axiom.om.OMOutputFormat format, String soapActionString)
byte[]	getBytes(org.apache.axis2.context.MessageContext msgCtxt, org.apache.axiom.om.OMOutputFormat format) Gives the JSON message as an array of bytes.
String	getContentType(org.apache.axis2.context.MessageContext msgCtxt, org.apache.axiom.om.OMOutputFormat format, String soapActionString)
protected abstract javax.xml.stream.XMLStreamWriter	getJSONWriter(Writer writer, org.apache.axis2.context.MessageContext messageContext)
URL	getTargetAddress(org.apache.axis2.context.MessageContext msgCtxt, org.apache.axiom.om.OMOutputFormat format, URL targetURL)
void	writeTo(org.apache.axis2.context.MessageContext msgCtxt, org.apache.axiom.om.OMOutputFormat format, OutputStream out, boolean preserve) Writes the JSON message to the output stream with the correct convention.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJSONMessageFormatter

public AbstractJSONMessageFormatter(Class<? extends AbstractJSONDataSource> dataSourceClass)

Constructor.

Parameters:

dataSourceClass - the OMDataSource class corresponding to the JSON format used by this message formatter; this information is used for optimization (pass through)

Method Detail

getContentType

public String getContentType(org.apache.axis2.context.MessageContext msgCtxt,
                    org.apache.axiom.om.OMOutputFormat format,
                    String soapActionString)

Specified by:

getContentType in interface org.apache.axis2.transport.MessageFormatter

getBytes

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

Gives the JSON message as an array of bytes. If the payload is an OMSourcedElement and it contains a JSONDataSource with a correctly formatted JSON String, gets it directly from the DataSource and returns as a byte array. If not, the OM tree is expanded and it is serialized into the output stream and byte array is returned.

Specified by:

getBytes in interface org.apache.axis2.transport.MessageFormatter

Parameters:

msgCtxt - Message context which contains the soap envelope to be written

format - format of the message, this is ignored

Returns:

the payload as a byte array

Throws:

org.apache.axis2.AxisFault - if there is an error in writing the message using StAX writer or IF THE USER TRIES TO SEND A JSON MESSAGE WITH NAMESPACES USING THE "MAPPED" CONVENTION.

formatSOAPAction

public String formatSOAPAction(org.apache.axis2.context.MessageContext msgCtxt,
                      org.apache.axiom.om.OMOutputFormat format,
                      String soapActionString)

Specified by:

formatSOAPAction in interface org.apache.axis2.transport.MessageFormatter

getJSONWriter

protected abstract javax.xml.stream.XMLStreamWriter getJSONWriter(Writer writer,
                                             org.apache.axis2.context.MessageContext messageContext)
                                                           throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeTo

public void writeTo(org.apache.axis2.context.MessageContext msgCtxt,
           org.apache.axiom.om.OMOutputFormat format,
           OutputStream out,
           boolean preserve)
             throws org.apache.axis2.AxisFault

Writes the JSON message to the output stream with the correct convention. If the payload is an OMSourcedElement and it contains a JSONDataSource with a correctly formatted JSON String, gets it directly from the DataSource and writes to the output stream. If not, the OM tree is expanded and it is serialized into the output stream. *

Specified by:

writeTo in interface org.apache.axis2.transport.MessageFormatter

Parameters:

msgCtxt - Message context which contains the soap envelope to be written

format - format of the message, this is ignored

out - output stream to be written in to

preserve - ignored

Throws:

org.apache.axis2.AxisFault - if there is an error in writing the message using StAX writer or IF THE USER TRIES TO SEND A JSON MESSAGE WITH NAMESPACES USING THE "MAPPED" CONVENTION.

getTargetAddress

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

Specified by:

getTargetAddress in interface org.apache.axis2.transport.MessageFormatter

Throws:

org.apache.axis2.AxisFault