From c7c84042593c2a15ddc1c1fcc0a6e8e067d26266 Mon Sep 17 00:00:00 2001 From: "Marvin S. Addison" Date: Wed, 22 Sep 2010 15:00:48 +0000 Subject: [PATCH] CASC-33 Logging improvements. --- .../tomcat/v6/AbstractAuthenticator.java | 11 ++++++--- .../tomcat/v6/AbstractLifecycleValve.java | 8 +++++-- .../client/tomcat/v6/AbstractLogoutValve.java | 23 +++++++++++++------ .../tomcat/v6/Cas10CasAuthenticator.java | 6 +++++ .../tomcat/v6/Cas20CasAuthenticator.java | 6 +++++ .../tomcat/v6/Cas20ProxyCasAuthenticator.java | 6 +++++ .../client/tomcat/v6/ProxyCallbackValve.java | 6 +++++ .../tomcat/v6/RegExpBasedLogoutValve.java | 12 ++++------ .../client/tomcat/v6/Saml11Authenticator.java | 6 +++++ .../client/tomcat/v6/UrlBasedLogoutValve.java | 17 ++++---------- 10 files changed, 68 insertions(+), 33 deletions(-) diff --git a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/AbstractAuthenticator.java b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/AbstractAuthenticator.java index 40c1cbb..cb9cb38 100644 --- a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/AbstractAuthenticator.java +++ b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/AbstractAuthenticator.java @@ -70,7 +70,7 @@ public abstract class AbstractAuthenticator extends AuthenticatorBase implements public void start() throws LifecycleException { super.start(); - this.log.debug("Starting..."); + this.log.debug(getName() + " starting."); final Realm realm = this.context.getRealm(); try { CommonUtils.assertTrue(realm instanceof CasRealm, "Expected CasRealm but got " + realm.getInfo()); @@ -153,7 +153,7 @@ public abstract class AbstractAuthenticator extends AuthenticatorBase implements /** {@inheritDoc} */ public void lifecycleEvent(final LifecycleEvent event) { if (AFTER_START_EVENT.equals(event.getType())) { - this.log.debug("Processing lifecycle event " + AFTER_START_EVENT); + this.log.debug(getName() + " processing lifecycle event " + AFTER_START_EVENT); this.delegate.setTicketValidator(getTicketValidator()); this.delegate.setArtifactParameterName(getArtifactParameterName()); this.delegate.setServiceParameterName(getServiceParameterName()); @@ -162,6 +162,11 @@ public abstract class AbstractAuthenticator extends AuthenticatorBase implements /** {@inheritDoc} */ public String getInfo() { - return getClass().getName() + "/1.0"; + return getName() + "/1.0"; } + + /** + * @return Authenticator descriptive name. + */ + protected abstract String getName(); } diff --git a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/AbstractLifecycleValve.java b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/AbstractLifecycleValve.java index c8a16c1..fd5a29e 100644 --- a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/AbstractLifecycleValve.java +++ b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/AbstractLifecycleValve.java @@ -46,12 +46,16 @@ public abstract class AbstractLifecycleValve extends ValveBase implements Lifecy /** {@inheritDoc} */ public void start() throws LifecycleException { - log.debug("Valve starting."); + log.debug(getName() + " starting."); } /** {@inheritDoc} */ public void stop() throws LifecycleException { - log.debug("Valve stopping."); + log.debug(getName() + " stopping."); } + /** + * @return Descriptive valve name. + */ + protected abstract String getName(); } diff --git a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/AbstractLogoutValve.java b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/AbstractLogoutValve.java index 38a23a2..1bb37a3 100644 --- a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/AbstractLogoutValve.java +++ b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/AbstractLogoutValve.java @@ -24,6 +24,12 @@ import java.io.IOException; */ public abstract class AbstractLogoutValve extends AbstractLifecycleValve { + protected String redirectUrl; + + public void setRedirectUrl(final String redirectUrl) { + this.redirectUrl = redirectUrl; + } + public final void invoke(final Request request, final Response response) throws IOException, ServletException { if (!isLogoutRequest(request)) { this.log.debug("URI is not a logout request: " + request.getRequestURI()); @@ -53,6 +59,16 @@ public abstract class AbstractLogoutValve extends AbstractLifecycleValve { } } + /** + * Constructs a url to redirect to. + * + * @param request the original request. + * @return the url to redirect to. CAN be NULL. + */ + protected String constructRedirectUrl(final Request request) { + return redirectUrl; + } + /** * Determines if this is a request to destroy the container-managed single sign on session. * @@ -61,11 +77,4 @@ public abstract class AbstractLogoutValve extends AbstractLifecycleValve { */ protected abstract boolean isLogoutRequest(Request request); - /** - * Constructs a url to redirect to. - * - * @param request the original request. - * @return the url to redirect to. CAN be NULL. - */ - protected abstract String constructRedirectUrl(Request request); } diff --git a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Cas10CasAuthenticator.java b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Cas10CasAuthenticator.java index 02f83e1..923cad5 100644 --- a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Cas10CasAuthenticator.java +++ b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Cas10CasAuthenticator.java @@ -19,6 +19,8 @@ import org.jasig.cas.client.validation.TicketValidator; public class Cas10CasAuthenticator extends AbstractCasAuthenticator { public static final String AUTH_METHOD = "CAS10"; + private static final String NAME = Cas10CasAuthenticator.class.getName(); + private Cas10TicketValidator ticketValidator; protected TicketValidator getTicketValidator() { @@ -29,6 +31,10 @@ public class Cas10CasAuthenticator extends AbstractCasAuthenticator { return AUTH_METHOD; } + protected String getName() { + return NAME; + } + public void start() throws LifecycleException { super.start(); this.ticketValidator = new Cas10TicketValidator(getCasServerUrlPrefix()); diff --git a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Cas20CasAuthenticator.java b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Cas20CasAuthenticator.java index 432a90f..29d0676 100644 --- a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Cas20CasAuthenticator.java +++ b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Cas20CasAuthenticator.java @@ -18,6 +18,8 @@ import org.jasig.cas.client.validation.TicketValidator; */ public final class Cas20CasAuthenticator extends AbstractCasAuthenticator { public static final String AUTH_METHOD = "CAS20"; + + private static final String NAME = Cas20CasAuthenticator.class.getName(); private Cas20ServiceTicketValidator ticketValidator; @@ -29,6 +31,10 @@ public final class Cas20CasAuthenticator extends AbstractCasAuthenticator { return AUTH_METHOD; } + protected String getName() { + return NAME; + } + public void start() throws LifecycleException { super.start(); this.ticketValidator = new Cas20ServiceTicketValidator(getCasServerUrlPrefix()); diff --git a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Cas20ProxyCasAuthenticator.java b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Cas20ProxyCasAuthenticator.java index 5c19e63..7baa336 100644 --- a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Cas20ProxyCasAuthenticator.java +++ b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Cas20ProxyCasAuthenticator.java @@ -20,6 +20,8 @@ import org.jasig.cas.client.validation.TicketValidator; public final class Cas20ProxyCasAuthenticator extends AbstractCasAuthenticator { public static final String AUTH_METHOD = "CAS20-PROXY"; + private static final String NAME = Cas20ProxyCasAuthenticator.class.getName(); + private Cas20ProxyTicketValidator ticketValidator; private boolean acceptAnyProxy; @@ -42,6 +44,10 @@ public final class Cas20ProxyCasAuthenticator extends AbstractCasAuthenticator { return AUTH_METHOD; } + protected String getName() { + return NAME; + } + public void start() throws LifecycleException { super.start(); this.ticketValidator = new Cas20ProxyTicketValidator(getCasServerUrlPrefix()); diff --git a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/ProxyCallbackValve.java b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/ProxyCallbackValve.java index 1ed505e..29183ff 100644 --- a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/ProxyCallbackValve.java +++ b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/ProxyCallbackValve.java @@ -26,6 +26,7 @@ import java.io.IOException; * @since 3.1.12 */ public final class ProxyCallbackValve extends AbstractLifecycleValve { + private static final String NAME = ProxyCallbackValve.class.getName(); private static ProxyGrantingTicketStorage PROXY_GRANTING_TICKET_STORAGE; @@ -68,4 +69,9 @@ public final class ProxyCallbackValve extends AbstractLifecycleValve { getNext().invoke(request, response); } + + /** {@inheritDoc} */ + protected String getName() { + return NAME; + } } diff --git a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/RegExpBasedLogoutValve.java b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/RegExpBasedLogoutValve.java index e6f1f32..4dee54b 100644 --- a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/RegExpBasedLogoutValve.java +++ b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/RegExpBasedLogoutValve.java @@ -20,21 +20,16 @@ import java.util.regex.Pattern; * @since 3.1.12 */ public final class RegExpBasedLogoutValve extends AbstractLogoutValve { + private static final String NAME = RegExpBasedLogoutValve.class.getName(); private String regexpUri; private Pattern regexpUriPattern; - private String redirectUrl; - public void setRegexpUri(final String regexpUri) { this.regexpUri = regexpUri; } - public void setRedirectUrl(final String redirectUrl) { - this.redirectUrl = redirectUrl; - } - public void start() throws LifecycleException { super.start(); @@ -52,7 +47,8 @@ public final class RegExpBasedLogoutValve extends AbstractLogoutValve { return this.regexpUriPattern.matcher(request.getRequestURI()).matches(); } - protected String constructRedirectUrl(final Request request) { - return this.redirectUrl; + /** {@inheritDoc} */ + protected String getName() { + return NAME; } } diff --git a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Saml11Authenticator.java b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Saml11Authenticator.java index 6132e03..7a79db0 100644 --- a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Saml11Authenticator.java +++ b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/Saml11Authenticator.java @@ -19,6 +19,8 @@ import org.jasig.cas.client.validation.TicketValidator; public class Saml11Authenticator extends AbstractAuthenticator { public static final String AUTH_METHOD = "SAML11"; + private static final String NAME = Saml11Authenticator.class.getName(); + private Saml11TicketValidator ticketValidator; /** SAML protocol clock drift tolerance in ms */ @@ -64,4 +66,8 @@ public class Saml11Authenticator extends AbstractAuthenticator { return "TARGET"; } + protected String getName() { + return NAME; + } + } diff --git a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/UrlBasedLogoutValve.java b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/UrlBasedLogoutValve.java index a6e6c30..8b741bb 100644 --- a/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/UrlBasedLogoutValve.java +++ b/cas-client-integration-tomcat-v6/src/main/java/org/jasig/cas/client/tomcat/v6/UrlBasedLogoutValve.java @@ -17,11 +17,10 @@ import org.jasig.cas.client.util.CommonUtils; * @since 3.1.12 */ public final class UrlBasedLogoutValve extends AbstractLogoutValve { + private static final String NAME = UrlBasedLogoutValve.class.getName(); private String logoutUri; - private String redirectUrl; - /** * The logout url to watch for logout requests. * @@ -31,15 +30,6 @@ public final class UrlBasedLogoutValve extends AbstractLogoutValve { this.logoutUri = logoutUri; } - /** - * Optional url to redirect to after logout is complete. - * - * @param redirectUrl the url. CAN be NULL. - */ - public void setRedirectUrl(final String redirectUrl) { - this.redirectUrl = redirectUrl; - } - public void start() throws LifecycleException { super.start(); try { @@ -55,7 +45,8 @@ public final class UrlBasedLogoutValve extends AbstractLogoutValve { return this.logoutUri.equals(request.getRequestURI()); } - protected String constructRedirectUrl(final Request request) { - return redirectUrl; + /** {@inheritDoc} */ + protected String getName() { + return NAME; } }