public abstract class FastInfosetStreamSOAPCodec extends Object implements Codec
This implementation currently defers to StreamSOAPCodec
for the decoding
using XMLStreamReader
.
Modifier and Type | Field and Description |
---|---|
protected ContentType |
_defaultContentType |
Modifier and Type | Method and 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 com.sun.xml.ws.message.stream.StreamHeader |
createHeader(XMLStreamReader reader,
com.sun.xml.stream.buffer.XMLStreamBuffer mark) |
void |
decode(InputStream in,
String contentType,
com.sun.xml.ws.api.message.Packet response)
Reads bytes from
InputStream and constructs a Message . |
void |
decode(ReadableByteChannel in,
String contentType,
com.sun.xml.ws.api.message.Packet response) |
ContentType |
encode(com.sun.xml.ws.api.message.Packet packet,
OutputStream out)
Encodes an XML infoset portion of the
Message
(from <soap:Envelope> to </soap:Envelope>). |
ContentType |
encode(com.sun.xml.ws.api.message.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(com.sun.xml.ws.api.message.Packet packet)
If the MIME content-type of the encoding is known statically
then this method returns it.
|
protected final ContentType _defaultContentType
public String getMimeType()
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.
getMimeType
in interface Codec
Codec
implementation. Otherwise the MIME type is returned.public ContentType getStaticContentType(com.sun.xml.ws.api.message.Packet packet)
Codec
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 Codec
s that always use a constant content type,
This method allows a transport to streamline the write operation.
getStaticContentType
in interface Codec
Packet
,
such as "application/xml".public ContentType encode(com.sun.xml.ws.api.message.Packet packet, OutputStream out)
Codec
Message
(from <soap:Envelope> to </soap:Envelope>).
Internally, this method is most likely invoke Message.writeTo(XMLStreamWriter)
to turn the message into infoset.
public ContentType encode(com.sun.xml.ws.api.message.Packet packet, WritableByteChannel buffer)
Codec
Codec.encode(Packet,OutputStream)
that writes to NIO ByteBuffer
.
TODO: for the convenience of implementation, write
an adapter that wraps WritableByteChannel
to OutputStream
.
public void decode(InputStream in, String contentType, com.sun.xml.ws.api.message.Packet response) throws IOException
Codec
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.
decode
in interface Codec
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
.IOException
- if InputStream
throws an exception.public void decode(ReadableByteChannel in, String contentType, com.sun.xml.ws.api.message.Packet response)
decode
in interface Codec
Codec.decode(InputStream, String, Packet)
protected abstract com.sun.xml.ws.message.stream.StreamHeader createHeader(XMLStreamReader reader, com.sun.xml.stream.buffer.XMLStreamBuffer mark)
protected abstract ContentType getContentType(String soapAction)
public static FastInfosetStreamSOAPCodec create(StreamSOAPCodec soapCodec, SOAPVersion version)
FastInfosetStreamSOAPCodec
instance.version
- the SOAP version of the codec.FastInfosetStreamSOAPCodec
instance.public static FastInfosetStreamSOAPCodec create(StreamSOAPCodec soapCodec, SOAPVersion version, boolean retainState)
FastInfosetStreamSOAPCodec
instance.version
- the SOAP version of the codec.retainState
- if true the Codec should retain the state of
vocabulary tables for multiple encode/decode invocations.FastInfosetStreamSOAPCodec
instance.Copyright © 2015 Oracle Corporation. All rights reserved.