jackson.adoc 1.7 KB

1234567891011121314151617181920212223242526272829303132
  1. [[jackson]]
  2. = Jackson Support
  3. Spring Security provides Jackson support for persisting Spring Security-related classes.
  4. This can improve the performance of serializing Spring Security-related classes when working with distributed sessions (session replication, Spring Session, and so on).
  5. To use it, register the `SecurityJackson2Modules.getModules(ClassLoader)` with `ObjectMapper` (https://github.com/FasterXML/jackson-databind[jackson-databind]):
  6. ====
  7. [source,java]
  8. ----
  9. ObjectMapper mapper = new ObjectMapper();
  10. ClassLoader loader = getClass().getClassLoader();
  11. List<Module> modules = SecurityJackson2Modules.getModules(loader);
  12. mapper.registerModules(modules);
  13. // ... use ObjectMapper as normally ...
  14. SecurityContext context = new SecurityContextImpl();
  15. // ...
  16. String json = mapper.writeValueAsString(context);
  17. ----
  18. ====
  19. [NOTE]
  20. ====
  21. The following Spring Security modules provide Jackson support:
  22. - spring-security-core ({security-api-url}org/springframework/security/jackson2/CoreJackson2Module.html[`CoreJackson2Module`])
  23. - spring-security-web ({security-api-url}org/springframework/security/web/jackson2/WebJackson2Module.html[`WebJackson2Module`], {security-api-url}org/springframework/security/web/jackson2/WebServletJackson2Module.html[`WebServletJackson2Module`], {security-api-url}org/springframework/security/web/server/jackson2/WebServerJackson2Module.html[`WebServerJackson2Module`])
  24. - <<oauth2client, spring-security-oauth2-client>> ({security-api-url}org/springframework/security/oauth2/client/jackson2/OAuth2ClientJackson2Module.html[`OAuth2ClientJackson2Module`])
  25. - spring-security-cas ({security-api-url}org/springframework/security/cas/jackson2/CasJackson2Module.html[`CasJackson2Module`])
  26. ====