com.sun.xml.ws.encoding
Class MtomCodec

java.lang.Object
  com.sun.xml.ws.encoding.MtomCodec

All Implemented Interfaces:

Codec

public class MtomCodec
extends java.lang.Object

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

Nested Class Summary

static class	MtomCodec.ByteArrayBuffer
static class	MtomCodec.MtomStreamWriterImpl
static class	MtomCodec.MtomXMLStreamReaderEx

Field Summary

protected WSFeatureList	features
protected Codec	mimeRootCodec
static java.lang.String	MULTIPART_RELATED_MIME_TYPE
protected SOAPVersion	version
static java.lang.String	XOP_XML_MIME_TYPE

Method Summary

MtomCodec	copy() Creates a copy of this Codec.
void	decode(java.io.InputStream in, java.lang.String contentType, Packet packet) Reads bytes from InputStream and constructs a Message.
protected void	decode(MimeMultipartParser mpp, Packet packet) Parses a Packet from a MimeMultipartParser.
void	decode(java.nio.channels.ReadableByteChannel in, java.lang.String contentType, Packet packet)
static java.lang.String	determinePacketEncoding(Packet packet)
ContentType	encode(Packet packet, java.io.OutputStream out) Encodes an XML infoset portion of the Message (from <soap:Envelope> to </soap:Envelope>).
ContentType	encode(Packet packet, java.nio.channels.WritableByteChannel buffer) The version of Codec.encode(Packet,OutputStream) that writes to NIO ByteBuffer.
static java.lang.String	getActionParameter(Packet packet, SOAPVersion version)
protected Codec	getMimeRootCodec(Packet packet)
java.lang.String	getMimeType() Get the MIME type associated with this Codec.
static java.lang.String	getSOAPXopContentType(java.lang.String encoding, SOAPVersion version, java.lang.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	writeAsAscii(java.lang.String s, java.io.OutputStream out) Writes a string as ASCII string.
static void	writeln(java.io.OutputStream out)
static void	writeln(java.lang.String s, java.io.OutputStream out)
static void	writeMimeHeaders(java.lang.String contentType, java.lang.String contentId, java.io.OutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

XOP_XML_MIME_TYPE

public static final java.lang.String XOP_XML_MIME_TYPE

See Also:

Constant Field Values

MULTIPART_RELATED_MIME_TYPE

public static final java.lang.String MULTIPART_RELATED_MIME_TYPE

See Also:

Constant Field Values

mimeRootCodec

protected Codec mimeRootCodec

version

protected final SOAPVersion version

features

protected final WSFeatureList features

Method Detail

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

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,
                          java.io.OutputStream out)
                   throws java.io.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

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:

java.io.IOException - if a OutputStream throws IOException.

getSOAPXopContentType

public static java.lang.String getSOAPXopContentType(java.lang.String encoding,
                                                     SOAPVersion version,
                                                     java.lang.String actionParameter)

getActionParameter

public static java.lang.String getActionParameter(Packet packet,
                                                  SOAPVersion version)

writeMimeHeaders

public static void writeMimeHeaders(java.lang.String contentType,
                                    java.lang.String contentId,
                                    java.io.OutputStream out)
                             throws java.io.IOException

Throws:

java.io.IOException

encode

public ContentType encode(Packet packet,
                          java.nio.channels.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

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 java.io.IOException

Parses a Packet from a MimeMultipartParser.

Throws:

java.io.IOException

determinePacketEncoding

public static java.lang.String determinePacketEncoding(Packet packet)

getMimeType

public java.lang.String getMimeType()

Description copied from interface: Codec

Get the MIME type associated with this Codec.

If available the MIME type will represent the media that the codec encodes and decodes. The MIME type returned will be the most general representation independent of an instance of this MIME type utilized as a MIME content-type.

Specified by:

getMimeType in interface Codec

Returns:

null if the MIME type can't be determined by the Codec implementation. Otherwise the MIME type is returned.

getMimeRootCodec

protected Codec getMimeRootCodec(Packet packet)

decode

public void decode(java.io.InputStream in,
                   java.lang.String contentType,
                   Packet packet)
            throws java.io.IOException

Description copied from interface: Codec

Reads bytes from InputStream and constructs a Message.

The design encourages lazy decoding of a Message, where a Message is returned even before the whole message is parsed, and additional parsing is done as the Message body is read along. A Codec is most likely have its own implementation of Message for this purpose.

Specified by:

decode in interface Codec

Parameters:

in - the data to be read into a Message. The transport would have read any transport-specific header before it passes an InputStream, and InputStream is expected to be read until EOS. Never null.

Some transports, such as SMTP, may 'encode' data into another format (such as uuencode, base64, etc.) It is the caller's responsibility to 'decode' these transport-level encoding before it passes data into Codec.

contentType - The MIME content type (like "application/xml") of this byte stream. Thie text includes all the sub-headers of the content-type header. Therefore, in more complex case, this could be something like multipart/related; boundary="--=_outer_boundary"; type="multipart/alternative". This parameter must not be null.

packet - The parsed Message will be set to this Packet. Codec may add additional properties to this Packet. On a successful method completion, a Packet must contain a Message.

Throws:

java.io.IOException - if InputStream throws an exception.

decode

public void decode(java.nio.channels.ReadableByteChannel in,
                   java.lang.String contentType,
                   Packet packet)

Specified by:

decode in interface Codec

See Also:

Codec.decode(InputStream, String, Packet)

writeln

public static void writeln(java.lang.String s,
                           java.io.OutputStream out)
                    throws java.io.IOException

Throws:

java.io.IOException

writeAsAscii

public static void writeAsAscii(java.lang.String s,
                                java.io.OutputStream out)
                         throws java.io.IOException

Writes a string as ASCII string.

Throws:

java.io.IOException

writeln

public static void writeln(java.io.OutputStream out)
                    throws java.io.IOException

Throws:

java.io.IOException