Package org.springframework.security.oauth2.client.jackson2

Class OAuth2ClientJackson2Module

  • All Implemented Interfaces:
    com.fasterxml.jackson.core.Versioned, java.io.Serializable
    public class OAuth2ClientJackson2Module
extends com.fasterxml.jackson.databind.module.SimpleModule
    Jackson Module for spring-security-oauth2-client, that registers the following mix-in annotations:
    • OAuth2AuthorizationRequestMixin
    • ClientRegistrationMixin
    • OAuth2AccessTokenMixin
    • OAuth2RefreshTokenMixin
    • OAuth2AuthorizedClientMixin
    • OAuth2UserAuthorityMixin
    • DefaultOAuth2UserMixin
    • OidcIdTokenMixin
    • OidcUserInfoMixin
    • OidcUserAuthorityMixin
    • DefaultOidcUserMixin
    • OAuth2AuthenticationTokenMixin
    • OAuth2AuthenticationExceptionMixin
    • OAuth2ErrorMixin
    If not already enabled, default typing will be automatically enabled as type info is required to properly serialize/deserialize objects. In order to use this module just add it to your ObjectMapper configuration. 
         ObjectMapper mapper = new ObjectMapper();
     mapper.registerModule(new OAuth2ClientJackson2Module());
    NOTE: Use SecurityJackson2Modules.getModules(ClassLoader) to get a list of all security modules.
    Since:
    5.3
    See Also:
    SecurityJackson2Modules, OAuth2AuthorizationRequestMixin, ClientRegistrationMixin, OAuth2AccessTokenMixin, OAuth2RefreshTokenMixin, OAuth2AuthorizedClientMixin, OAuth2UserAuthorityMixin, DefaultOAuth2UserMixin, OidcIdTokenMixin, OidcUserInfoMixin, OidcUserAuthorityMixin, DefaultOidcUserMixin, OAuth2AuthenticationTokenMixin, OAuth2AuthenticationExceptionMixin, OAuth2ErrorMixin, Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.Module

        com.fasterxml.jackson.databind.Module.SetupContext

    • Field Summary

      • Fields inherited from class com.fasterxml.jackson.databind.module.SimpleModule

        _abstractTypes, _deserializerModifier, _deserializers, _keyDeserializers, _keySerializers, _mixins, _name, _namingStrategy, _serializerModifier, _serializers, _subtypes, _valueInstantiators, _version

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void setupModule​(com.fasterxml.jackson.databind.Module.SetupContext context)  

      • Methods inherited from class com.fasterxml.jackson.databind.module.SimpleModule

        _checkNotNull, addAbstractTypeMapping, addDeserializer, addKeyDeserializer, addKeySerializer, addSerializer, addSerializer, addValueInstantiator, getModuleName, getTypeId, registerSubtypes, registerSubtypes, registerSubtypes, setAbstractTypes, setDeserializerModifier, setDeserializers, setKeyDeserializers, setKeySerializers, setMixInAnnotation, setNamingStrategy, setSerializerModifier, setSerializers, setValueInstantiators, version

      • Methods inherited from class com.fasterxml.jackson.databind.Module

        getDependencies

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • OAuth2ClientJackson2Module

        public OAuth2ClientJackson2Module()

    • Method Detail

      • setupModule

        public void setupModule​(com.fasterxml.jackson.databind.Module.SetupContext context)
        Overrides:
        setupModule in class com.fasterxml.jackson.databind.module.SimpleModule