Class SwACodec
- java.lang.Object
-
- com.sun.xml.ws.encoding.SwACodec
-
-
Field Summary
Fields Modifier and Type Field Description protected WSFeatureList
features
protected Codec
mimeRootCodec
static String
MULTIPART_RELATED_MIME_TYPE
protected SOAPVersion
version
-
Constructor Summary
Constructors Constructor Description SwACodec(SOAPVersion version, WSFeatureList f, Codec rootCodec)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SwACodec
copy()
Creates a copy of thisCodec
.protected void
decode(MimeMultipartParser mpp, Packet packet)
Parses aPacket
from aMimeMultipartParser
.void
decode(InputStream in, String contentType, Packet packet)
Reads bytes fromInputStream
and constructs aMessage
.void
decode(ReadableByteChannel in, String contentType, Packet packet)
ContentType
encode(Packet packet, OutputStream out)
Encodes an XML infoset portion of theMessage
(from <soap:Envelope> to </soap:Envelope>).ContentType
encode(Packet packet, WritableByteChannel buffer)
The version ofCodec.encode(Packet,OutputStream)
that writes to NIOByteBuffer
.protected Codec
getMimeRootCodec(Packet packet)
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.static void
writeAsAscii(String s, OutputStream out)
Writes a string as ASCII string.static void
writeln(OutputStream out)
static void
writeln(String s, OutputStream out)
-
-
-
Field Detail
-
MULTIPART_RELATED_MIME_TYPE
public static final String MULTIPART_RELATED_MIME_TYPE
- See Also:
- Constant Field Values
-
mimeRootCodec
protected Codec mimeRootCodec
-
version
protected final SOAPVersion version
-
features
protected final WSFeatureList features
-
-
Constructor Detail
-
SwACodec
public SwACodec(SOAPVersion version, WSFeatureList f, Codec rootCodec)
-
-
Method Detail
-
decode
protected void decode(MimeMultipartParser mpp, Packet packet) throws IOException
Parses aPacket
from aMimeMultipartParser
.- Throws:
IOException
-
encode
public ContentType encode(Packet packet, WritableByteChannel buffer)
Description copied from interface:Codec
The version ofCodec.encode(Packet,OutputStream)
that writes to NIOByteBuffer
.TODO: for the convenience of implementation, write an adapter that wraps
WritableByteChannel
toOutputStream
.
-
copy
public SwACodec copy()
Description copied from interface:Codec
Creates a copy of thisCodec
.Since
Codec
instance is not re-entrant, the caller who needs to encode twoMessage
s simultaneously will want to have twoCodec
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 interfaceCodec
- 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
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 returnthis
.
-
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 interfaceCodec
- Returns:
- null if the MIME type can't be determined by the
Codec
implementation. Otherwise the MIME type is returned.
-
encode
public ContentType encode(Packet packet, OutputStream out) throws IOException
Description copied from interface:Codec
Encodes an XML infoset portion of theMessage
(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 interfaceCodec
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 aOutputStream
throwsIOException
.
-
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
Codec
s that always use a constant content type, This method allows a transport to streamline the write operation.- Specified by:
getStaticContentType
in interfaceCodec
- 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".
-
decode
public void decode(InputStream in, String contentType, Packet packet) throws IOException
Description copied from interface:Codec
Reads bytes fromInputStream
and constructs aMessage
.The design encourages lazy decoding of a
Message
, where aMessage
is returned even before the whole message is parsed, and additional parsing is done as theMessage
body is read along. ACodec
is most likely have its own implementation ofMessage
for this purpose.- Specified by:
decode
in interfaceCodec
- Parameters:
in
- the data to be read into aMessage
. The transport would have read any transport-specific header before it passes anInputStream
, andInputStream
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 likemultipart/related; boundary="--=_outer_boundary"; type="multipart/alternative"
. This parameter must not be null.packet
- The parsedMessage
will be set to thisPacket
.Codec
may add additional properties to thisPacket
. On a successful method completion, aPacket
must contain aMessage
.- Throws:
IOException
- ifInputStream
throws an exception.
-
decode
public void decode(ReadableByteChannel in, String contentType, Packet packet)
- Specified by:
decode
in interfaceCodec
- See Also:
Codec.decode(InputStream, String, Packet)
-
writeln
public static void writeln(String s, OutputStream out) throws IOException
- Throws:
IOException
-
writeAsAscii
public static void writeAsAscii(String s, OutputStream out) throws IOException
Writes a string as ASCII string.- Throws:
IOException
-
writeln
public static void writeln(OutputStream out) throws IOException
- Throws:
IOException
-
-