Skip to content

Commit 0202409

Browse files
rishiraj88marcusdacoregio
authored andcommitted
Proofread documentation
1 parent a48b17d commit 0202409

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

Diff for: cas/src/main/java/org/springframework/security/cas/web/CasAuthenticationFilter.java

+12-12
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@
6262
* <h2>Service Tickets</h2>
6363
* <p>
6464
* A service ticket consists of an opaque ticket string. It arrives at this filter by the
65-
* user's browser successfully authenticating using CAS, and then receiving a HTTP
65+
* user's browser successfully authenticating using CAS, and then receiving an HTTP
6666
* redirect to a <code>service</code>. The opaque ticket string is presented in the
6767
* <code>ticket</code> request parameter.
6868
* <p>
69-
* This filter monitors the <code>service</code> URL so it can receive the service ticket
70-
* and process it. By default this filter processes the URL <tt>/login/cas</tt>. When
71-
* processing this URL, the value of {@link ServiceProperties#getService()} is used as the
72-
* <tt>service</tt> when validating the <code>ticket</code>. This means that it is
69+
* This filter monitors the <code>service</code> URL so that it can receive the service
70+
* ticket and process it. By default, this filter processes the URL <tt>/login/cas</tt>.
71+
* When processing this URL, the value of {@link ServiceProperties#getService()} is used
72+
* as the <tt>service</tt> when validating the <code>ticket</code>. This means that it is
7373
* important that {@link ServiceProperties#getService()} specifies the same value as the
7474
* <tt>filterProcessesUrl</tt>.
7575
* <p>
@@ -80,22 +80,22 @@
8080
* <h2>Obtaining Proxy Granting Tickets</h2>
8181
* <p>
8282
* If specified, the filter can also monitor the <code>proxyReceptorUrl</code>. The filter
83-
* will respond to requests matching this url so that the CAS Server can provide a PGT to
84-
* the filter. Note that in addition to the <code>proxyReceptorUrl</code> a non-null
83+
* will respond to the requests matching this url so that the CAS Server can provide a PGT
84+
* to the filter. Note that in addition to the <code>proxyReceptorUrl</code> a non-null
8585
* <code>proxyGrantingTicketStorage</code> must be provided in order for the filter to
8686
* respond to proxy receptor requests. By configuring a shared
8787
* {@link ProxyGrantingTicketStorage} between the {@link TicketValidator} and the
88-
* CasAuthenticationFilter one can have the CasAuthenticationFilter handle the proxying
89-
* requirements for CAS.
88+
* <code>CasAuthenticationFilter</code>, one can have the
89+
* <code>CasAuthenticationFilter</code> handling the proxying requirements for CAS.
9090
* <h2>Proxy Tickets</h2>
9191
* <p>
92-
* The filter can process tickets present on any url. This is useful when wanting to
93-
* process proxy tickets. In order for proxy tickets to get processed
92+
* The filter can process tickets present on any url. This is useful when one wants to
93+
* process proxy tickets. In order for proxy tickets to get processed,
9494
* {@link ServiceProperties#isAuthenticateAllArtifacts()} must return <code>true</code>.
9595
* Additionally, if the request is already authenticated, authentication will <b>not</b>
9696
* occur. Last, {@link AuthenticationDetailsSource#buildDetails(Object)} must return a
9797
* {@link ServiceAuthenticationDetails}. This can be accomplished using the
98-
* {@link ServiceAuthenticationDetailsSource}. In this case
98+
* {@link ServiceAuthenticationDetailsSource}. In this case,
9999
* {@link ServiceAuthenticationDetails#getServiceUrl()} will be used for the service url.
100100
* <p>
101101
* Processing the proxy ticket involves creating a

0 commit comments

Comments
 (0)