From 06fdb83fb89840c511b2bc46f72b7c49229c9dab Mon Sep 17 00:00:00 2001 From: Joe Grandja Date: Wed, 18 Mar 2020 13:59:40 -0400 Subject: [PATCH] Document Jackson serialization support for OAuth 2.0 Client Fixes gh-8075 --- .../_includes/servlet/integrations/jackson.adoc | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/manual/src/docs/asciidoc/_includes/servlet/integrations/jackson.adoc b/docs/manual/src/docs/asciidoc/_includes/servlet/integrations/jackson.adoc index 247fc8e6b8..9e6418a175 100644 --- a/docs/manual/src/docs/asciidoc/_includes/servlet/integrations/jackson.adoc +++ b/docs/manual/src/docs/asciidoc/_includes/servlet/integrations/jackson.adoc @@ -1,10 +1,10 @@ [[jackson]] == Jackson Support -Spring Security has added Jackson Support for persisting Spring Security related classes. +Spring Security provides Jackson support for persisting Spring Security related classes. This can improve the performance of serializing Spring Security related classes when working with distributed sessions (i.e. session replication, Spring Session, etc). -To use it, register the `SecurityJackson2Modules.getModules(ClassLoader)` as https://wiki.fasterxml.com/JacksonFeatureModules[Jackson Modules]. +To use it, register the `SecurityJackson2Modules.getModules(ClassLoader)` with `ObjectMapper` (https://github.com/FasterXML/jackson-databind[jackson-databind]): [source,java] ---- @@ -18,3 +18,13 @@ SecurityContext context = new SecurityContextImpl(); // ... String json = mapper.writeValueAsString(context); ---- + +[NOTE] +==== +The following Spring Security modules provide Jackson support: + +- spring-security-core (`CoreJackson2Module`) +- spring-security-web (`WebJackson2Module`, `WebServletJackson2Module`, `WebServerJackson2Module`) +- <> (`OAuth2ClientJackson2Module`) +- spring-security-cas (`CasJackson2Module`) +====