From a9567a58d81fcd41911580bea0f73f4afed60c27 Mon Sep 17 00:00:00 2001 From: Luke Taylor Date: Wed, 13 Jan 2010 15:36:58 +0000 Subject: [PATCH] SEC-1359,SEC-1360,SEC-1361,SEC-1363,SEC-1364,SEC-1365,SEC-1366,SEC-1367: Minor doc and Javadoc typos. --- docs/manual/src/docbook/appendix-namespace.xml | 2 +- docs/manual/src/docbook/core-filters.xml | 6 +++--- docs/manual/src/docbook/core-services.xml | 7 +++---- docs/manual/src/docbook/form-authentication.xml | 2 +- docs/manual/src/docbook/taglibs.xml | 2 +- .../AbstractAuthenticationTargetUrlRequestHandler.java | 2 +- .../UsernamePasswordAuthenticationFilter.java | 8 ++++---- 7 files changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/manual/src/docbook/appendix-namespace.xml b/docs/manual/src/docbook/appendix-namespace.xml index d620614495..3433a525c7 100644 --- a/docs/manual/src/docbook/appendix-namespace.xml +++ b/docs/manual/src/docbook/appendix-namespace.xml @@ -67,7 +67,7 @@
<literal>realm</literal> Sets the realm name used for basic authentication (if enabled). Corresponds to the - realmName proerty on + realmName property on BasicAuthenticationEntryPoint.
diff --git a/docs/manual/src/docbook/core-filters.xml b/docs/manual/src/docbook/core-filters.xml index 7c6060fb3f..387562cb97 100644 --- a/docs/manual/src/docbook/core-filters.xml +++ b/docs/manual/src/docbook/core-filters.xml @@ -246,7 +246,7 @@ class="org.springframework.security.web.context.SecurityContextPersistenceFilter was called AuthenticationProcessingFilterEntryPoint. Since the framework now supports many different forms of authentication, they have both been given more specific names in 3.0. - . It also provides the implementation used by the <form-login> element + . It also provides the implementation used by the <form-login> element from the namespace. There are three stages required to configure it. Configure a LoginUrlAuthenticationEntryPoint with @@ -298,8 +298,8 @@ class="org.springframework.security.web.context.SecurityContextPersistenceFilter If authentication is successful, the resulting Authentication object will be placed into the SecurityContextHolder. The configured - AuthenticationSuccessHandler will then be called to either redirect or forward the - user to the approprate destination. By default a + AuthenticationSuccessHandler will then be called to either redirect or forward the + user to the appropriate destination. By default a SavedRequestAwareAuthenticationSuccessHandler is used, which means that the user will be redirected to the original destination they requested before they were asked to login. diff --git a/docs/manual/src/docbook/core-services.xml b/docs/manual/src/docbook/core-services.xml index 7b7f2a3a15..99ce04189e 100644 --- a/docs/manual/src/docbook/core-services.xml +++ b/docs/manual/src/docbook/core-services.xml @@ -34,10 +34,9 @@ from a successful authentication and stored in the SecurityContext. If you are using the namespace, an instance of - ProviderMananger is created and maintained internally, and - you add providers to it either by using the namespace authentication provider elements, - or by adding the <custom-authentication-provider> element to a - bean (see the namespace chapter). In this + ProviderManager is created and maintained internally, and + you add providers to it by using the namespace authentication provider elements + (see the namespace chapter). In this case, you should not declare a ProviderManager bean in your application context. However, if you are not using the namespace then you would declare it like so: Authentication object will be placed into the SecurityContextHolder. The configured AuthenticationSuccessHandler will then be called to either redirect or forward - the user to the approprate destination. By default a SavedRequestAwareAuthenticationSuccessHandler + the user to the appropriate destination. By default a SavedRequestAwareAuthenticationSuccessHandler is used, which means that the user will be redirected to the original destination they requested before they were asked to login. diff --git a/docs/manual/src/docbook/taglibs.xml b/docs/manual/src/docbook/taglibs.xml index 2b9a3953e7..f24d4f8efe 100644 --- a/docs/manual/src/docbook/taglibs.xml +++ b/docs/manual/src/docbook/taglibs.xml @@ -19,7 +19,7 @@ . The first approach uses a web-security expression, specified in the access attribute of the tag. The expression evaluation will be delegated to the - WebSecurityExpressionHandlder defined in the + WebSecurityExpressionHandler defined in the application context (you should have web expressions enabled in your <http> namespace configuration to make sure this service is available). So, for example, you might diff --git a/web/src/main/java/org/springframework/security/web/authentication/AbstractAuthenticationTargetUrlRequestHandler.java b/web/src/main/java/org/springframework/security/web/authentication/AbstractAuthenticationTargetUrlRequestHandler.java index 630d6a2895..30ec2651c8 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/AbstractAuthenticationTargetUrlRequestHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/AbstractAuthenticationTargetUrlRequestHandler.java @@ -134,7 +134,7 @@ public abstract class AbstractAuthenticationTargetUrlRequestHandler { } /** - * The current request will be checked for this parameter before and the value used as the target URL if resent. + * The current request will be checked for this parameter before and the value used as the target URL if present. * * @param targetUrlParameter the name of the parameter containing the encoded target URL. Defaults * to "redirect". diff --git a/web/src/main/java/org/springframework/security/web/authentication/UsernamePasswordAuthenticationFilter.java b/web/src/main/java/org/springframework/security/web/authentication/UsernamePasswordAuthenticationFilter.java index 474e563f5e..96dd5a4fc4 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/UsernamePasswordAuthenticationFilter.java +++ b/web/src/main/java/org/springframework/security/web/authentication/UsernamePasswordAuthenticationFilter.java @@ -29,16 +29,16 @@ import org.springframework.util.Assert; /** - * Processes an authentication form. Called AuthenticationProcessingFilter in previous versions - * of the framework. + * Processes an authentication form submission. Called {@code AuthenticationProcessingFilter} prior to Spring Security + * 3.0. *

* Login forms must present two parameters to this filter: a username and * password. The default parameter names to use are contained in the * static fields {@link #SPRING_SECURITY_FORM_USERNAME_KEY} and {@link #SPRING_SECURITY_FORM_PASSWORD_KEY}. - * The parameter names can also be changed by setting the usernameParameter and passwordParameter + * The parameter names can also be changed by setting the {@literal usernameParameter} and {@literal passwordParameter} * properties. *

- * This filter by default responds to the URL /j_spring_security_check. + * This filter by default responds to the URL {@literal /j_spring_security_check}. * * @author Ben Alex * @author Colin Sampaleanu