Module com.sun.xml.ws

Package com.sun.xml.ws.encoding

Class MtomCodec

java.lang.Object

com.sun.xml.ws.encoding.MimeCodec

com.sun.xml.ws.encoding.MtomCodec

All Implemented Interfaces:

Codec

public class MtomCodec
extends MimeCodec

Mtom message Codec. It can be used even for non-soap message's mtom encoding.

Author:

Vivek Pandey, Jitendra Kotamraju

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MtomCodec.ByteArrayBuffer
static class	MtomCodec.MtomStreamWriterImpl
static class	MtomCodec.MtomXMLStreamReaderEx

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XOP_LOCALNAME
static final String	XOP_NAMESPACEURI
static final String	XOP_XML_MIME_TYPE

Fields inherited from class com.sun.xml.ws.encoding.MimeCodec

features, mimeRootCodec, MULTIPART_RELATED_MIME_TYPE, version

Method Summary

Modifier and Type	Method	Description
MtomCodec	copy()	Creates a copy of this Codec.
protected void	decode(MimeMultipartParser mpp, Packet packet)	Parses a Packet from a MimeMultipartParser.
static String	determinePacketEncoding(Packet packet)
ContentType	encode(Packet packet, OutputStream out)	Encodes an XML infoset portion of the Message (from <soap:Envelope> to </soap:Envelope>).
ContentType	encode(Packet packet, WritableByteChannel buffer)	The version of Codec.encode(Packet,OutputStream) that writes to NIO ByteBuffer.
static String	getActionParameter(Packet packet, SOAPVersion version)
static String	getSOAPXopContentType(String encoding, SOAPVersion version, String actionParameter)
ContentType	getStaticContentType(Packet packet)	Return the soap 1.1 and soap 1.2 specific XOP packaged ContentType
static ContentType	getStaticContentTypeStatic(Packet packet, SOAPVersion version)
static void	writeMimeHeaders(String contentType, String contentId, OutputStream out)

Methods inherited from class com.sun.xml.ws.encoding.MimeCodec

decode, decode, getMimeRootCodec, getMimeType, writeAsAscii, writeln, writeln

Methods inherited from class java.lang.Object

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

Field Details

XOP_XML_MIME_TYPE

public static final String XOP_XML_MIME_TYPE

See Also:

• Constant Field Values

XOP_LOCALNAME

public static final String XOP_LOCALNAME

See Also:

• Constant Field Values

XOP_NAMESPACEURI

public static final String XOP_NAMESPACEURI

See Also:

• Constant Field Values

Method Details

getStaticContentType

public ContentType getStaticContentType(Packet packet)

Return the soap 1.1 and soap 1.2 specific XOP packaged ContentType

Specified by:

getStaticContentType in interface Codec

Overrides:

getStaticContentType in class MimeCodec

Returns:

A non-null content type for soap11 or soap 1.2 content type

getStaticContentTypeStatic

public static ContentType getStaticContentTypeStatic(Packet packet,
 SOAPVersion version)

encode

public ContentType encode(Packet packet,
 OutputStream out)
                   throws IOException

Description copied from interface: Codec

Encodes an XML infoset portion of the Message (from <soap:Envelope> to </soap:Envelope>).

Internally, this method is most likely invoke Message.writeTo(XMLStreamWriter) to turn the message into infoset.

Specified by:

encode in interface Codec

Overrides:

encode in class MimeCodec

out - Must not be null. The caller is responsible for closing the stream, not the callee.

Returns:

The MIME content type of the encoded message (such as "application/xml"). This information is often ncessary by transport.

Throws:

IOException - if a OutputStream throws IOException.

getSOAPXopContentType

public static String getSOAPXopContentType(String encoding,
 SOAPVersion version,
 String actionParameter)

getActionParameter

public static String getActionParameter(Packet packet,
 SOAPVersion version)

writeMimeHeaders

public static void writeMimeHeaders(String contentType,
 String contentId,
 OutputStream out)
                             throws IOException

Throws:

IOException

encode

public ContentType encode(Packet packet,
 WritableByteChannel buffer)

Description copied from interface: Codec

The version of Codec.encode(Packet,OutputStream) that writes to NIO ByteBuffer.

TODO: for the convenience of implementation, write an adapter that wraps WritableByteChannel to OutputStream.

copy

public MtomCodec copy()

Description copied from interface: Codec

Creates a copy of this Codec.

Since Codec instance is not re-entrant, the caller who needs to encode two Messages simultaneously will want to have two Codec instances. That's what this method produces.

Implentation Note

Note that this method might be invoked by one thread while another thread is executing one of the Codec.encode(com.sun.xml.ws.api.message.Packet, java.io.OutputStream) methods. This should be OK because you'll be only copying things that are thread-safe, and creating new ones for thread-unsafe resources, but please let us know if this contract is difficult.

Specified by:

copy in interface Codec

Specified by:

copy in class MimeCodec

Returns:

always non-null valid Codec that performs the encoding work in the same way --- that is, if you copy an FI codec, you'll get another FI codec.

Once copied, two Codecs may be invoked from two threads concurrently; therefore, they must not share any state that requires isolation (such as temporary buffer.)

If the Codec implementation is already re-entrant and multi-thread safe to begin with, then this method may simply return this.

decode

protected void decode(MimeMultipartParser mpp,
 Packet packet)
               throws IOException

Description copied from class: MimeCodec

Parses a Packet from a MimeMultipartParser.

Specified by:

decode in class MimeCodec

Throws:

IOException

determinePacketEncoding

public static String determinePacketEncoding(Packet packet)