From 5f993e5627ad1f2bf8de2bae86f941bb77110c8b Mon Sep 17 00:00:00 2001
From: Luke Taylor <luke.taylor@springsource.com>
Date: Wed, 29 Aug 2007 11:51:02 +0000
Subject: [PATCH] SEC-534: Refactored JaasAuthenticationProvider to use
 ApplicationPublisherAware rather than ApplicationContextAware.

---
 .../jaas/JaasAuthenticationProvider.java      | 38 ++++++++-----------
 .../jaas/JaasAuthenticationProviderTests.java |  8 ++--
 2 files changed, 20 insertions(+), 26 deletions(-)

diff --git a/core/src/main/java/org/acegisecurity/providers/jaas/JaasAuthenticationProvider.java b/core/src/main/java/org/acegisecurity/providers/jaas/JaasAuthenticationProvider.java
index 48e97fefe4..8264eb6183 100644
--- a/core/src/main/java/org/acegisecurity/providers/jaas/JaasAuthenticationProvider.java
+++ b/core/src/main/java/org/acegisecurity/providers/jaas/JaasAuthenticationProvider.java
@@ -36,10 +36,7 @@ import org.apache.commons.logging.LogFactory;
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.InitializingBean;
 
-import org.springframework.context.ApplicationContext;
-import org.springframework.context.ApplicationContextAware;
-import org.springframework.context.ApplicationEvent;
-import org.springframework.context.ApplicationListener;
+import org.springframework.context.*;
 
 import org.springframework.core.io.Resource;
 
@@ -140,20 +137,20 @@ import javax.security.auth.login.LoginException;
  * @author Ray Krueger
  * @version $Id$
  */
-public class JaasAuthenticationProvider implements AuthenticationProvider, InitializingBean, ApplicationContextAware,
-    ApplicationListener {
+public class JaasAuthenticationProvider implements AuthenticationProvider, ApplicationEventPublisherAware,
+        InitializingBean, ApplicationListener {
     //~ Static fields/initializers =====================================================================================
 
     protected static final Log log = LogFactory.getLog(JaasAuthenticationProvider.class);
 
     //~ Instance fields ================================================================================================
 
-    private ApplicationContext context;
     private LoginExceptionResolver loginExceptionResolver = new DefaultLoginExceptionResolver();
     private Resource loginConfig;
     private String loginContextName = "ACEGI";
     private AuthorityGranter[] authorityGranters;
     private JaasAuthenticationCallbackHandler[] callbackHandlers;
+    private ApplicationEventPublisher applicationEventPublisher;
 
     //~ Methods ========================================================================================================
 
@@ -246,10 +243,9 @@ public class JaasAuthenticationProvider implements AuthenticationProvider, Initi
      *
      * @param loginConfig URL to Jaas login configuration
      *
-     * @throws IOException DOCUMENT ME!
+     * @throws IOException if there is a problem reading the config resource.
      */
-    protected void configureJaas(Resource loginConfig)
-        throws IOException {
+    protected void configureJaas(Resource loginConfig) throws IOException {
         configureJaasUsingLoop();
     }
 
@@ -257,7 +253,6 @@ public class JaasAuthenticationProvider implements AuthenticationProvider, Initi
      * Loops through the login.config.url.1,login.config.url.2 properties looking for the login configuration.
      * If it is not set, it will be set to the last available login.config.url.X property.
      *
-     * @throws IOException DOCUMENT ME!
      */
     private void configureJaasUsingLoop() throws IOException {
         String loginConfigUrl = loginConfig.getURL().toString();
@@ -284,10 +279,6 @@ public class JaasAuthenticationProvider implements AuthenticationProvider, Initi
         }
     }
 
-    public ApplicationContext getApplicationContext() {
-        return context;
-    }
-
     /**
      * Returns the AuthorityGrannter array that was passed to the {@link
      * #setAuthorityGranters(AuthorityGranter[])} method, or null if it none were ever set.
@@ -375,7 +366,7 @@ public class JaasAuthenticationProvider implements AuthenticationProvider, Initi
      * @param ase The {@link AcegiSecurityException} that caused the failure
      */
     protected void publishFailureEvent(UsernamePasswordAuthenticationToken token, AcegiSecurityException ase) {
-        getApplicationContext().publishEvent(new JaasAuthenticationFailedEvent(token, ase));
+        applicationEventPublisher.publishEvent(new JaasAuthenticationFailedEvent(token, ase));
     }
 
     /**
@@ -385,12 +376,7 @@ public class JaasAuthenticationProvider implements AuthenticationProvider, Initi
      * @param token The {@link UsernamePasswordAuthenticationToken} being processed
      */
     protected void publishSuccessEvent(UsernamePasswordAuthenticationToken token) {
-        getApplicationContext().publishEvent(new JaasAuthenticationSuccessEvent(token));
-    }
-
-    public void setApplicationContext(ApplicationContext applicationContext)
-        throws BeansException {
-        this.context = applicationContext;
+        applicationEventPublisher.publishEvent(new JaasAuthenticationSuccessEvent(token));
     }
 
     /**
@@ -445,6 +431,14 @@ public class JaasAuthenticationProvider implements AuthenticationProvider, Initi
         return UsernamePasswordAuthenticationToken.class.isAssignableFrom(aClass);
     }
 
+    public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
+        this.applicationEventPublisher = applicationEventPublisher;
+    }
+
+    protected ApplicationEventPublisher getApplicationEventPublisher() {
+        return applicationEventPublisher;
+    }
+
     //~ Inner Classes ==================================================================================================
 
     /**
diff --git a/core/src/test/java/org/acegisecurity/providers/jaas/JaasAuthenticationProviderTests.java b/core/src/test/java/org/acegisecurity/providers/jaas/JaasAuthenticationProviderTests.java
index 195c44051e..3027ef9924 100644
--- a/core/src/test/java/org/acegisecurity/providers/jaas/JaasAuthenticationProviderTests.java
+++ b/core/src/test/java/org/acegisecurity/providers/jaas/JaasAuthenticationProviderTests.java
@@ -99,7 +99,7 @@ public class JaasAuthenticationProviderTests extends TestCase {
 
     public void testDetectsMissingLoginConfig() throws Exception {
         JaasAuthenticationProvider myJaasProvider = new JaasAuthenticationProvider();
-        myJaasProvider.setApplicationContext(context);
+        myJaasProvider.setApplicationEventPublisher(context);
         myJaasProvider.setAuthorityGranters(jaasProvider.getAuthorityGranters());
         myJaasProvider.setCallbackHandlers(jaasProvider.getCallbackHandlers());
         myJaasProvider.setLoginContextName(jaasProvider.getLoginContextName());
@@ -114,7 +114,7 @@ public class JaasAuthenticationProviderTests extends TestCase {
 
     public void testDetectsMissingLoginContextName() throws Exception {
         JaasAuthenticationProvider myJaasProvider = new JaasAuthenticationProvider();
-        myJaasProvider.setApplicationContext(context);
+        myJaasProvider.setApplicationEventPublisher(context);
         myJaasProvider.setAuthorityGranters(jaasProvider.getAuthorityGranters());
         myJaasProvider.setCallbackHandlers(jaasProvider.getCallbackHandlers());
         myJaasProvider.setLoginConfig(jaasProvider.getLoginConfig());
@@ -185,8 +185,8 @@ public class JaasAuthenticationProviderTests extends TestCase {
         assertNull("Failure event was fired", eventCheck.failedEvent);
     }
 
-    public void testGetApplicationContext() throws Exception {
-        assertNotNull(jaasProvider.getApplicationContext());
+    public void testGetApplicationEventPublisher() throws Exception {
+        assertNotNull(jaasProvider.getApplicationEventPublisher());
     }
 
     public void testLoginExceptionResolver() {