Package com.sun.xml.ws.encoding.fastinfoset

Class FastInfosetStreamSOAPCodec

java.lang.Object

com.sun.xml.ws.encoding.fastinfoset.FastInfosetStreamSOAPCodec

All Implemented Interfaces:

Codec

public abstract class FastInfosetStreamSOAPCodec
extends Object
implements Codec

A stream SOAP codec for handling SOAP message infosets to fast infoset documents.

This implementation currently defers to StreamSOAPCodec for the decoding using XMLStreamReader.

Author:

Paul Sandoz

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentType	_defaultContentType

Method Summary

Modifier and Type	Method	Description
static FastInfosetStreamSOAPCodec	create(StreamSOAPCodec soapCodec, SOAPVersion version)	Creates a new FastInfosetStreamSOAPCodec instance.
static FastInfosetStreamSOAPCodec	create(StreamSOAPCodec soapCodec, SOAPVersion version, boolean retainState)	Creates a new FastInfosetStreamSOAPCodec instance.
protected abstract StreamHeader	createHeader(XMLStreamReader reader, XMLStreamBuffer mark)
void	decode(InputStream in, String contentType, Packet response)	Reads bytes from InputStream and constructs a Message.
void	decode(ReadableByteChannel in, String contentType, Packet response)
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.
protected abstract ContentType	getContentType(String soapAction)
String	getMimeType()	Get the MIME type associated with this Codec.
ContentType	getStaticContentType(Packet packet)	If the MIME content-type of the encoding is known statically then this method returns it.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.xml.ws.api.pipe.Codec

copy

Field Detail

_defaultContentType

protected final ContentType _defaultContentType

Method Detail

getMimeType

public 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.

getStaticContentType

public ContentType getStaticContentType(Packet packet)

Description copied from interface: Codec

If the MIME content-type of the encoding is known statically then this method returns it.

Transports often need to write the content type before it writes the message body, and since the encode method returns the content type after the body is written, it requires a buffering. For those Codecs that always use a constant content type, This method allows a transport to streamline the write operation.

Specified by:

getStaticContentType in interface Codec

Returns:

null if the content-type can't be determined in short of encodin the packet. Otherwise content type for this Packet, such as "application/xml".

encode

public ContentType encode(Packet packet,
                          OutputStream out)

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.

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.

Specified by:

encode in interface Codec

decode

public void decode(InputStream in,
                   String contentType,
                   Packet response)
            throws 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.

response - 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:

IOException - if InputStream throws an exception.

decode

public void decode(ReadableByteChannel in,
                   String contentType,
                   Packet response)

Specified by:

decode in interface Codec

See Also:

Codec.decode(InputStream, String, Packet)

createHeader

protected abstract StreamHeader createHeader(XMLStreamReader reader,
                                             XMLStreamBuffer mark)

getContentType

protected abstract ContentType getContentType(String soapAction)

create

public static FastInfosetStreamSOAPCodec create(StreamSOAPCodec soapCodec,
                                                SOAPVersion version)

Creates a new FastInfosetStreamSOAPCodec instance.

Parameters:

version - the SOAP version of the codec.

Returns:

a new FastInfosetStreamSOAPCodec instance.

create

public static FastInfosetStreamSOAPCodec create(StreamSOAPCodec soapCodec,
                                                SOAPVersion version,
                                                boolean retainState)

Creates a new FastInfosetStreamSOAPCodec instance.

Parameters:

version - the SOAP version of the codec.

retainState - if true the Codec should retain the state of vocabulary tables for multiple encode/decode invocations.

Returns:

a new FastInfosetStreamSOAPCodec instance.