Package org.apache.juneau.marshall.msgpack

Annotation Interface MsgPackConfig

@Target({TYPE,METHOD})
@Retention(RUNTIME)
@Inherited
@ContextApply({SerializerApply.class,ParserApply.class})
public @interface MsgPackConfig

Annotation for specifying config properties defined in MsgPackSerializer and MsgPackParser.

Used primarily for specifying bean configuration properties on REST classes and methods.

See Also:

• MessagePack

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	addBeanTypes	Add "_type" properties when needed.
String	maxLength	Maximum allowed wire-declared length (in bytes) for MessagePack binary and string payloads when parsing.
int	rank	Optional rank for this config.

Element Details

addBeanTypes

String addBeanTypes

Add "_type" properties when needed.

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

When present, this value overrides the Serializer.Builder#addBeanTypes() setting and is provided to customize the behavior of specific serializers in a SerializerSet.

• "true"
• "false" (default)

Notes:

• Supports VarResolver.DEFAULT (e.g. "$C{myConfigVar}").

See Also:

• MsgPackSerializer.Builder.addBeanTypesMsgPack()

Returns:

The annotation value.

Default:

""

maxLength

String maxLength

Maximum allowed wire-declared length (in bytes) for MessagePack binary and string payloads when parsing.

Guards against malformed or adversarial input where a small payload declares a huge length. Default is "16777216" (16 MiB). A value of "0" or less disables the cap.

Returns:

The annotation value.

Default:

""

rank

int rank

Optional rank for this config.

Can be used to override default ordering and application of config annotations.

Returns:

The annotation value.

Default:

0