io.dropwizard.jersey.jackson

Class JacksonMessageBodyProvider

java.lang.Object

com.fasterxml.jackson.jaxrs.base.ProviderBase<com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider,com.fasterxml.jackson.databind.ObjectMapper,com.fasterxml.jackson.jaxrs.json.JsonEndpointConfig,com.fasterxml.jackson.jaxrs.json.JsonMapperConfigurator>

com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider

com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider

io.dropwizard.jersey.jackson.JacksonMessageBodyProvider

All Implemented Interfaces:

com.fasterxml.jackson.core.Versioned, javax.ws.rs.ext.MessageBodyReader<Object>, javax.ws.rs.ext.MessageBodyWriter<Object>

public class JacksonMessageBodyProvider
extends com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider

A Jersey provider which enables using Jackson to parse request entities into objects and generate response entities from objects. Any request entity method parameters annotated with @Valid are validated, and an informative 422 Unprocessable Entity response is returned should the entity be invalid.

(Essentially, extends JacksonJaxbJsonProvider with validation and support for JsonIgnoreType.)

Field Summary

Fields inherited from class com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider

DEFAULT_ANNOTATIONS

Fields inherited from class com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider

_jsonpFunctionName, _providers, BASIC_ANNOTATIONS, MIME_JAVASCRIPT, MIME_JAVASCRIPT_MS

Fields inherited from class com.fasterxml.jackson.jaxrs.base.ProviderBase

_cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jaxRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS

Constructor Summary

Constructors

Constructor and Description
JacksonMessageBodyProvider(com.fasterxml.jackson.databind.ObjectMapper mapper, javax.validation.Validator validator)

Method Summary

Methods

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
boolean	isReadable(Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)
boolean	isWriteable(Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)
Object	readFrom(Class<Object> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders, InputStream entityStream)

Methods inherited from class com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider

_configForReading, _configForReading, _configForWriting, _configForWriting, _locateMapperViaProvider, hasMatchingMediaType, isJsonType, setJSONPFunctionName, version

Methods inherited from class com.fasterxml.jackson.jaxrs.base.ProviderBase

_addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createParser, _findCustomUntouchable, _isSpecialReadable, _modifyHeaders, addUntouchable, checkCanDeserialize, checkCanSerialize, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, findEncoding, findSuperTypes, findSuperTypes, getSize, hasMatchingMediaTypeForReading, hasMatchingMediaTypeForWriting, isEnabled, locateMapper, removeUntouchable, setAnnotationsToUse, setDefaultReadView, setDefaultView, setDefaultWriteView, setMapper, writeTo

Methods inherited from class java.lang.Object

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

Constructor Detail

JacksonMessageBodyProvider

public JacksonMessageBodyProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
                          javax.validation.Validator validator)

Method Detail

isReadable

public boolean isReadable(Class<?> type,
                 Type genericType,
                 Annotation[] annotations,
                 javax.ws.rs.core.MediaType mediaType)

Specified by:

isReadable in interface javax.ws.rs.ext.MessageBodyReader<Object>

Overrides:

isReadable in class com.fasterxml.jackson.jaxrs.base.ProviderBase<com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider,com.fasterxml.jackson.databind.ObjectMapper,com.fasterxml.jackson.jaxrs.json.JsonEndpointConfig,com.fasterxml.jackson.jaxrs.json.JsonMapperConfigurator>

readFrom

public Object readFrom(Class<Object> type,
              Type genericType,
              Annotation[] annotations,
              javax.ws.rs.core.MediaType mediaType,
              javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders,
              InputStream entityStream)
                throws IOException

Specified by:

readFrom in interface javax.ws.rs.ext.MessageBodyReader<Object>

Overrides:

readFrom in class com.fasterxml.jackson.jaxrs.base.ProviderBase<com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider,com.fasterxml.jackson.databind.ObjectMapper,com.fasterxml.jackson.jaxrs.json.JsonEndpointConfig,com.fasterxml.jackson.jaxrs.json.JsonMapperConfigurator>

Throws:

IOException

isWriteable

public boolean isWriteable(Class<?> type,
                  Type genericType,
                  Annotation[] annotations,
                  javax.ws.rs.core.MediaType mediaType)

Specified by:

isWriteable in interface javax.ws.rs.ext.MessageBodyWriter<Object>

Overrides:

isWriteable in class com.fasterxml.jackson.jaxrs.base.ProviderBase<com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider,com.fasterxml.jackson.databind.ObjectMapper,com.fasterxml.jackson.jaxrs.json.JsonEndpointConfig,com.fasterxml.jackson.jaxrs.json.JsonMapperConfigurator>

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()