SecurityContextHolder + @async fixes and improvements (eugenp#930)

maibin · web-flow · commit 4018d45a2cca · 2017-01-02T11:06:44.000+01:00
* @async and Spring Security * @async with SecurityContext propagated * Spring and @async * Simulated Annealing algorithm * Simulated Annealing algorithm * Rebase * Rebase * SA further fixes * Slope One plus package refactoring * SlopeOne refactoring * Async improvements and fixes * Remove unnecessary bean * Final fixes to Spring Security @async * Async Spring MVC
diff --git a/spring-security-rest/src/main/java/org/baeldung/spring/SecurityJavaConfig.java b/spring-security-rest/src/main/java/org/baeldung/spring/SecurityJavaConfig.java
@@ -1,7 +1,6 @@
 package org.baeldung.spring;
 
 import org.baeldung.security.MySavedRequestAwareAuthenticationSuccessHandler;
-import org.springframework.beans.factory.config.MethodInvokingFactoryBean;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
@@ -25,6 +24,7 @@ public class SecurityJavaConfig extends WebSecurityConfigurerAdapter {
 
     public SecurityJavaConfig() {
         super();
+        SecurityContextHolder.setStrategyName(SecurityContextHolder.MODE_INHERITABLETHREADLOCAL);
     }
 
     //
@@ -47,7 +47,7 @@ protected void configure(final HttpSecurity http) throws Exception {// @formatte
         .antMatchers("/api/csrfAttacker*").permitAll()
         .antMatchers("/api/customer/**").permitAll()
         .antMatchers("/api/foos/**").authenticated()
-        .antMatchers("/api/async/**").authenticated()
+        .antMatchers("/api/async/**").permitAll()
         .and()
         .httpBasic()
 //        .and()
@@ -66,14 +66,5 @@ public MySavedRequestAwareAuthenticationSuccessHandler mySuccessHandler() {
     public SimpleUrlAuthenticationFailureHandler myFailureHandler() {
         return new SimpleUrlAuthenticationFailureHandler();
     }
-    
-    @Bean
-    public MethodInvokingFactoryBean methodInvokingFactoryBean() {
-        MethodInvokingFactoryBean methodInvokingFactoryBean = new MethodInvokingFactoryBean();
-        methodInvokingFactoryBean.setTargetClass(SecurityContextHolder.class);
-        methodInvokingFactoryBean.setTargetMethod("setStrategyName");
-        methodInvokingFactoryBean.setArguments(new String[]{SecurityContextHolder.MODE_INHERITABLETHREADLOCAL});
-        return methodInvokingFactoryBean;
-    }
 
 }
diff --git a/spring-security-rest/src/main/java/org/baeldung/spring/WebConfig.java b/spring-security-rest/src/main/java/org/baeldung/spring/WebConfig.java
@@ -3,6 +3,7 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.scheduling.annotation.EnableAsync;
 import org.springframework.web.servlet.ViewResolver;
 import org.springframework.web.servlet.config.annotation.EnableWebMvc;
 import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
@@ -13,12 +14,13 @@
 @Configuration
 @ComponentScan("org.baeldung.web")
 @EnableWebMvc
+@EnableAsync
 public class WebConfig extends WebMvcConfigurerAdapter {
 
     public WebConfig() {
         super();
     }
-
+    
     @Override
     public void addResourceHandlers(final ResourceHandlerRegistry registry) {
         registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
diff --git a/spring-security-rest/src/main/java/org/baeldung/web/controller/AsyncController.java b/spring-security-rest/src/main/java/org/baeldung/web/controller/AsyncController.java
@@ -2,36 +2,38 @@
 
 import java.util.concurrent.Callable;
 
+import org.apache.log4j.Logger;
 import org.baeldung.web.service.AsyncService;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.ResponseBody;
-import org.springframework.web.multipart.MultipartFile;
 
 @Controller
 public class AsyncController {
-	
+
+	private static final Logger log = Logger.getLogger(AsyncService.class);
+
 	@Autowired
 	private AsyncService asyncService;
 
-	@RequestMapping(method = RequestMethod.POST, value = "/upload")
-	public Callable<Boolean> processUpload(final MultipartFile file) {
-
-		return new Callable<Boolean>() {
-			public Boolean call() throws Exception {
-				// ...
-				return true;
-			}
-		};
+	@RequestMapping(method = RequestMethod.GET, value = "/async")
+	@ResponseBody
+	public Object standardProcessing() throws Exception {
+		log.info("Outside the @Async logic - before the async call: "
+				+ SecurityContextHolder.getContext().getAuthentication().getPrincipal());
+		asyncService.asyncCall();
+		log.info("Inside the @Async logic - after the async call: "
+				+ SecurityContextHolder.getContext().getAuthentication().getPrincipal());
+		return SecurityContextHolder.getContext().getAuthentication().getPrincipal();
 	}
 	
-	@RequestMapping(method = RequestMethod.GET, value = "/async")
+	@RequestMapping(method = RequestMethod.GET, value = "/async2")
 	@ResponseBody
-	public Boolean checkIfContextPropagated() throws Exception{
-		return asyncService.checkIfPrincipalPropagated().call() && asyncService.checkIfContextPropagated(SecurityContextHolder.getContext());
+	public Callable<Boolean> springMVCAsyncTest() {
+		return asyncService.checkIfPrincipalPropagated();
 	}
 
 }
diff --git a/spring-security-rest/src/main/java/org/baeldung/web/service/AsyncService.java b/spring-security-rest/src/main/java/org/baeldung/web/service/AsyncService.java
@@ -4,8 +4,8 @@
 
 public interface AsyncService {
 	
+	void asyncCall();
+	
 	Callable<Boolean> checkIfPrincipalPropagated();
 	
-	Boolean checkIfContextPropagated(Object context);
-
 }
diff --git a/spring-security-rest/src/main/java/org/baeldung/web/service/AsyncServiceImpl.java b/spring-security-rest/src/main/java/org/baeldung/web/service/AsyncServiceImpl.java
@@ -12,25 +12,25 @@ public class AsyncServiceImpl implements AsyncService {
 
 	private static final Logger log = Logger.getLogger(AsyncService.class);
 
+	@Async
 	@Override
-	public Callable<Boolean> checkIfPrincipalPropagated() {
-		Object before = SecurityContextHolder.getContext().getAuthentication().getPrincipal();
-		log.info("Before new thread: " + before);
-		return new Callable<Boolean>() {
-			public Boolean call() throws Exception {
-				Object after = SecurityContextHolder.getContext().getAuthentication().getPrincipal();
-				log.info("New thread: " + after);
-				return before == after;
-			}
-		};
+	public void asyncCall() {
+		log.info("Inside the @Async logic: " + SecurityContextHolder.getContext().getAuthentication().getPrincipal());
 	}
 
-	@Async
 	@Override
-	public Boolean checkIfContextPropagated(Object context) {
-		log.info("Before @Async: " + context);
-		log.info("Inside @Async: " + SecurityContextHolder.getContext());
-		return context == SecurityContextHolder.getContext();
-	}
+	public Callable<Boolean> checkIfPrincipalPropagated() {
+	    Object before 
+	      = SecurityContextHolder.getContext().getAuthentication().getPrincipal();
+	    log.info("Before new thread: " + before);
 
+	    return new Callable<Boolean>() {
+	        public Boolean call() throws Exception {
+	            Object after 
+	              = SecurityContextHolder.getContext().getAuthentication().getPrincipal();
+	            log.info("New thread: " + after);
+	            return before == after;
+	        }
+	    };
+	}
 }
diff --git a/spring-security-rest/src/main/resources/webSecurityConfig.xml b/spring-security-rest/src/main/resources/webSecurityConfig.xml
@@ -34,9 +34,4 @@
 		</authentication-provider>
 	</authentication-manager>
 
-	<beans:bean
-		class="org.springframework.beans.factory.config.MethodInvoki‌​ngFactoryBean"
-		p:targetClass="org.springframework.security.core.context.Sec‌​urityContextHolder"
-		p:targetMethod="setStrategyName" p:arguments="MODE_INHERITABLETHREADLOCAL" />
-
 </beans:beans>
diff --git a/spring-security-rest/src/main/webapp/WEB-INF/web.xml b/spring-security-rest/src/main/webapp/WEB-INF/web.xml
@@ -32,6 +32,7 @@
 			<param-name>throwExceptionIfNoHandlerFound</param-name>
 			<param-value>true</param-value>
 		</init-param>
+		<async-supported>true</async-supported>
 	</servlet>
 	<servlet-mapping>
 		<servlet-name>api</servlet-name>
@@ -42,12 +43,13 @@
 	<filter>
 		<filter-name>springSecurityFilterChain</filter-name>
 		<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
+		<async-supported>true</async-supported>
 	</filter>
 	<filter-mapping>
 		<filter-name>springSecurityFilterChain</filter-name>
 		<url-pattern>/*</url-pattern>
 		<dispatcher>REQUEST</dispatcher>
-		<dispatcher>ASYNC</dispatcher>
+   	    <dispatcher>ASYNC</dispatcher>
 	</filter-mapping>
 
 	<!-- <welcome-file-list> -->
diff --git a/spring-security-rest/src/test/java/org/baeldung/web/AsyncControllerTest.java b/spring-security-rest/src/test/java/org/baeldung/web/AsyncControllerTest.java
@@ -12,7 +12,6 @@
 import org.mockito.Mock;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.mock.web.MockHttpSession;
-import org.springframework.mock.web.MockMultipartFile;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 import org.springframework.test.context.web.WebAppConfiguration;
@@ -42,10 +41,8 @@ public void setup() {
 	}
 
 	@Test
-	public void testProcessUpload() throws Exception {
-		MockMultipartFile jsonFile = new MockMultipartFile("json", "", "application/json",
-				"{\"json\": \"someValue\"}".getBytes());
-		mockMvc.perform(MockMvcRequestBuilders.fileUpload("/upload").file(jsonFile)).andExpect(status().isOk());
+	public void testAsync() throws Exception {
+		mockMvc.perform(MockMvcRequestBuilders.get("/async")).andExpect(status().is5xxServerError());
 	}
 
 }

Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,8 @@`
`4`	`4`
`5`	`5`	`public interface AsyncService {`
`6`	`6`
	`7`	`+ void asyncCall();`
	`8`	`+`
`7`	`9`	`Callable<Boolean> checkIfPrincipalPropagated();`
`8`	`10`
`9`		`- Boolean checkIfContextPropagated(Object context);`
`10`		`-`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,6 @@`
`12`	`12`	`import org.mockito.Mock;`
`13`	`13`	`import org.springframework.beans.factory.annotation.Autowired;`
`14`	`14`	`import org.springframework.mock.web.MockHttpSession;`
`15`		`-import org.springframework.mock.web.MockMultipartFile;`
`16`	`15`	`import org.springframework.test.context.ContextConfiguration;`
`17`	`16`	`import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;`
`18`	`17`	`import org.springframework.test.context.web.WebAppConfiguration;`
`@@ -42,10 +41,8 @@ public void setup() {`
`42`	`41`	`}`
`43`	`42`
`44`	`43`	`@Test`
`45`		`- public void testProcessUpload() throws Exception {`
`46`		`- MockMultipartFile jsonFile = new MockMultipartFile("json", "", "application/json",`
`47`		`- "{\"json\": \"someValue\"}".getBytes());`
`48`		`- mockMvc.perform(MockMvcRequestBuilders.fileUpload("/upload").file(jsonFile)).andExpect(status().isOk());`
	`44`	`+ public void testAsync() throws Exception {`
	`45`	`+ mockMvc.perform(MockMvcRequestBuilders.get("/async")).andExpect(status().is5xxServerError());`
`49`	`46`	`}`
`50`	`47`
`51`	`48`	`}`