From 40cf50fc9863f5738901bce87452cdc3b110aeee Mon Sep 17 00:00:00 2001 From: Luke Taylor Date: Sun, 13 Sep 2009 21:51:54 +0000 Subject: [PATCH] SEC-1148: Javadoc. --- .../SimpleUrlAuthenticationSuccessHandler.java | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/web/src/main/java/org/springframework/security/web/authentication/SimpleUrlAuthenticationSuccessHandler.java b/web/src/main/java/org/springframework/security/web/authentication/SimpleUrlAuthenticationSuccessHandler.java index f3a48ab274..3cafe6af77 100644 --- a/web/src/main/java/org/springframework/security/web/authentication/SimpleUrlAuthenticationSuccessHandler.java +++ b/web/src/main/java/org/springframework/security/web/authentication/SimpleUrlAuthenticationSuccessHandler.java @@ -8,11 +8,25 @@ import javax.servlet.http.HttpServletResponse; import org.springframework.security.core.Authentication; +/** + * AuthenticationSuccessHandler which can be configured with a default URL which users should be + * sent to upon successful authentication. + *

+ * The logic used is that of the {@link AbstractAuthenticationTargetUrlRequestHandler parent class}. + * + * @author Luke Taylor + * @version $Id$ + * @since 3.0 + */ public class SimpleUrlAuthenticationSuccessHandler extends AbstractAuthenticationTargetUrlRequestHandler implements AuthenticationSuccessHandler { public SimpleUrlAuthenticationSuccessHandler() { } + /** + * Constructor which sets the defaultTargetUrl property of the base class. + * @param defaultTargetUrl the URL to which the user should be redirected on successful authentication. + */ public SimpleUrlAuthenticationSuccessHandler(String defaultTargetUrl) { setDefaultTargetUrl(defaultTargetUrl); }