From 8643e85b1e3272394ee5523dee0359ce6ea5769a Mon Sep 17 00:00:00 2001 From: Scott Battaglia Date: Tue, 18 Jun 2013 22:07:50 -0400 Subject: [PATCH] Added missing javadoc --- .../AuthenticationRedirectStrategy.java | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/cas-client-core/src/main/java/org/jasig/cas/client/authentication/AuthenticationRedirectStrategy.java b/cas-client-core/src/main/java/org/jasig/cas/client/authentication/AuthenticationRedirectStrategy.java index 701d852..cb3e2e8 100644 --- a/cas-client-core/src/main/java/org/jasig/cas/client/authentication/AuthenticationRedirectStrategy.java +++ b/cas-client-core/src/main/java/org/jasig/cas/client/authentication/AuthenticationRedirectStrategy.java @@ -5,10 +5,23 @@ import javax.servlet.http.HttpServletResponse; import java.io.IOException; /** - * Created by battags on 6/18/13. + * Interface to abstract the authentication strategy for redirecting. The traditional method was to always just redirect, + * but due to AJAX, etc. we may need to support other strategies. This interface is designed to hold that logic such that + * authentication filter class does not get crazily complex. + * + * @author Scott Battaglia + * @since 3.3.0 */ public interface AuthenticationRedirectStrategy { + /** + * Method name is a bit of a misnomer. This method handles "redirection" for a localized version of redirection (i.e. AJAX might mean an XML fragment that contains the url to go to). + * + * @param request the original HttpServletRequest. MAY NOT BE NULL. + * @param response the original HttpServletResponse. MAY NOT BE NULL. + * @param potentialRedirectUrl the url that might be used (there are no guarantees of course!) + * @throws IOException the exception to throw if there is some type of error. This will bubble up through the filter. + */ void redirect(HttpServletRequest request, HttpServletResponse response, String potentialRedirectUrl) throws IOException; }