java.lang.Object
- com.fasterxml.jackson.jakarta.rs.base.ProviderBase<JacksonJsonProvider,ObjectMapper,JsonEndpointConfig,JsonMapperConfigurator>
- - com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider

All Implemented Interfaces:

Versioned, MessageBodyReader<Object>, MessageBodyWriter<Object>

Direct Known Subclasses:

JacksonXmlBindJsonProvider, ResteasyJackson2Provider
```
@Provider
@Consumes("*/*")
@Produces("*/*")
public class JacksonJsonProvider
extends ProviderBase<JacksonJsonProvider,ObjectMapper,JsonEndpointConfig,JsonMapperConfigurator>
```
Basic implementation of Jakarta-RS abstractions (MessageBodyReader, MessageBodyWriter) needed for binding JSON ("application/json") content to and from Java Objects ("POJO"s).
Actual data binding functionality is implemented by ObjectMapper: mapper to use can be configured in multiple ways:
- By explicitly passing mapper to use in constructor
- By explictly setting mapper to use by ProviderBase.setMapper(MAPPER)
- By defining Jakarta-RS Provider that returns ObjectMappers.
- By doing none of above, in which case a default mapper instance is constructed (and configured if configuration methods are called)
The last method ("do nothing specific") is often good enough; explicit passing of Mapper is simple and explicit; and Provider-based method may make sense with Dependency Injection frameworks, or if Mapper has to be configured differently for different media types.
Note that the default mapper instance will be automatically created if one of explicit configuration methods (like ProviderBase.configure(com.fasterxml.jackson.jakarta.rs.cfg.JakartaRSFeature, boolean)) is called: if so, Provider-based introspection is NOT used, but the resulting Mapper is used as configured.
There is also (JacksonXmlBindJsonProvider) which is configured by default to use both Jackson and Jakarta XmlBin annotations for configuration (base class when used as-is defaults to using just Jackson annotations)
Author:

Tatu Saloranta

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`_jsonpFunctionName`	JSONP function name to use for automatic JSONP wrapping, if any; if null, no JSONP wrapping is done.
`protected Providers`	`_providers`	Injectable context object used to locate configured instance of `ObjectMapper` to use for actual serialization.
`static Annotations[]`	`BASIC_ANNOTATIONS`	Default annotation sets to use, if not explicitly defined during construction: only Jackson annotations are used for the base class.
`static String`	`MIME_JAVASCRIPT`
`static String`	`MIME_JAVASCRIPT_MS`

Fields inherited from class com.fasterxml.jackson.jakarta.rs.base.ProviderBase
_cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jakartaRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS, JAKARTA_RS_FEATURE_DEFAULTS

Constructor Summary

Constructors
Constructor	Description
`JacksonJsonProvider()`	Default constructor, usually used when provider is automatically configured to be used with Jakarta-RS implementation.
`JacksonJsonProvider(ObjectMapper mapper)`
`JacksonJsonProvider(ObjectMapper mapper, Annotations[] annotationsToUse)`	Constructor to use when a custom mapper (usually components like serializer/deserializer factories that have been configured) is to be used.
`JacksonJsonProvider(Annotations... annotationsToUse)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected JsonEndpointConfig`	`_configForReading(ObjectReader reader, Annotation[] annotations)`
`protected JsonEndpointConfig`	`_configForWriting(ObjectWriter writer, Annotation[] annotations)`
`protected ObjectMapper`	`_locateMapperViaProvider(Class<?> type, MediaType mediaType)`	Helper method that is called if no mapper has been explicitly configured.
`protected boolean`	`hasMatchingMediaType(MediaType mediaType)`	Helper method used to check whether given media type is supported by this provider.
`void`	`setJSONPFunctionName(String fname)`
`Version`	`version()`	Method that will return version information stored in and read from jar that contains this class.

Methods inherited from class com.fasterxml.jackson.jakarta.rs.base.ProviderBase
_addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createNoContentException, _createParser, _endpointForReading, _endpointForWriting, _findCustomUntouchable, _isIgnorableForReading, _isIgnorableForWriting, _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, isReadable, isWriteable, locateMapper, readFrom, 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

- Field Detail
  - MIME_JAVASCRIPT
```
public static final String MIME_JAVASCRIPT
```
    See Also:
    
    Constant Field Values
  - MIME_JAVASCRIPT_MS
```
public static final String MIME_JAVASCRIPT_MS
```
    See Also:
    
    Constant Field Values
  - BASIC_ANNOTATIONS
```
public static final Annotations[] BASIC_ANNOTATIONS
```
    Default annotation sets to use, if not explicitly defined during construction: only Jackson annotations are used for the base class. Sub-classes can use other settings.
  - _jsonpFunctionName
```
protected String _jsonpFunctionName
```
    JSONP function name to use for automatic JSONP wrapping, if any; if null, no JSONP wrapping is done. Note that this is the default value that can be overridden on per-endpoint basis.
  - _providers
```
@Context
protected Providers _providers
```
    Injectable context object used to locate configured instance of ObjectMapper to use for actual serialization.
- Constructor Detail
  - JacksonJsonProvider
```
public JacksonJsonProvider()
```
    Default constructor, usually used when provider is automatically configured to be used with Jakarta-RS implementation.
  - JacksonJsonProvider
```
public JacksonJsonProvider(Annotations... annotationsToUse)
```
    Parameters:
    
    annotationsToUse - Annotation set(s) to use for configuring data binding
  - JacksonJsonProvider
```
public JacksonJsonProvider(ObjectMapper mapper)
```
  - JacksonJsonProvider
```
public JacksonJsonProvider(ObjectMapper mapper,
                           Annotations[] annotationsToUse)
```
    Constructor to use when a custom mapper (usually components like serializer/deserializer factories that have been configured) is to be used.
    
    Parameters:
    
    annotationsToUse - Sets of annotations (Jackson, XmlBind) that provider should support
- Method Detail
  - version
```
public Version version()
```
    Method that will return version information stored in and read from jar that contains this class.
    
    Returns:
    
    Version of the component
  - setJSONPFunctionName
```
public void setJSONPFunctionName(String fname)
```
  - hasMatchingMediaType
```
protected boolean hasMatchingMediaType(MediaType mediaType)
```
    Helper method used to check whether given media type is supported by this provider. Current implementation essentially checks to see whether MediaType.getSubtype() returns "json" or something ending with "+json". Or "text/x-json" (since 2.3)
    
    Specified by:
    
    hasMatchingMediaType in class ProviderBase<JacksonJsonProvider,ObjectMapper,JsonEndpointConfig,JsonMapperConfigurator>
    
    Since:
    
    2.2
  - _locateMapperViaProvider
```
protected ObjectMapper _locateMapperViaProvider(Class<?> type,
                                                MediaType mediaType)
```
    Description copied from class: ProviderBase
    
    Helper method that is called if no mapper has been explicitly configured.
    
    Specified by:
    
    _locateMapperViaProvider in class ProviderBase<JacksonJsonProvider,ObjectMapper,JsonEndpointConfig,JsonMapperConfigurator>
  - _configForReading
```
protected JsonEndpointConfig _configForReading(ObjectReader reader,
                                               Annotation[] annotations)
```
    Specified by:
    
    _configForReading in class ProviderBase<JacksonJsonProvider,ObjectMapper,JsonEndpointConfig,JsonMapperConfigurator>
  - _configForWriting
```
protected JsonEndpointConfig _configForWriting(ObjectWriter writer,
                                               Annotation[] annotations)
```
    Specified by:
    
    _configForWriting in class ProviderBase<JacksonJsonProvider,ObjectMapper,JsonEndpointConfig,JsonMapperConfigurator>

Class JacksonJsonProvider

Field Summary

Fields inherited from class com.fasterxml.jackson.jakarta.rs.base.ProviderBase

Constructor Summary

Method Summary

Methods inherited from class com.fasterxml.jackson.jakarta.rs.base.ProviderBase

Methods inherited from class java.lang.Object

Field Detail

MIME_JAVASCRIPT

MIME_JAVASCRIPT_MS

BASIC_ANNOTATIONS

_jsonpFunctionName

_providers

Constructor Detail

JacksonJsonProvider

JacksonJsonProvider

JacksonJsonProvider

JacksonJsonProvider

Method Detail

version

setJSONPFunctionName

hasMatchingMediaType

_locateMapperViaProvider

_configForReading

_configForWriting