diff --git a/cas-client-core/src/main/java/org/jasig/cas/client/proxy/AbstractProxyReceptorServlet.java b/cas-client-core/src/main/java/org/jasig/cas/client/proxy/AbstractProxyReceptorServlet.java
index 2497754..9ddf21e 100644
--- a/cas-client-core/src/main/java/org/jasig/cas/client/proxy/AbstractProxyReceptorServlet.java
+++ b/cas-client-core/src/main/java/org/jasig/cas/client/proxy/AbstractProxyReceptorServlet.java
@@ -48,6 +48,9 @@ public abstract class AbstractProxyReceptorServlet extends HttpServlet {
*/
private ProxyGrantingTicketStorage proxyGrantingTicketStorage;
+ /**
+ * Instance of Commons Logging
+ */
protected final Log logger = LogFactory.getLog(this.getClass());
/**
@@ -86,9 +89,20 @@ public abstract class AbstractProxyReceptorServlet extends HttpServlet {
"");
}
+ /**
+ * Delegates to the protected method retrieveProxyGrantingTicketStorageFromConfiguration().
+ */
public final void init(final ServletConfig servletConfig) throws ServletException {
this.proxyGrantingTicketStorage = retrieveProxyGrantingTicketStorageFromConfiguration(servletConfig);
}
+ /**
+ * Abstract class to retrieve the ProxyGrantingTicketStorage from the ServletConfig. Its up to
+ * implementing classes to figure out where they are initializing/retrieving the object from.
+ *
+ * @param servletConfig the Servlet Config that has access to the ProxyGrantingTicketStorage.
+ * @return the initialized ProxyGrantingTicketStorage.
+ * @throws ServletException if there is an exception retrieving the ProxyGrantingTicketStorage.
+ */
protected abstract ProxyGrantingTicketStorage retrieveProxyGrantingTicketStorageFromConfiguration(final ServletConfig servletConfig) throws ServletException;
}