net.java.truelicense.core.codec

Class XmlCodec

java.lang.Object

net.java.truelicense.core.codec.XmlCodec

All Implemented Interfaces:

Codec

Direct Known Subclasses:

X500PrincipalXmlCodec

@Immutable
public class XmlCodec
extends Object
implements Codec

A codec which encodes/decodes objects to/from XML with an XMLEncoder/XMLDecoder.

This type of codec is used for V1 format license keys.

Author:

Christian Schlichtherle

Constructor Summary

Constructors

Constructor and Description
XmlCodec()

Method Summary

Modifier and Type	Method and Description
String	contentTransferEncoding() Returns an identifier for the content transfer encoding used by this codec.
String	contentType() Returns an identifier for the content type used by this codec.
<T> T	decode(Source source, Type expected) Decodes a nullable object graph from the given source.
protected XMLDecoder	decoder(InputStream in) Returns a new XML decoder.
void	encode(Sink sink, Object obj) Encodes a nullable object graph to the given sink.
protected XMLEncoder	encoder(OutputStream out) Returns a new XML encoder.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlCodec

public XmlCodec()

Method Detail

contentTransferEncoding

public String contentTransferEncoding()

Returns an identifier for the content transfer encoding used by this codec. The returned string must conform to the syntax specified in RFC2045 "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies", Section 6.1 "Content-Transfer-Encoding Syntax", except that it must not start with "Content-Transfer-Encoding:" and optional spaces, i.e. the field name must be stripped.

If the Content-Transfer-Encoding equals (ignoring case) "8bit" and the Content-Type does not specify a charset parameter, then UTF-8 is assumed as the charset.

The implementation in the class XmlCodec returns "8bit".

Specified by:

contentTransferEncoding in interface Codec

See Also:

RFC 3023

contentType

public String contentType()

Returns an identifier for the content type used by this codec. The returned string must conform to the syntax specified in RFC2045 "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies", Section 5.1 "Syntax of the Content-Type Header Field", except that it must not start with "Content-Type:" and optional spaces, i.e. the field name must be stripped.

The implementation in the class XmlCodec returns "application/xml; charset=utf-8".

Specified by:

contentType in interface Codec

See Also:

RFC 3023

decode

@Nullable
public <T> T decode(Source source,
                              Type expected)
                       throws Exception

Description copied from interface: Codec

Decodes a nullable object graph from the given source.

Specified by:

decode in interface Codec

Type Parameters:

T - the expected generic type of the decoded object.

Parameters:

source - the source from where to read the encoded object graph from.

expected - the expected generic type of the decoded object graph, e.g. String.class. This is just a hint and the implementation may ignore it.

Returns:

A duplicate of the original object graph. Its actual type may differ from the expected generic type. It may be null if and only if the original object graph was null.

Throws:

Exception

decoder

protected XMLDecoder decoder(InputStream in)

Returns a new XML decoder.

encode

public void encode(Sink sink,
                   @Nullable
                   Object obj)
            throws Exception

Description copied from interface: Codec

Encodes a nullable object graph to the given sink.

Specified by:

encode in interface Codec

Parameters:

sink - the sink to write the encoded object graph to.

obj - the nullable object graph. Implementations should support encoding null. If they do not support this, then this should be documented in the Javadoc.

Throws:

Exception

encoder

protected XMLEncoder encoder(OutputStream out)

Returns a new XML encoder.