SEC-1359,SEC-1360,SEC-1361,SEC-1363,SEC-1364,SEC-1365,SEC-1366,SEC-1367: Minor doc and Javadoc typos.

This commit is contained in:
Luke Taylor 2010-01-13 15:36:58 +00:00
parent 3a8daa1bf4
commit a9567a58d8
7 changed files with 14 additions and 15 deletions

View File

@ -67,7 +67,7 @@
<section xml:id="nsa-realm"> <section xml:id="nsa-realm">
<title><literal>realm</literal></title> <title><literal>realm</literal></title>
<para> Sets the realm name used for basic authentication (if enabled). Corresponds to the <para> Sets the realm name used for basic authentication (if enabled). Corresponds to the
<literal>realmName</literal> proerty on <literal>realmName</literal> property on
<classname>BasicAuthenticationEntryPoint</classname>. </para> <classname>BasicAuthenticationEntryPoint</classname>. </para>
</section> </section>
<section xml:id="nsa-entry-point-ref"> <section xml:id="nsa-entry-point-ref">

View File

@ -246,7 +246,7 @@ class="org.springframework.security.web.context.SecurityContextPersistenceFilter
was called <classname>AuthenticationProcessingFilterEntryPoint</classname>. was called <classname>AuthenticationProcessingFilterEntryPoint</classname>.
Since the framework now supports many different forms of authentication, they Since the framework now supports many different forms of authentication, they
have both been given more specific names in 3.0.</para> have both been given more specific names in 3.0.</para>
</footnote>. It also provides the implementation used by the &lt;form-login&gt; element </footnote>. It also provides the implementation used by the <literal>&lt;form-login&gt;</literal> element
from the namespace. There are three stages required to configure it. <orderedlist> from the namespace. There are three stages required to configure it. <orderedlist>
<listitem> <listitem>
<para>Configure a <classname>LoginUrlAuthenticationEntryPoint</classname> with <para>Configure a <classname>LoginUrlAuthenticationEntryPoint</classname> with
@ -298,8 +298,8 @@ class="org.springframework.security.web.context.SecurityContextPersistenceFilter
<para>If authentication is successful, the resulting <para>If authentication is successful, the resulting
<interfacename>Authentication</interfacename> object will be placed into the <interfacename>Authentication</interfacename> object will be placed into the
<classname>SecurityContextHolder</classname>. The configured <classname>SecurityContextHolder</classname>. The configured
AuthenticationSuccessHandler will then be called to either redirect or forward the <interfacename>AuthenticationSuccessHandler</interfacename> will then be called to either redirect or forward the
user to the approprate destination. By default a user to the appropriate destination. By default a
<classname>SavedRequestAwareAuthenticationSuccessHandler</classname> is used, <classname>SavedRequestAwareAuthenticationSuccessHandler</classname> is used,
which means that the user will be redirected to the original destination they which means that the user will be redirected to the original destination they
requested before they were asked to login. <note> requested before they were asked to login. <note>

View File

@ -34,10 +34,9 @@
from a successful authentication and stored in the from a successful authentication and stored in the
<classname>SecurityContext</classname>. </para> <classname>SecurityContext</classname>. </para>
<para> If you are using the namespace, an instance of <para> If you are using the namespace, an instance of
<classname>ProviderMananger</classname> is created and maintained internally, and <classname>ProviderManager</classname> is created and maintained internally, and
you add providers to it either by using the namespace authentication provider elements, you add providers to it by using the namespace authentication provider elements
or by adding the <literal>&lt;custom-authentication-provider&gt;</literal> element to a (see <link xlink:href="#ns-auth-manager">the namespace chapter</link>). In this
bean (see <link xlink:href="#ns-auth-manager">the namespace chapter</link>). In this
case, you should not declare a <classname>ProviderManager</classname> bean in your case, you should not declare a <classname>ProviderManager</classname> bean in your
application context. However, if you are not using the namespace then you would declare application context. However, if you are not using the namespace then you would declare
it like so: <programlisting language="xml"><![CDATA[ it like so: <programlisting language="xml"><![CDATA[

View File

@ -51,7 +51,7 @@
<interfacename>Authentication</interfacename> object will be placed into the <interfacename>Authentication</interfacename> object will be placed into the
<classname>SecurityContextHolder</classname>. <classname>SecurityContextHolder</classname>.
The configured AuthenticationSuccessHandler will then be called to either redirect or forward The configured AuthenticationSuccessHandler will then be called to either redirect or forward
the user to the approprate destination. By default a <classname>SavedRequestAwareAuthenticationSuccessHandler</classname> the user to the appropriate destination. By default a <classname>SavedRequestAwareAuthenticationSuccessHandler</classname>
is used, which means that the user will be redirected to the original destination they requested before they were asked to is used, which means that the user will be redirected to the original destination they requested before they were asked to
login. login.
<note> <note>

View File

@ -19,7 +19,7 @@
</footnote>. The first approach uses a <link xlink:href="el-access-we">web-security </footnote>. The first approach uses a <link xlink:href="el-access-we">web-security
expression</link>, specified in the <literal>access</literal> attribute of the tag. expression</link>, specified in the <literal>access</literal> attribute of the tag.
The expression evaluation will be delegated to the The expression evaluation will be delegated to the
<interfacename>WebSecurityExpressionHandlder</interfacename> defined in the <interfacename>WebSecurityExpressionHandler</interfacename> defined in the
application context (you should have web expressions enabled in your application context (you should have web expressions enabled in your
<literal>&lt;http></literal> namespace configuration to make sure this service is <literal>&lt;http></literal> namespace configuration to make sure this service is
available). So, for example, you might available). So, for example, you might

View File

@ -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 * @param targetUrlParameter the name of the parameter containing the encoded target URL. Defaults
* to "redirect". * to "redirect".

View File

@ -29,16 +29,16 @@ import org.springframework.util.Assert;
/** /**
* Processes an authentication form. Called <tt>AuthenticationProcessingFilter<tt> in previous versions * Processes an authentication form submission. Called {@code AuthenticationProcessingFilter} prior to Spring Security
* of the framework. * 3.0.
* <p> * <p>
* Login forms must present two parameters to this filter: a username and * Login forms must present two parameters to this filter: a username and
* password. The default parameter names to use are contained in the * 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}. * 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 <tt>usernameParameter</tt> and <tt>passwordParameter</tt> * The parameter names can also be changed by setting the {@literal usernameParameter} and {@literal passwordParameter}
* properties. * properties.
* <p> * <p>
* This filter by default responds to the URL <tt>/j_spring_security_check</tt>. * This filter by default responds to the URL {@literal /j_spring_security_check}.
* *
* @author Ben Alex * @author Ben Alex
* @author Colin Sampaleanu * @author Colin Sampaleanu