Package org.apache.juneau.marshall.msgpack

Class MsgPackSerializer

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.MarshallingTraverseContext

org.apache.juneau.marshall.serializer.Serializer

org.apache.juneau.marshall.serializer.OutputStreamSerializer

org.apache.juneau.marshall.msgpack.MsgPackSerializer

All Implemented Interfaces:

Function<Object,byte[]>, ThrowingFunction<Object,byte[]>, MsgPackMetaProvider, ArrayRecordWritable, RecordWritable, TokenWritable

Direct Known Subclasses:

MsgPackSerializer.Base64, MsgPackSerializer.SpacedHex

public class MsgPackSerializer
extends OutputStreamSerializer
implements MsgPackMetaProvider, TokenWritable, ArrayRecordWritable

Serializes POJO models to MessagePack.

Media types:

Handles Accept types: application/msgpack, octal/msgpack

Produces Content-Type types: application/msgpack

The legacy media type octal/msgpack is retained in the Accept list as a backward-compatibility alias. The Content-Type emitted by the serializer is always the RFC-standard application/msgpack value.

Description

Java-to-MessagePack type mapping:

• Maps and beans → MessagePack map type
• Collections and arrays → MessagePack array type
• String / Enum → MessagePack string type
• Boolean → MessagePack boolean type
• Number (int, long, float, double, etc.) → MessagePack number type (variable-length int or float)
• Date / Calendar / Instant → ISO 8601 string
• Duration → ISO 8601 duration string
• byte[] → MessagePack binary type
• null → MessagePack nil type
• All other types → fallback to toString() as string

Notes:

• This class is thread safe and reusable.

See Also:

• MessagePack

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MsgPackSerializer.Base64	Default serializer, BASE64 string output.
static class	MsgPackSerializer.Builder	Builder class.
static class	MsgPackSerializer.SpacedHex	Default serializer, spaced-hex string output.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.serializer.OutputStreamSerializer

OutputStreamSerializer.DefaultBuilder

Nested classes/interfaces inherited from class org.apache.juneau.marshall.serializer.Serializer

Serializer.Null

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	addBeanTypesMsgPack
static final MsgPackSerializer	DEFAULT	Default serializer, all default settings.
static final MsgPackSerializer	DEFAULT_BASE64	Default serializer, all default settings, spaced-hex string output.
static final MsgPackSerializer	DEFAULT_SPACED_HEX	Default serializer, all default settings, spaced-hex string output.

Fields inherited from class org.apache.juneau.marshall.serializer.Serializer

accept, addBeanTypes, addRootType, keepNullProperties, listener, nonDefault, produces, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
MsgPackSerializer(MsgPackSerializer.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
MsgPackSerializer.Builder	copy()	Creates a builder from this context object.
static MsgPackSerializer.Builder	create()	Creates a new builder for this object.
MsgPackSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
MsgPackBeanPropertyMeta	getMsgPackBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
MsgPackClassMeta	getMsgPackClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
MsgPackSerializerSession	getSession()	Returns a session to use for this context.
protected final boolean	isAddBeanTypes()	Add "_type" properties when needed.
boolean	isArrayRecordStreaming()	Streaming-quality signal queryable before opening a cursor.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.
RecordWriter	writeArrayRecords(Object output)	Convenience delegator for the buffered array-element RecordWriter (uses default session args; see writeTokens(Object)).
RecordWriter	writeArrayRecords(Object output, int expectedCount)	Convenience delegator for the streaming, count-prefixed array-element RecordWriter (uses default session args; see writeTokens(Object)).
TokenWriter	writeTokens(Object output)	Convenience delegator that opens a MsgPackTokenWriter over the output using default session arguments (mirrors OutputStreamSerializer.write(Object)).

Methods inherited from class org.apache.juneau.marshall.serializer.OutputStreamSerializer

applyThrows, getBinaryFormat, isWriterSerializer, write

Methods inherited from class org.apache.juneau.marshall.serializer.Serializer

createSerializerBuilder, doWrite, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, write, writeToString

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseContext

getDetectRecursions, getIgnoreRecursions, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions, shouldDetectRecursions

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable

getDurationFormat, getMarshallingContext, getPeriodFormat

Methods inherited from class org.apache.juneau.marshall.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.apache.juneau.marshall.stream.RecordWritable

isRecordStreaming

Methods inherited from interface org.apache.juneau.commons.function.ThrowingFunction

apply

Methods inherited from interface org.apache.juneau.marshall.stream.TokenWritable

writeRecords

Field Details

DEFAULT

public static final MsgPackSerializer DEFAULT

Default serializer, all default settings.

DEFAULT_SPACED_HEX

public static final MsgPackSerializer DEFAULT_SPACED_HEX

Default serializer, all default settings, spaced-hex string output.

DEFAULT_BASE64

public static final MsgPackSerializer DEFAULT_BASE64

Default serializer, all default settings, spaced-hex string output.

addBeanTypesMsgPack

protected final boolean addBeanTypesMsgPack

Constructor Details

MsgPackSerializer

public MsgPackSerializer(MsgPackSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static MsgPackSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public MsgPackSerializer.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class Serializer

Returns:

A new Builder object.

createSession

public MsgPackSerializerSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class OutputStreamSerializer

Returns:

A new session builder.

getMsgPackBeanPropertyMeta

public MsgPackBeanPropertyMeta getMsgPackBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: MsgPackMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getMsgPackBeanPropertyMeta in interface MsgPackMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getMsgPackClassMeta

public MsgPackClassMeta getMsgPackClassMeta(ClassMeta<?> cm)

Description copied from interface: MsgPackMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getMsgPackClassMeta in interface MsgPackMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getSession

public MsgPackSerializerSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class OutputStreamSerializer

Returns:

A new session object.

writeTokens

public TokenWriter writeTokens(Object output)
                        throws IOException

Convenience delegator that opens a MsgPackTokenWriter over the output using default session arguments (mirrors OutputStreamSerializer.write(Object)).

The real implementation lives on MsgPackSerializerSession.writeTokens(Object). Callers that need request-derived configuration (locale, timezone, schema, swaps) should call createSession() and invoke MsgPackSerializerSession.writeTokens(Object) on the built session instead.

Specified by:

writeTokens in interface TokenWritable

Parameters:

output - The output.

Returns:

A new MsgPackTokenWriter.

Throws:

IOException - If the output type is not supported or could not be opened.

isAddBeanTypes

protected final boolean isAddBeanTypes()

Description copied from class: Serializer

Add "_type" properties when needed.

Overrides:

isAddBeanTypes in class Serializer

Returns:

true if "_type" properties added to beans if their type cannot be inferred through reflection.

See Also:

• Serializer.Builder.addBeanTypes()

properties

protected FluentMap<String,Object> properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class Serializer

Returns:

The properties on this bean as a map for debugging.

writeArrayRecords

public RecordWriter writeArrayRecords(Object output)
                               throws IOException

Convenience delegator for the buffered array-element RecordWriter (uses default session args; see writeTokens(Object)). Real impl on MsgPackSerializerSession.writeArrayRecords(Object).

Specified by:

writeArrayRecords in interface ArrayRecordWritable

Parameters:

output - The output.

Returns:

A buffered RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

isArrayRecordStreaming

public boolean isArrayRecordStreaming()

Description copied from interface: ArrayRecordWritable

Streaming-quality signal queryable before opening a cursor.

Specified by:

isArrayRecordStreaming in interface ArrayRecordWritable

Returns:

true for true element streaming (json/cbor/msgpack); false for the buffered RecordAdapter.arrayWriter(org.apache.juneau.marshall.serializer.SerializerSession, java.lang.Object)-backed formats (yaml, parquet, bson).

writeArrayRecords

public RecordWriter writeArrayRecords(Object output,
 int expectedCount)
                               throws IOException

Convenience delegator for the streaming, count-prefixed array-element RecordWriter (uses default session args; see writeTokens(Object)). Real impl on MsgPackSerializerSession.writeArrayRecords(Object, int).

Specified by:

writeArrayRecords in interface ArrayRecordWritable

Parameters:

output - The output (must be an OutputStream).

expectedCount - The number of elements that will be written.

Returns:

A streaming RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.