Package org.apache.juneau.marshall.msgpack

Class MsgPackParser

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.parser.Parser

org.apache.juneau.marshall.parser.InputStreamParser

org.apache.juneau.marshall.msgpack.MsgPackParser

All Implemented Interfaces:

MsgPackMetaProvider, ArrayRecordReadable, RecordReadable, TokenReadable

Direct Known Subclasses:

MsgPackParser.Base64, MsgPackParser.SpacedHex

public class MsgPackParser
extends InputStreamParser
implements MsgPackMetaProvider, TokenReadable, ArrayRecordReadable

Parses a MessagePack stream into a POJO model.

Media types

Handles Content-Type types: application/msgpack, octal/msgpack

The legacy media type octal/msgpack is retained as a backward-compatibility alias so that existing wire values still decode. New consumers should prefer the RFC-standard application/msgpack value.

Description

MessagePack-to-Java type mapping:

• MessagePack map → bean or Map
• MessagePack array → Collection or Java array
• MessagePack string → String; coerced to types parseable from string
• MessagePack boolean → Boolean
• MessagePack int → Integer; coerced to Long, Short, Byte as needed
• MessagePack float → Float or Double
• MessagePack binary → byte[]
• MessagePack nil → null

Notes:

• This class is thread safe and reusable.

See Also:

• MessagePack

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MsgPackParser.Base64	Default parser, string input encoded as BASE64.
static class	MsgPackParser.Builder	Builder class.
static class	MsgPackParser.SpacedHex	Default parser, string input encoded as spaced-hex.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.InputStreamParser

InputStreamParser.DefaultBuilder

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.Parser

Parser.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final MsgPackParser	DEFAULT	Default parser, all default settings.
static final MsgPackParser	DEFAULT_BASE64	Default parser, all default settings, string input encoded as BASE64.
static final MsgPackParser	DEFAULT_NATIVE	Default parser with binary-native opt-in mode enabled (MsgPack ext type byte surfaces as token-level metadata).
static final MsgPackParser	DEFAULT_SPACED_HEX	Default parser, all default settings, string input encoded as spaced-hex.
protected final boolean	nativeMode

Fields inherited from class org.apache.juneau.marshall.parser.Parser

autoCloseStreams, consumes, debugOutputLines, listener, nulls, trimStrings, unbuffered

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
MsgPackParser(MsgPackParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
MsgPackParser.Builder	copy()	Creates a builder from this context object.
static MsgPackParser.Builder	create()	Creates a new builder for this object.
MsgPackParserSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
int	getMaxLength()	Returns the maximum allowed wire-declared length (in bytes) for binary and string payloads.
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.
MsgPackParserSession	getSession()	Returns a session to use for this context.
boolean	isNativeMode()	Returns true if token-cursor native mode is enabled.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.
RecordReader	readArrayRecords(Object input)	Convenience delegator for the array-element RecordReader (uses default session args; see readTokens(Object)).
TokenReader	readTokens(Object input)	Convenience delegator that opens a MsgPackTokenReader over the input using default session arguments (mirrors Parser.read(Object, Class)).

Methods inherited from class org.apache.juneau.marshall.parser.InputStreamParser

getBinaryFormat, isReaderParser

Methods inherited from class org.apache.juneau.marshall.parser.Parser

canHandle, createParserBuilder, doRead, getDebugOutputLines, getListener, getMediaTypes, getNulls, getPrimaryMediaType, isAutoCloseStreams, isTrimStrings, isUnbuffered, read, read, read, read, read, read, readArgs, readIntoCollection, readIntoMap, readWithOuter

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 org.apache.juneau.marshall.stream.ArrayRecordReadable

isArrayRecordStreaming, readArrayRecords

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

isRecordStreaming

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

readRecords

Field Details

DEFAULT

public static final MsgPackParser DEFAULT

Default parser, all default settings.

DEFAULT_NATIVE

public static final MsgPackParser DEFAULT_NATIVE

Default parser with binary-native opt-in mode enabled (MsgPack ext type byte surfaces as token-level metadata).

DEFAULT_SPACED_HEX

public static final MsgPackParser DEFAULT_SPACED_HEX

Default parser, all default settings, string input encoded as spaced-hex.

DEFAULT_BASE64

public static final MsgPackParser DEFAULT_BASE64

Default parser, all default settings, string input encoded as BASE64.

nativeMode

protected final boolean nativeMode

Constructor Details

MsgPackParser

public MsgPackParser(MsgPackParser.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static MsgPackParser.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

isNativeMode

public boolean isNativeMode()

Returns true if token-cursor native mode is enabled.

Returns:

true if native mode is enabled, else false.

getMaxLength

public int getMaxLength()

Returns the maximum allowed wire-declared length (in bytes) for binary and string payloads.

Returns:

The maximum length in bytes.

copy

public MsgPackParser.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 Parser

Returns:

A new Builder object.

createSession

public MsgPackParserSession.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 InputStreamParser

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 MsgPackParserSession 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 InputStreamParser

Returns:

A new session object.

readTokens

public TokenReader readTokens(Object input)
                       throws IOException

Convenience delegator that opens a MsgPackTokenReader over the input using default session arguments (mirrors Parser.read(Object, Class)).

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

Specified by:

readTokens in interface TokenReadable

Parameters:

input - The input.

Returns:

A new MsgPackTokenReader.

Throws:

IOException - If a problem occurred opening the underlying input.

readArrayRecords

public RecordReader readArrayRecords(Object input)
                              throws IOException

Convenience delegator for the array-element RecordReader (uses default session args; see readTokens(Object)). Real impl on MsgPackParserSession.readArrayRecords(Object).

Specified by:

readArrayRecords in interface ArrayRecordReadable

Parameters:

input - The input.

Returns:

A new array-element RecordReader.

Throws:

IOException - If a problem occurred opening the underlying input.

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 Parser

Returns:

The properties on this bean as a map for debugging.