io.jsonwebtoken.jackson.io

Class JacksonDeserializer<T>

java.lang.Object

io.jsonwebtoken.io.AbstractDeserializer<T>

io.jsonwebtoken.jackson.io.JacksonDeserializer<T>

All Implemented Interfaces:

Deserializer<T>

public class JacksonDeserializer<T>
extends AbstractDeserializer<T>

Deserializer using a Jackson ObjectMapper.

Since:

0.10.0

Field Summary

Fields inherited from class io.jsonwebtoken.io.AbstractDeserializer

EOF

Constructor Summary

Constructors

Constructor and Description
JacksonDeserializer() Constructor using JJWT's default ObjectMapper singleton for deserialization.
JacksonDeserializer(Map<String,Class<?>> claimTypeMap) Creates a new JacksonDeserializer where the values of the claims can be parsed into given types.
JacksonDeserializer(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Constructor using the specified Jackson ObjectMapper.
JacksonDeserializer(com.fasterxml.jackson.databind.ObjectMapper objectMapper, Map<String,Class<?>> claimTypeMap) Creates a new JacksonDeserializer where the values of the claims can be parsed into given types by registering a type-converting Module on the specified ObjectMapper.

Method Summary

Methods

Modifier and Type	Method and Description
protected T	doDeserialize(Reader reader)

Methods inherited from class io.jsonwebtoken.io.AbstractDeserializer

deserialize, deserialize

Methods inherited from class java.lang.Object

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

Constructor Detail

JacksonDeserializer

public JacksonDeserializer()

Constructor using JJWT's default ObjectMapper singleton for deserialization.

JacksonDeserializer

public JacksonDeserializer(Map<String,Class<?>> claimTypeMap)

Creates a new JacksonDeserializer where the values of the claims can be parsed into given types. A common usage example is to parse custom User object out of a claim, for example the claims:

{
     "issuer": "https://issuer.example.com",
     "user": {
         "firstName": "Jill",
         "lastName": "Coder"
     }
 }

Passing a map of ["user": User.class] to this constructor would result in the user claim being transformed to an instance of your custom User class, instead of the default of Map.

Because custom type parsing requires modifying the state of a Jackson ObjectMapper, this constructor creates a new internal ObjectMapper instance and customizes it to support the specified claimTypeMap. This ensures that the JJWT parsing behavior does not unexpectedly modify the state of another application-specific ObjectMapper.

If you would like to use your own ObjectMapper instance that also supports custom types for JWT Claims, you will need to first customize your ObjectMapper instance by registering your custom types and then use the JacksonDeserializer(ObjectMapper) constructor instead.

Parameters:

claimTypeMap - The claim name-to-class map used to deserialize claims into the given type

JacksonDeserializer

public JacksonDeserializer(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Constructor using the specified Jackson ObjectMapper.

Parameters:

objectMapper - the ObjectMapper to use for deserialization.

JacksonDeserializer

public JacksonDeserializer(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                   Map<String,Class<?>> claimTypeMap)

Creates a new JacksonDeserializer where the values of the claims can be parsed into given types by registering a type-converting Module on the specified ObjectMapper. A common usage example is to parse custom User object out of a claim, for example the claims:

{
     "issuer": "https://issuer.example.com",
     "user": {
         "firstName": "Jill",
         "lastName": "Coder"
     }
 }

Passing a map of ["user": User.class] to this constructor would result in the user claim being transformed to an instance of your custom User class, instead of the default of Map.

Because custom type parsing requires modifying the state of a Jackson ObjectMapper, this constructor modifies the specified objectMapper argument and customizes it to support the specified claimTypeMap.

If you do not want your ObjectMapper instance modified, but also want to support custom types for JWT Claims, you will need to first customize your ObjectMapper instance by registering your custom types separately and then use the JacksonDeserializer(ObjectMapper) constructor instead (which does not modify the objectMapper argument).

Parameters:

objectMapper - the objectMapper to modify by registering a custom type-converting Module

claimTypeMap - The claim name-to-class map used to deserialize claims into the given type

Since:

0.13.0

Method Detail

doDeserialize

protected T doDeserialize(Reader reader)
                   throws Exception

Specified by:

doDeserialize in class AbstractDeserializer<T>

Throws:

Exception