public abstract class StreamSOAPCodec extends Object implements StreamSOAPCodec, RootOnlyCodec
Modifier and Type | Field and Description |
---|---|
protected SerializationFeature |
serializationFeature |
Modifier and Type | Method and Description |
---|---|
StreamSOAPCodec |
copy()
Creates a copy of this
Codec . |
static StreamSOAPCodec |
create(SOAPVersion version) |
static StreamSOAPCodec |
create(WSBinding binding)
Deprecated.
|
static StreamSOAPCodec |
create(WSFeatureList features) |
void |
decode(InputStream in,
String contentType,
com.sun.xml.ws.api.message.Packet packet)
Reads bytes from
InputStream and constructs a Message . |
void |
decode(InputStream in,
String contentType,
com.sun.xml.ws.api.message.Packet packet,
com.sun.xml.ws.api.message.AttachmentSet att)
Reads root part bytes from
InputStream and constructs a Message
along with the given attachments. |
void |
decode(ReadableByteChannel in,
String contentType,
com.sun.xml.ws.api.message.Packet packet) |
void |
decode(ReadableByteChannel in,
String contentType,
com.sun.xml.ws.api.message.Packet response,
com.sun.xml.ws.api.message.AttachmentSet att) |
static com.sun.xml.ws.api.message.Message |
decode(SOAPVersion soapVersion,
XMLStreamReader reader,
com.sun.xml.ws.api.message.AttachmentSet attachmentSet) |
com.sun.xml.ws.api.message.Message |
decode(XMLStreamReader reader)
Decodes a message from
XMLStreamReader that points to
the beginning of a SOAP infoset. |
com.sun.xml.ws.api.message.Message |
decode(XMLStreamReader reader,
com.sun.xml.ws.api.message.AttachmentSet attachmentSet)
Decodes a message from
XMLStreamReader that points to
the beginning of a SOAP infoset. |
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(com.sun.xml.ws.api.message.Packet packet) |
protected ContentTypeImpl.Builder |
getContenTypeBuilder(com.sun.xml.ws.api.message.Packet packet) |
protected abstract String |
getDefaultContentType() |
protected abstract List<String> |
getExpectedContentTypes() |
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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getMimeType
protected final SerializationFeature serializationFeature
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.
protected abstract ContentType getContentType(com.sun.xml.ws.api.message.Packet packet)
protected abstract String getDefaultContentType()
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 packet) 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.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
.IOException
- if InputStream
throws an exception.@NotNull public final com.sun.xml.ws.api.message.Message decode(@NotNull XMLStreamReader reader)
XMLStreamReader
that points to
the beginning of a SOAP infoset.decode
in interface StreamSOAPCodec
reader
- can point to the start document or the start element.Message
for SOAP envelopepublic final com.sun.xml.ws.api.message.Message decode(XMLStreamReader reader, @NotNull com.sun.xml.ws.api.message.AttachmentSet attachmentSet)
XMLStreamReader
that points to
the beginning of a SOAP infoset.decode
in interface StreamSOAPCodec
reader
- can point to the start document or the start element.attachmentSet
- StreamSOAPCodec
can take attachments parsed outside,
so that this codec can be used as a part of a biggre codec
(like MIME multipart codec.)Message
for SOAP envelopepublic static final com.sun.xml.ws.api.message.Message decode(SOAPVersion soapVersion, XMLStreamReader reader, @NotNull com.sun.xml.ws.api.message.AttachmentSet attachmentSet)
public void decode(ReadableByteChannel in, String contentType, com.sun.xml.ws.api.message.Packet packet)
decode
in interface Codec
Codec.decode(InputStream, String, Packet)
public final StreamSOAPCodec copy()
Codec
Codec
.
Since Codec
instance is not re-entrant, the caller
who needs to encode two Message
s simultaneously will
want to have two Codec
instances. That's what this
method produces.
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.
copy
in interface Codec
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 Codec
s 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.
public void decode(InputStream in, String contentType, com.sun.xml.ws.api.message.Packet packet, com.sun.xml.ws.api.message.AttachmentSet att) throws IOException
RootOnlyCodec
InputStream
and constructs a Message
along with the given attachments.decode
in interface RootOnlyCodec
in
- root part's datacontentType
- root part's MIME content type (like "application/xml")packet
- the new created Message
is set in this packetatt
- attachmentsIOException
- if InputStream
throws an exception.public void decode(ReadableByteChannel in, String contentType, com.sun.xml.ws.api.message.Packet response, com.sun.xml.ws.api.message.AttachmentSet att)
decode
in interface RootOnlyCodec
RootOnlyCodec.decode(InputStream, String, Packet, AttachmentSet)
public static StreamSOAPCodec create(SOAPVersion version)
public static StreamSOAPCodec create(WSFeatureList features)
public static StreamSOAPCodec create(WSBinding binding)
create(WSFeatureList)
StreamSOAPCodec
instance using bindingprotected ContentTypeImpl.Builder getContenTypeBuilder(com.sun.xml.ws.api.message.Packet packet)
Copyright © 2015 Oracle Corporation. All rights reserved.