org.glassfish.jersey.jackson

Class JacksonFeature

java.lang.Object

org.glassfish.jersey.jackson.internal.JaxrsFeatureBag<JacksonFeature>

org.glassfish.jersey.jackson.JacksonFeature

All Implemented Interfaces:

Feature

public class JacksonFeature
extends JaxrsFeatureBag<JacksonFeature>
implements Feature

Feature used to register Jackson JSON providers.

Author:

Stepan Kopriva, Michal Gajdos

Field Summary

Fields inherited from class org.glassfish.jersey.jackson.internal.JaxrsFeatureBag

JAXRS_FEATURE

Constructor Summary

Constructors

Constructor and Description
JacksonFeature() Default constructor enables registering Jackson's exception mappers

Method Summary

Modifier and Type	Method and Description
boolean	configure(FeatureContext context)
JacksonFeature	jaxrsFeature(JaxRSFeature feature, boolean state) Register JaxRSFeature with the Jackson providers.
JacksonFeature	maxStringLength(int maxStringLength) Sets the MessageProperties.JSON_MAX_STRING_LENGTH property to a provided value.
static JacksonFeature	withExceptionMappers() Create JacksonFeature with working Jackson's exception mappers
static JacksonFeature	withoutExceptionMappers() Create JacksonFeature without registered Jackson's exception mappers

Methods inherited from class org.glassfish.jersey.jackson.internal.JaxrsFeatureBag

hasJaxrsFeature

Methods inherited from class java.lang.Object

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

Constructor Detail

JacksonFeature

public JacksonFeature()

Default constructor enables registering Jackson's exception mappers

Method Detail

withExceptionMappers

public static JacksonFeature withExceptionMappers()

Create JacksonFeature with working Jackson's exception mappers

Returns:

JacksonFeature with working Jackson's exception mappers

withoutExceptionMappers

public static JacksonFeature withoutExceptionMappers()

Create JacksonFeature without registered Jackson's exception mappers

Returns:

JacksonFeature without registered Jackson's exception mappers

maxStringLength

public JacksonFeature maxStringLength(int maxStringLength)

Sets the MessageProperties.JSON_MAX_STRING_LENGTH property to a provided value. The property value already configured takes priority.

Both uses of maxStringLength(int) and MessageProperties.JSON_MAX_STRING_LENGTH override StreamReadConstraints defined on Jackson's ObjectMapper's JsonFactory provided via ContextResolver<ObjectMapper>.

Parameters:

maxStringLength - the integer value to override the default Jackson's StreamReadConstraints.DEFAULT_MAX_STRING_LEN.

Returns:

JacksonFeature that has the Jackson's StreamReadConstraints.DEFAULT_MAX_STRING_LEN set.

jaxrsFeature

public JacksonFeature jaxrsFeature(JaxRSFeature feature,
                                   boolean state)

Register JaxRSFeature with the Jackson providers.

Overrides:

jaxrsFeature in class JaxrsFeatureBag<JacksonFeature>

Parameters:

feature - the JaxRSFeature to be enabled or disabled.

state - true for enabling the feature, false for disabling.

Returns:

JacksonFeature with JaxRSFeature registered to be set on a created Jackson provider.

configure

public boolean configure(FeatureContext context)

Specified by:

configure in interface Feature