From bc331616140f3750b95e6bb2b9d6692a371ccdbe Mon Sep 17 00:00:00 2001 From: Rishi Raj Date: Wed, 10 Apr 2024 21:31:45 +0200 Subject: [PATCH] Proofread documentaion. --- .../cas/web/CasAuthenticationFilter.java | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/cas/src/main/java/org/springframework/security/cas/web/CasAuthenticationFilter.java b/cas/src/main/java/org/springframework/security/cas/web/CasAuthenticationFilter.java index af2e319f3b4..3b4fd0650a7 100644 --- a/cas/src/main/java/org/springframework/security/cas/web/CasAuthenticationFilter.java +++ b/cas/src/main/java/org/springframework/security/cas/web/CasAuthenticationFilter.java @@ -62,12 +62,12 @@ *

Service Tickets

*

* A service ticket consists of an opaque ticket string. It arrives at this filter by the - * user's browser successfully authenticating using CAS, and then receiving a HTTP + * user's browser successfully authenticating using CAS, and then receiving an HTTP * redirect to a service. The opaque ticket string is presented in the * ticket request parameter. *

- * This filter monitors the service URL so it can receive the service ticket - * and process it. By default this filter processes the URL /login/cas. When + * This filter monitors the service URL so that it can receive the service ticket + * and process it. By default, this filter processes the URL /login/cas. When * processing this URL, the value of {@link ServiceProperties#getService()} is used as the * service when validating the ticket. This means that it is * important that {@link ServiceProperties#getService()} specifies the same value as the @@ -80,22 +80,22 @@ *

Obtaining Proxy Granting Tickets

*

* If specified, the filter can also monitor the proxyReceptorUrl. The filter - * will respond to requests matching this url so that the CAS Server can provide a PGT to + * will respond to the requests matching this url so that the CAS Server can provide a PGT to * the filter. Note that in addition to the proxyReceptorUrl a non-null * proxyGrantingTicketStorage must be provided in order for the filter to * respond to proxy receptor requests. By configuring a shared * {@link ProxyGrantingTicketStorage} between the {@link TicketValidator} and the - * CasAuthenticationFilter one can have the CasAuthenticationFilter handle the proxying - * requirements for CAS. + * CasAuthenticationFilter, one can have the CasAuthenticationFilter + * handling the proxying requirements for CAS. *

Proxy Tickets

*

- * The filter can process tickets present on any url. This is useful when wanting to - * process proxy tickets. In order for proxy tickets to get processed + * The filter can process tickets present on any url. This is useful when one wants to + * process proxy tickets. In order for proxy tickets to get processed, * {@link ServiceProperties#isAuthenticateAllArtifacts()} must return true. * Additionally, if the request is already authenticated, authentication will not * occur. Last, {@link AuthenticationDetailsSource#buildDetails(Object)} must return a * {@link ServiceAuthenticationDetails}. This can be accomplished using the - * {@link ServiceAuthenticationDetailsSource}. In this case + * {@link ServiceAuthenticationDetailsSource}. In this case, * {@link ServiceAuthenticationDetails#getServiceUrl()} will be used for the service url. *

* Processing the proxy ticket involves creating a