From 29866f923e2a2ffdbc2b5299283725216bedf815 Mon Sep 17 00:00:00 2001
From: Scott Battaglia <scott.battaglia@gmail.com>
Date: Wed, 22 Sep 2010 03:31:35 +0000
Subject: [PATCH] CASC-33

minor updates to documentation, final keyword, and formatting.
---
 .../tomcat/v6/AbstractAuthenticator.java      | 21 +++++++++++++++----
 .../client/tomcat/v6/AbstractLogoutValve.java |  2 +-
 2 files changed, 18 insertions(+), 5 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 9b17b5e..40c1cbb 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
@@ -46,21 +46,34 @@ public abstract class AbstractAuthenticator extends AuthenticatorBase implements
 
     protected abstract String getAuthenticationMethod();
 
+    /**
+     * Abstract method that subclasses should use to provide the name of the artifact parameter (i.e. ticket)
+     *
+     * @return the artifact parameter name.  CANNOT be NULL.
+     */
     protected abstract String getArtifactParameterName();
 
+    /**
+     * Abstract method that subclasses should use to provide the name of the service parameter (i.e. service)
+     *
+     * @return the service parameter name.  CANNOT be NULL.
+     */
     protected abstract String getServiceParameterName();
 
+    /**
+     * Returns the single instance of the ticket validator to use to validate tickets.  Sub classes should include
+     * the one appropriate for the
+     *
+     * @return a fully configured ticket validator.  CANNOT be NULL.
+     */
     protected abstract TicketValidator getTicketValidator();
 
-
     public void start() throws LifecycleException {
         super.start();
         this.log.debug("Starting...");
         final Realm realm = this.context.getRealm();
-        if (!(realm instanceof CasRealm)) {
-            throw new LifecycleException("Expected CasRealm but got " + realm.getInfo());
-        }
         try {
+            CommonUtils.assertTrue(realm instanceof CasRealm, "Expected CasRealm but got " + realm.getInfo());
             CommonUtils.assertNotNull(this.casServerUrlPrefix, "casServerUrlPrefix cannot be null.");
             CommonUtils.assertNotNull(this.delegate.getCasServerLoginUrl(), "casServerLoginUrl cannot be null.");
             CommonUtils.assertTrue(
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 1964df3..38a23a2 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
@@ -42,7 +42,7 @@ public abstract class AbstractLogoutValve extends AbstractLifecycleValve {
         }
 
         if (assertion != null) {
-	        this.log.info("Succesfully logged out " + assertion.getPrincipal());
+	        this.log.info("Successfully logged out " + assertion.getPrincipal());
         } else {
             this.log.info("Session already ended.");
         }