| org.apache.axis2.transport.MessageFormatter
All known Subclasses: org.apache.axis2.transport.http.XFormURLEncodedFormatter, org.apache.axis2.transport.http.MultipartFormDataFormatter, org.apache.axis2.transport.http.SOAPMessageFormatter, org.apache.axis2.transport.http.ApplicationXMLFormatter,
| MessageFormatter | | public interface MessageFormatter (Code) | |
MessageFormatter implementations are used by Axis2 to support serialization
of messages to different message formats. (Eg: JSON). Users can register
MessageFormatter implementations against a message type using the axis2.xml.
Message type for a message can be specified by setting the "messageType"
property in the MessageContext. This can also be given as a parameter in the
service.xml/axis2.xml for a per service based/engine wide configuration.
|
| Method Summary | |
| public String | formatSOAPAction(MessageContext messageContext, OMOutputFormat format, String soapAction)
| | public byte[] | getBytes(MessageContext messageContext, OMOutputFormat format)
| | public String | getContentType(MessageContext messageContext, OMOutputFormat format, String soapAction)
| | public URL | getTargetAddress(MessageContext messageContext, OMOutputFormat format, URL targetURL)
Some message formats may want to alter the target url. | | public void | writeTo(MessageContext messageContext, OMOutputFormat format, OutputStream outputStream, boolean preserve)
To support deffered writing transports as in http chunking.. |
| formatSOAPAction | | public String formatSOAPAction(MessageContext messageContext, OMOutputFormat format, String soapAction)(Code) | | this only if you want set a transport header for SOAP Action |
| getBytes | | public byte[] getBytes(MessageContext messageContext, OMOutputFormat format) throws AxisFault(Code) | | a byte array of the message formatted according to the givenmessage format. |
| getContentType | | public String getContentType(MessageContext messageContext, OMOutputFormat format, String soapAction)(Code) | | Different message formats can set their own content types
Eg: JSONFormatter can set the content type as application/json
Parameters:
messageContext -
Parameters:
format -
Parameters:
soapAction - |
| getTargetAddress | | public URL getTargetAddress(MessageContext messageContext, OMOutputFormat format, URL targetURL) throws AxisFault(Code) | | Some message formats may want to alter the target url.
the target URL |
| writeTo | | public void writeTo(MessageContext messageContext, OMOutputFormat format, OutputStream outputStream, boolean preserve) throws AxisFault(Code) | | 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.
Parameters:
outputStream -
Parameters:
preserve - :do not consume the OM when this is set.. |
|
|