Cwikius-Spring
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish SecurityJacksonModules 

Issue gh-3736
* ClassLoader argument - this is required because we do not want to assume
the ClassLoader that should be used
* Clean up logging - logging is now at debug level because we don't expect
all of the modules are loaded (they are quite possibly off the ClassPath)
* Remove ObjectUtils as it was being used on methods that expect a
Collection or Array with non collection based objects
* Polish Javadoc warnings
This commit is contained in:
Rob Winch 2016-09-01 14:59:35 -05:00
parent c2d8ea92d0
commit 3fb77f3b59
8 changed files with 30 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
cas/src/test/java/org/springframework/security/cas/jackson2/CasAuthenticationTokenMixinTests.java
View File

@ -71,8 +71,9 @@ public class CasAuthenticationTokenMixinTests {
}
ObjectMapper buildObjectMapper() {
ClassLoader loader = getClass().getClassLoader();
ObjectMapper mapper = new ObjectMapper();
mapper.registerModules(SecurityJacksonModules.getModules());
mapper.registerModules(SecurityJacksonModules.getModules(loader));
return mapper;
}

34
core/src/main/java/org/springframework/security/jackson2/SecurityJacksonModules.java
View File

@ -23,7 +23,6 @@ import com.fasterxml.jackson.databind.jsontype.TypeResolverBuilder;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.util.ClassUtils;
import org.springframework.util.ObjectUtils;
import java.util.ArrayList;
import java.util.Arrays;
@ -63,41 +62,42 @@ public final class SecurityJacksonModules {
}
public static void enableDefaultTyping(ObjectMapper mapper) {
if(!ObjectUtils.isEmpty(mapper)) {
if(mapper != null) {
TypeResolverBuilder<?> typeBuilder = mapper.getDeserializationConfig().getDefaultTyper(null);
if (ObjectUtils.isEmpty(typeBuilder)) {
if (typeBuilder == null) {
mapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY);
}
}
}
private static Module loadAndGetInstance(String className) {
@SuppressWarnings("unchecked")
private static Module loadAndGetInstance(String className, ClassLoader loader) {
Module instance = null;
try {
logger.debug("Loading module " + className);
Class<? extends Module> securityModule = (Class<? extends Module>) ClassUtils.forName(className, ClassUtils.getDefaultClassLoader());
if (!ObjectUtils.isEmpty(securityModule)) {
logger.debug("Loaded module " + className + ", now registering");
Class<? extends Module> securityModule = (Class<? extends Module>) ClassUtils.forName(className, loader);
if (securityModule != null) {
if(logger.isDebugEnabled()) {
logger.debug("Loaded module " + className + ", now registering");
}
instance = securityModule.newInstance();
}
} catch (ClassNotFoundException e) {
logger.warn("Module class not found : " + e.getMessage());
} catch (InstantiationException e) {
logger.error(e.getMessage());
} catch (IllegalAccessException e) {
logger.error(e.getMessage());
} catch (Exception e) {
if(logger.isDebugEnabled()) {
logger.debug("Cannot load module " + className, e);
}
}
return instance;
}
/**
* @param loader the ClassLoader to use
* @return List of available security modules in classpath.
*/
public static List<Module> getModules() {
public static List<Module> getModules(ClassLoader loader) {
List<Module> modules = new ArrayList<Module>();
for (String className : securityJackson2ModuleClasses) {
Module module = loadAndGetInstance(className);
if (!ObjectUtils.isEmpty(module)) {
Module module = loadAndGetInstance(className, loader);
if (module != null) {
modules.add(module);
}
}

3
core/src/test/java/org/springframework/security/jackson2/AbstractMixinTests.java
View File

@ -37,7 +37,8 @@ public abstract class AbstractMixinTests {
protected ObjectMapper buildObjectMapper() {
if (ObjectUtils.isEmpty(mapper)) {
mapper = new ObjectMapper();
mapper.registerModules(SecurityJacksonModules.getModules());
ClassLoader loader = getClass().getClassLoader();
mapper.registerModules(SecurityJacksonModules.getModules(loader));
}
return mapper;
}

2
web/src/main/java/org/springframework/security/web/jackson2/WebJackson2Module.java
View File

@ -37,7 +37,7 @@ import javax.servlet.http.Cookie;
* ObjectMapper mapper = new ObjectMapper();
* mapper.registerModule(new WebJackson2Module());
* </pre>
* <b>Note: use {@link SecurityJacksonModules#getModules()} to get list of all security modules.</b>
* <b>Note: use {@link SecurityJacksonModules#getModules(ClassLoader)} to get list of all security modules.</b>
*
* @author Jitendra Singh
* @see SecurityJacksonModules

3
web/src/test/java/org/springframework/security/web/jackson2/AbstractMixinTests.java
View File

@ -34,7 +34,8 @@ public abstract class AbstractMixinTests {
protected ObjectMapper buildObjectMapper() {
if (ObjectUtils.isEmpty(mapper)) {
mapper = new ObjectMapper();
mapper.registerModules(SecurityJacksonModules.getModules());
ClassLoader loader = getClass().getClassLoader();
mapper.registerModules(SecurityJacksonModules.getModules(loader));
}
return mapper;
}

3
web/src/test/java/org/springframework/security/web/jackson2/CookieMixinTests.java
View File

@ -39,7 +39,8 @@ public class CookieMixinTests {
ObjectMapper buildObjectMapper() {
ObjectMapper mapper = new ObjectMapper();
mapper.registerModules(SecurityJacksonModules.getModules());
ClassLoader loader = getClass().getClassLoader();
mapper.registerModules(SecurityJacksonModules.getModules(loader));
return mapper;
}

3
web/src/test/java/org/springframework/security/web/jackson2/DefaultCsrfTokenMixinTests.java
View File

@ -45,7 +45,8 @@ public class DefaultCsrfTokenMixinTests {
@Before
public void setup() {
objectMapper = new ObjectMapper();
objectMapper.registerModules(SecurityJacksonModules.getModules());
ClassLoader loader = getClass().getClassLoader();
objectMapper.registerModules(SecurityJacksonModules.getModules(loader));
defaultCsrfTokenJson = "{\"@class\": \"org.springframework.security.web.csrf.DefaultCsrfToken\", " +
"\"headerName\": \"csrf-header\", \"parameterName\": \"_csrf\", \"token\": \"1\"}";
}

3
web/src/test/java/org/springframework/security/web/jackson2/WebAuthenticationDetailsMixinTests.java
View File

@ -48,7 +48,8 @@ public class WebAuthenticationDetailsMixinTests {
@Before
public void setup() {
this.mapper = new ObjectMapper();
this.mapper.registerModules(SecurityJacksonModules.getModules());
ClassLoader loader = getClass().getClassLoader();
this.mapper.registerModules(SecurityJacksonModules.getModules(loader));
}
@Test