From 1042305cfe64f93eeb0fbfed38c8e3e6694c0d88 Mon Sep 17 00:00:00 2001
From: Luke Taylor <luke.taylor@springsource.com>
Date: Mon, 5 Oct 2009 16:59:37 +0000
Subject: [PATCH] Renamed web.wrapper to web.servletapi. Added some
 package.html files.

---
 .../security/config/http/DefaultFilterChainValidator.java   | 2 +-
 .../security/config/http/HttpConfigurationBuilder.java      | 2 +-
 .../security/config/FilterChainProxyConfigTests.java        | 2 +-
 .../config/http/HttpSecurityBeanDefinitionParserTests.java  | 2 +-
 .../org/springframework/security/util/filtertest-valid.xml  | 4 ++--
 .../test/resources/filter-chain-performance-app-context.xml | 2 +-
 .../src/main/webapp/WEB-INF/applicationContext-security.xml | 4 ++--
 .../security/web/authentication/session/package.html        | 5 +++++
 .../security/web/authentication/ui/package.html             | 6 ++++++
 .../security/web/authentication/www/package.html            | 5 +++++
 .../springframework/security/web/savedrequest/package.html  | 6 ++++--
 .../SecurityContextHolderAwareRequestFilter.java            | 2 +-
 .../SecurityContextHolderAwareRequestWrapper.java           | 2 +-
 .../security/web/{wrapper => servletapi}/package.html       | 0
 .../org/springframework/security/web/session/package.html   | 2 +-
 .../SecurityContextHolderAwareRequestFilterTests.java       | 4 +++-
 .../SecurityContextHolderAwareRequestWrapperTests.java      | 3 ++-
 17 files changed, 37 insertions(+), 16 deletions(-)
 create mode 100644 web/src/main/java/org/springframework/security/web/authentication/session/package.html
 create mode 100644 web/src/main/java/org/springframework/security/web/authentication/ui/package.html
 create mode 100644 web/src/main/java/org/springframework/security/web/authentication/www/package.html
 rename web/src/main/java/org/springframework/security/web/{wrapper => servletapi}/SecurityContextHolderAwareRequestFilter.java (97%)
 rename web/src/main/java/org/springframework/security/web/{wrapper => servletapi}/SecurityContextHolderAwareRequestWrapper.java (99%)
 rename web/src/main/java/org/springframework/security/web/{wrapper => servletapi}/package.html (100%)
 rename web/src/test/java/org/springframework/security/web/{wrapper => servletapi}/SecurityContextHolderAwareRequestFilterTests.java (90%)
 rename web/src/test/java/org/springframework/security/web/{wrapper => servletapi}/SecurityContextHolderAwareRequestWrapperTests.java (97%)

diff --git a/config/src/main/java/org/springframework/security/config/http/DefaultFilterChainValidator.java b/config/src/main/java/org/springframework/security/config/http/DefaultFilterChainValidator.java
index e8b5d50028..a55a59a835 100644
--- a/config/src/main/java/org/springframework/security/config/http/DefaultFilterChainValidator.java
+++ b/config/src/main/java/org/springframework/security/config/http/DefaultFilterChainValidator.java
@@ -19,8 +19,8 @@ import org.springframework.security.web.authentication.UsernamePasswordAuthentic
 import org.springframework.security.web.authentication.ui.DefaultLoginPageGeneratingFilter;
 import org.springframework.security.web.authentication.www.BasicProcessingFilter;
 import org.springframework.security.web.context.SecurityContextPersistenceFilter;
+import org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter;
 import org.springframework.security.web.session.SessionManagementFilter;
-import org.springframework.security.web.wrapper.SecurityContextHolderAwareRequestFilter;
 
 public class DefaultFilterChainValidator implements FilterChainProxy.FilterChainValidator {
     private Log logger = LogFactory.getLog(getClass());
diff --git a/config/src/main/java/org/springframework/security/config/http/HttpConfigurationBuilder.java b/config/src/main/java/org/springframework/security/config/http/HttpConfigurationBuilder.java
index cdcfd282cd..31e7297722 100644
--- a/config/src/main/java/org/springframework/security/config/http/HttpConfigurationBuilder.java
+++ b/config/src/main/java/org/springframework/security/config/http/HttpConfigurationBuilder.java
@@ -42,11 +42,11 @@ import org.springframework.security.web.authentication.session.ConcurrentSession
 import org.springframework.security.web.authentication.session.SessionFixationProtectionStrategy;
 import org.springframework.security.web.context.HttpSessionSecurityContextRepository;
 import org.springframework.security.web.context.SecurityContextPersistenceFilter;
+import org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter;
 import org.springframework.security.web.session.ConcurrentSessionFilter;
 import org.springframework.security.web.session.SessionManagementFilter;
 import org.springframework.security.web.util.AntUrlPathMatcher;
 import org.springframework.security.web.util.UrlMatcher;
-import org.springframework.security.web.wrapper.SecurityContextHolderAwareRequestFilter;
 import org.springframework.util.StringUtils;
 import org.springframework.util.xml.DomUtils;
 import org.w3c.dom.Element;
diff --git a/config/src/test/java/org/springframework/security/config/FilterChainProxyConfigTests.java b/config/src/test/java/org/springframework/security/config/FilterChainProxyConfigTests.java
index ce398aed0f..94142c05cb 100644
--- a/config/src/test/java/org/springframework/security/config/FilterChainProxyConfigTests.java
+++ b/config/src/test/java/org/springframework/security/config/FilterChainProxyConfigTests.java
@@ -36,7 +36,7 @@ import org.springframework.mock.web.MockHttpServletResponse;
 import org.springframework.security.web.FilterChainProxy;
 import org.springframework.security.web.authentication.UsernamePasswordAuthenticationProcessingFilter;
 import org.springframework.security.web.context.SecurityContextPersistenceFilter;
-import org.springframework.security.web.wrapper.SecurityContextHolderAwareRequestFilter;
+import org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter;
 
 /**
  * Tests {@link FilterChainProxy}.
diff --git a/config/src/test/java/org/springframework/security/config/http/HttpSecurityBeanDefinitionParserTests.java b/config/src/test/java/org/springframework/security/config/http/HttpSecurityBeanDefinitionParserTests.java
index 9cf40ca473..916303b9df 100644
--- a/config/src/test/java/org/springframework/security/config/http/HttpSecurityBeanDefinitionParserTests.java
+++ b/config/src/test/java/org/springframework/security/config/http/HttpSecurityBeanDefinitionParserTests.java
@@ -69,9 +69,9 @@ import org.springframework.security.web.context.HttpSessionSecurityContextReposi
 import org.springframework.security.web.context.SecurityContextPersistenceFilter;
 import org.springframework.security.web.savedrequest.HttpSessionRequestCache;
 import org.springframework.security.web.savedrequest.RequestCacheAwareFilter;
+import org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter;
 import org.springframework.security.web.session.ConcurrentSessionFilter;
 import org.springframework.security.web.session.SessionManagementFilter;
-import org.springframework.security.web.wrapper.SecurityContextHolderAwareRequestFilter;
 import org.springframework.util.ReflectionUtils;
 
 /**
diff --git a/config/src/test/resources/org/springframework/security/util/filtertest-valid.xml b/config/src/test/resources/org/springframework/security/util/filtertest-valid.xml
index aff02845c8..7e2a7823c3 100644
--- a/config/src/test/resources/org/springframework/security/util/filtertest-valid.xml
+++ b/config/src/test/resources/org/springframework/security/util/filtertest-valid.xml
@@ -24,9 +24,9 @@
     xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
 http://www.springframework.org/schema/security http://www.springframework.org/schema/security/spring-security-2.0.xsd">
 
-    <bean id="mockFilter" class="org.springframework.security.web.wrapper.SecurityContextHolderAwareRequestFilter"/>
+    <bean id="mockFilter" class="org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter"/>
 
-    <bean id="mockFilter2" class="org.springframework.security.web.wrapper.SecurityContextHolderAwareRequestFilter"/>
+    <bean id="mockFilter2" class="org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter"/>
 
     <!-- These are just here so we have filters of a specific type to check the ordering is as expected -->
     <bean id="sif" class="org.springframework.security.web.context.SecurityContextPersistenceFilter"/>
diff --git a/itest/context/src/test/resources/filter-chain-performance-app-context.xml b/itest/context/src/test/resources/filter-chain-performance-app-context.xml
index 02d82e02c5..d37b985bf0 100644
--- a/itest/context/src/test/resources/filter-chain-performance-app-context.xml
+++ b/itest/context/src/test/resources/filter-chain-performance-app-context.xml
@@ -52,7 +52,7 @@
         <property name="authenticationManager" ref="authenticationManager"/>
     </bean>
 
-    <bean id="scharf" class="org.springframework.security.web.wrapper.SecurityContextHolderAwareRequestFilter" />
+    <bean id="scharf" class="org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter" />
 
     <bean id="preAuthenticatedProcessingFilterEntryPoint"
             class="org.springframework.security.web.authentication.Http403ForbiddenEntryPoint"/>
diff --git a/samples/preauth/src/main/webapp/WEB-INF/applicationContext-security.xml b/samples/preauth/src/main/webapp/WEB-INF/applicationContext-security.xml
index ec0defb214..c6c1ddee35 100644
--- a/samples/preauth/src/main/webapp/WEB-INF/applicationContext-security.xml
+++ b/samples/preauth/src/main/webapp/WEB-INF/applicationContext-security.xml
@@ -88,8 +88,8 @@
 
     <bean id="roleVoter" class="org.springframework.security.access.vote.RoleVoter"/>
 
-    <bean id="securityContextHolderAwareRequestFilter" class="org.springframework.security.web.wrapper.SecurityContextHolderAwareRequestFilter">
-        <property name="wrapperClass" value="org.springframework.security.web.wrapper.SecurityContextHolderAwareRequestWrapper"/>
+    <bean id="securityContextHolderAwareRequestFilter" class="org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter">
+        <property name="wrapperClass" value="org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestWrapper"/>
     </bean>
 
 </beans>
diff --git a/web/src/main/java/org/springframework/security/web/authentication/session/package.html b/web/src/main/java/org/springframework/security/web/authentication/session/package.html
new file mode 100644
index 0000000000..a15f4a52b3
--- /dev/null
+++ b/web/src/main/java/org/springframework/security/web/authentication/session/package.html
@@ -0,0 +1,5 @@
+<html>
+<body>
+Strategy interface and implementations for handling session-related behaviour for a newly authenticated user.
+</body>
+</html>
diff --git a/web/src/main/java/org/springframework/security/web/authentication/ui/package.html b/web/src/main/java/org/springframework/security/web/authentication/ui/package.html
new file mode 100644
index 0000000000..079628f15a
--- /dev/null
+++ b/web/src/main/java/org/springframework/security/web/authentication/ui/package.html
@@ -0,0 +1,6 @@
+<html>
+<body>
+Authentication user-interface rendering code. Used to conveniently create an appropriate login page when using namespace
+configuration without defining a login page URL.
+</body>
+</html>
diff --git a/web/src/main/java/org/springframework/security/web/authentication/www/package.html b/web/src/main/java/org/springframework/security/web/authentication/www/package.html
new file mode 100644
index 0000000000..f23bf80f5c
--- /dev/null
+++ b/web/src/main/java/org/springframework/security/web/authentication/www/package.html
@@ -0,0 +1,5 @@
+<html>
+<body>
+Contains WWW-Authenticate based authentication mechanism implementations: Basic and Digest authentication.
+</body>
+</html>
diff --git a/web/src/main/java/org/springframework/security/web/savedrequest/package.html b/web/src/main/java/org/springframework/security/web/savedrequest/package.html
index 6264c5ee5a..4eb5c52d65 100644
--- a/web/src/main/java/org/springframework/security/web/savedrequest/package.html
+++ b/web/src/main/java/org/springframework/security/web/savedrequest/package.html
@@ -1,6 +1,8 @@
 <html>
 <body>
-Stores a <code>HttpServletRequest</code> so that it can subsequently be emulated by the
-<code>SavedRequestAwareWrapper</code>.
+Classes related top the caching of an <code>HttpServletRequest</code> which requires authentication. While the user is
+logging in, the request is cached (using the RequestCache implementation) by the ExceptionTranslationFilter.
+Once the user has been authenticated, the original request is restored following a redirect to a matching URL, and the
+RequestCache is queried to obtain the original (matching) request.
 </body>
 </html>
diff --git a/web/src/main/java/org/springframework/security/web/wrapper/SecurityContextHolderAwareRequestFilter.java b/web/src/main/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestFilter.java
similarity index 97%
rename from web/src/main/java/org/springframework/security/web/wrapper/SecurityContextHolderAwareRequestFilter.java
rename to web/src/main/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestFilter.java
index e266b6fd3e..298bebb97a 100644
--- a/web/src/main/java/org/springframework/security/web/wrapper/SecurityContextHolderAwareRequestFilter.java
+++ b/web/src/main/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestFilter.java
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-package org.springframework.security.web.wrapper;
+package org.springframework.security.web.servletapi;
 
 import java.io.IOException;
 
diff --git a/web/src/main/java/org/springframework/security/web/wrapper/SecurityContextHolderAwareRequestWrapper.java b/web/src/main/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestWrapper.java
similarity index 99%
rename from web/src/main/java/org/springframework/security/web/wrapper/SecurityContextHolderAwareRequestWrapper.java
rename to web/src/main/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestWrapper.java
index 0da855cd86..f179a0539b 100644
--- a/web/src/main/java/org/springframework/security/web/wrapper/SecurityContextHolderAwareRequestWrapper.java
+++ b/web/src/main/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestWrapper.java
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-package org.springframework.security.web.wrapper;
+package org.springframework.security.web.servletapi;
 
 
 import java.security.Principal;
diff --git a/web/src/main/java/org/springframework/security/web/wrapper/package.html b/web/src/main/java/org/springframework/security/web/servletapi/package.html
similarity index 100%
rename from web/src/main/java/org/springframework/security/web/wrapper/package.html
rename to web/src/main/java/org/springframework/security/web/servletapi/package.html
diff --git a/web/src/main/java/org/springframework/security/web/session/package.html b/web/src/main/java/org/springframework/security/web/session/package.html
index d7adceb97c..82e4ff8951 100644
--- a/web/src/main/java/org/springframework/security/web/session/package.html
+++ b/web/src/main/java/org/springframework/security/web/session/package.html
@@ -1,5 +1,5 @@
 <html>
 <body>
-HttpSession events and publisher classes.
+Session management filters, HttpSession events and publisher classes.
 </body>
 </html>
diff --git a/web/src/test/java/org/springframework/security/web/wrapper/SecurityContextHolderAwareRequestFilterTests.java b/web/src/test/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestFilterTests.java
similarity index 90%
rename from web/src/test/java/org/springframework/security/web/wrapper/SecurityContextHolderAwareRequestFilterTests.java
rename to web/src/test/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestFilterTests.java
index 5e0e4d1f3b..9ae7ce0728 100644
--- a/web/src/test/java/org/springframework/security/web/wrapper/SecurityContextHolderAwareRequestFilterTests.java
+++ b/web/src/test/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestFilterTests.java
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-package org.springframework.security.web.wrapper;
+package org.springframework.security.web.servletapi;
 
 import javax.servlet.FilterChain;
 import javax.servlet.http.HttpServletResponse;
@@ -24,6 +24,8 @@ import org.jmock.integration.junit4.JUnit4Mockery;
 import org.junit.Test;
 import org.springframework.mock.web.MockHttpServletRequest;
 import org.springframework.mock.web.MockHttpServletResponse;
+import org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter;
+import org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestWrapper;
 
 
 /**
diff --git a/web/src/test/java/org/springframework/security/web/wrapper/SecurityContextHolderAwareRequestWrapperTests.java b/web/src/test/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestWrapperTests.java
similarity index 97%
rename from web/src/test/java/org/springframework/security/web/wrapper/SecurityContextHolderAwareRequestWrapperTests.java
rename to web/src/test/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestWrapperTests.java
index b66bc139a6..915d25f3fa 100644
--- a/web/src/test/java/org/springframework/security/web/wrapper/SecurityContextHolderAwareRequestWrapperTests.java
+++ b/web/src/test/java/org/springframework/security/web/servletapi/SecurityContextHolderAwareRequestWrapperTests.java
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-package org.springframework.security.web.wrapper;
+package org.springframework.security.web.servletapi;
 
 import junit.framework.TestCase;
 
@@ -23,6 +23,7 @@ import org.springframework.security.core.Authentication;
 import org.springframework.security.core.authority.AuthorityUtils;
 import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.security.core.userdetails.User;
+import org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestWrapper;
 
 /**
  * Tests {@link SecurityContextHolderAwareRequestWrapper}.