From 6f2b24a62bb5e2445529067fd60779302a25de72 Mon Sep 17 00:00:00 2001 From: Rob Winch Date: Thu, 1 Sep 2016 14:50:42 -0500 Subject: [PATCH] Polish JSON warnings / javadoc Issue gh-3736 --- .../security/cas/jackson2/CasJackson2Module.java | 2 +- .../security/jackson2/CoreJackson2Module.java | 4 ++-- .../security/jackson2/UnmodifiableSetMixin.java | 4 ++-- .../security/jackson2/UserDeserializer.java | 10 +++++----- ...sernamePasswordAuthenticationTokenDeserializer.java | 10 +++++----- .../jackson2/SimpleGrantedAuthorityMixinTests.java | 4 ---- .../security/web/jackson2/CookieDeserializer.java | 2 +- .../security/web/jackson2/DefaultCsrfTokenMixin.java | 6 +++--- .../security/web/jackson2/SavedCookieMixinTests.java | 1 + 9 files changed, 20 insertions(+), 23 deletions(-) diff --git a/cas/src/main/java/org/springframework/security/cas/jackson2/CasJackson2Module.java b/cas/src/main/java/org/springframework/security/cas/jackson2/CasJackson2Module.java index 8d7bf6046a..82d7054678 100644 --- a/cas/src/main/java/org/springframework/security/cas/jackson2/CasJackson2Module.java +++ b/cas/src/main/java/org/springframework/security/cas/jackson2/CasJackson2Module.java @@ -34,7 +34,7 @@ import org.springframework.security.jackson2.SecurityJacksonModules; * ObjectMapper mapper = new ObjectMapper(); * mapper.registerModule(new CasJackson2Module()); * - * Note: use {@link SecurityJacksonModules#getModules()} to get list of all security modules. + * Note: use {@link SecurityJacksonModules#getModules(ClassLoader)} to get list of all security modules on the classpath. * * @author Jitendra Singh. * @see org.springframework.security.jackson2.SecurityJacksonModules diff --git a/core/src/main/java/org/springframework/security/jackson2/CoreJackson2Module.java b/core/src/main/java/org/springframework/security/jackson2/CoreJackson2Module.java index 7db25de05f..7ae476d4f7 100644 --- a/core/src/main/java/org/springframework/security/jackson2/CoreJackson2Module.java +++ b/core/src/main/java/org/springframework/security/jackson2/CoreJackson2Module.java @@ -38,7 +38,7 @@ import java.util.Collections; * ObjectMapper mapper = new ObjectMapper(); * mapper.registerModule(new CoreJackson2Module()); * - * Note: use {@link SecurityJacksonModules#getModules()} to get list of all security modules. + * Note: use {@link SecurityJacksonModules#getModules(ClassLoader)} to get list of all security modules. * * @author Jitendra Singh. * @see SecurityJacksonModules @@ -56,7 +56,7 @@ public class CoreJackson2Module extends SimpleModule { context.setMixInAnnotations(AnonymousAuthenticationToken.class, AnonymousAuthenticationTokenMixin.class); context.setMixInAnnotations(RememberMeAuthenticationToken.class, RememberMeAuthenticationTokenMixin.class); context.setMixInAnnotations(SimpleGrantedAuthority.class, SimpleGrantedAuthorityMixin.class); - context.setMixInAnnotations(Collections.unmodifiableSet(Collections.EMPTY_SET).getClass(), UnmodifiableSetMixin.class); + context.setMixInAnnotations(Collections.unmodifiableSet(Collections.emptySet()).getClass(), UnmodifiableSetMixin.class); context.setMixInAnnotations(User.class, UserMixin.class); context.setMixInAnnotations(UsernamePasswordAuthenticationToken.class, UsernamePasswordAuthenticationTokenMixin.class); } diff --git a/core/src/main/java/org/springframework/security/jackson2/UnmodifiableSetMixin.java b/core/src/main/java/org/springframework/security/jackson2/UnmodifiableSetMixin.java index deb20e107c..746160b90b 100644 --- a/core/src/main/java/org/springframework/security/jackson2/UnmodifiableSetMixin.java +++ b/core/src/main/java/org/springframework/security/jackson2/UnmodifiableSetMixin.java @@ -40,8 +40,8 @@ class UnmodifiableSetMixin { /** * Mixin Constructor - * @param s + * @param s the Set */ @JsonCreator - UnmodifiableSetMixin(Set s) {} + UnmodifiableSetMixin(Set s) {} } diff --git a/core/src/main/java/org/springframework/security/jackson2/UserDeserializer.java b/core/src/main/java/org/springframework/security/jackson2/UserDeserializer.java index e0956d0713..c7cd3a2c59 100644 --- a/core/src/main/java/org/springframework/security/jackson2/UserDeserializer.java +++ b/core/src/main/java/org/springframework/security/jackson2/UserDeserializer.java @@ -46,11 +46,11 @@ class UserDeserializer extends JsonDeserializer { * serialized json, because credentials may be removed from the {@link User} by invoking {@link User#eraseCredentials()}. * In that case there won't be any password key in serialized json. * - * @param jp - * @param ctxt - * @return - * @throws IOException - * @throws JsonProcessingException + * @param jp the JsonParser + * @param ctxt the DeserializationContext + * @return the user + * @throws IOException if a exception during IO occurs + * @throws JsonProcessingException if an error during JSON processing occurs */ @Override public User deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException, JsonProcessingException { diff --git a/core/src/main/java/org/springframework/security/jackson2/UsernamePasswordAuthenticationTokenDeserializer.java b/core/src/main/java/org/springframework/security/jackson2/UsernamePasswordAuthenticationTokenDeserializer.java index e47e4c9629..450149e9bb 100644 --- a/core/src/main/java/org/springframework/security/jackson2/UsernamePasswordAuthenticationTokenDeserializer.java +++ b/core/src/main/java/org/springframework/security/jackson2/UsernamePasswordAuthenticationTokenDeserializer.java @@ -47,11 +47,11 @@ class UsernamePasswordAuthenticationTokenDeserializer extends JsonDeserializer savedCookies = (List)buildObjectMapper().readValue(expectedJson, Object.class);