Allow url patterns to be included

cas-client-core/src/main/java/org/jasig/cas/client/authentication/AuthenticationFilter.java

@@ -28,6 +28,7 @@ import javax.servlet.http.HttpServletResponse;
 import javax.servlet.http.HttpSession;
 
 import org.jasig.cas.client.Protocol;
+import org.jasig.cas.client.configuration.ConfigurationKey;
 import org.jasig.cas.client.configuration.ConfigurationKeys;
 import org.jasig.cas.client.util.AbstractCasFilter;
 import org.jasig.cas.client.util.CommonUtils;
@@ -72,7 +73,9 @@ public class AuthenticationFilter extends AbstractCasFilter {
     private AuthenticationRedirectStrategy authenticationRedirectStrategy = new DefaultAuthenticationRedirectStrategy();
     
     private UrlPatternMatcherStrategy ignoreUrlPatternMatcherStrategyClass = null;
-    
+
+    private UrlPatternMatcherStrategy includeUrlPatternMatcherStrategyClass = null;
+
     private static final Map<String, Class<? extends UrlPatternMatcherStrategy>> PATTERN_MATCHER_TYPES =
             new HashMap<String, Class<? extends UrlPatternMatcherStrategy>>();
     
@@ -96,26 +99,12 @@ public class AuthenticationFilter extends AbstractCasFilter {
             setCasServerLoginUrl(getString(ConfigurationKeys.CAS_SERVER_LOGIN_URL));
             setRenew(getBoolean(ConfigurationKeys.RENEW));
             setGateway(getBoolean(ConfigurationKeys.GATEWAY));
-                       
-            final String ignorePattern = getString(ConfigurationKeys.IGNORE_PATTERN);
-            final String ignoreUrlPatternType = getString(ConfigurationKeys.IGNORE_URL_PATTERN_TYPE);
-            
-            if (ignorePattern != null) {
-                final Class<? extends UrlPatternMatcherStrategy> ignoreUrlMatcherClass = PATTERN_MATCHER_TYPES.get(ignoreUrlPatternType);
-                if (ignoreUrlMatcherClass != null) {
-                    this.ignoreUrlPatternMatcherStrategyClass = ReflectUtils.newInstance(ignoreUrlMatcherClass.getName());
-                } else {
-                    try {
-                        logger.trace("Assuming {} is a qualified class name...", ignoreUrlPatternType);
-                        this.ignoreUrlPatternMatcherStrategyClass = ReflectUtils.newInstance(ignoreUrlPatternType);
-                    } catch (final IllegalArgumentException e) {
-                        logger.error("Could not instantiate class [{}]", ignoreUrlPatternType, e);
-                    }
-                }
-                if (this.ignoreUrlPatternMatcherStrategyClass != null) {
-                    this.ignoreUrlPatternMatcherStrategyClass.setPattern(ignorePattern);
-                }
-            }
+
+            configureUrlPatternMatchers(ConfigurationKeys.IGNORE_PATTERN, ConfigurationKeys.IGNORE_URL_PATTERN_TYPE, 
+                                        this.ignoreUrlPatternMatcherStrategyClass);
+
+            configureUrlPatternMatchers(ConfigurationKeys.INCLUDE_PATTERN, ConfigurationKeys.INCLUDE_URL_PATTERN_TYPE,
+                    this.includeUrlPatternMatcherStrategyClass);
             
             final Class<? extends GatewayResolver> gatewayStorageClass = getClass(ConfigurationKeys.GATEWAY_STORAGE_CLASS);
 
@@ -147,6 +136,12 @@ public class AuthenticationFilter extends AbstractCasFilter {
             filterChain.doFilter(request, response);
             return;
         }
+
+        if (!isRequestUrlIncluded(request)) {
+            logger.debug("Request is not included.");
+            filterChain.doFilter(request, response);
+            return;
+        }
         
         final HttpSession session = request.getSession(false);
         final Assertion assertion = session != null ? (Assertion) session.getAttribute(CONST_CAS_ASSERTION) : null;
@@ -199,7 +194,44 @@ public class AuthenticationFilter extends AbstractCasFilter {
     public final void setGatewayStorage(final GatewayResolver gatewayStorage) {
         this.gatewayStorage = gatewayStorage;
     }
-        
+      
+    private void configureUrlPatternMatchers(final ConfigurationKey<String> keyName, 
+                                             final ConfigurationKey<String> patternTypeKeyName,
+                                             final UrlPatternMatcherStrategy urlPatternMatcherStrategy) {
+        final String pattern = getString(keyName);
+        final String patternType = getString(patternTypeKeyName);
+
+        if (pattern != null) {
+            final Class<? extends UrlPatternMatcherStrategy> ignoreUrlMatcherClass = PATTERN_MATCHER_TYPES.get(patternType);
+            if (ignoreUrlMatcherClass != null) {
+                this.ignoreUrlPatternMatcherStrategyClass = ReflectUtils.newInstance(ignoreUrlMatcherClass.getName());
+            } else {
+                try {
+                    logger.trace("Assuming {} is a qualified class name...", patternType);
+                    this.ignoreUrlPatternMatcherStrategyClass = ReflectUtils.newInstance(patternType);
+                } catch (final IllegalArgumentException e) {
+                    logger.error("Could not instantiate class [{}]", patternType, e);
+                }
+            }
+            if (urlPatternMatcherStrategy != null) {
+                urlPatternMatcherStrategy.setPattern(pattern);
+            }
+        }
+    }
+
+    private boolean isRequestUrlIncluded(final HttpServletRequest request) {
+        if (this.includeUrlPatternMatcherStrategyClass == null) {
+            return true;
+        }
+
+        final StringBuffer urlBuffer = request.getRequestURL();
+        if (request.getQueryString() != null) {
+            urlBuffer.append("?").append(request.getQueryString());
+        }
+        final String requestUri = urlBuffer.toString();
+        return this.includeUrlPatternMatcherStrategyClass.matches(requestUri);
+    }
+    
     private boolean isRequestUrlExcluded(final HttpServletRequest request) {
         if (this.ignoreUrlPatternMatcherStrategyClass == null) {
             return false;

cas-client-core/src/main/java/org/jasig/cas/client/configuration/ConfigurationKeys.java

@@ -63,6 +63,8 @@ public interface ConfigurationKeys {
     ConfigurationKey<Boolean> DISABLE_XML_SCHEMA_VALIDATION = new ConfigurationKey<Boolean>("disableXmlSchemaValidation", Boolean.FALSE);
     ConfigurationKey<String> IGNORE_PATTERN = new ConfigurationKey<String>("ignorePattern", null);
     ConfigurationKey<String> IGNORE_URL_PATTERN_TYPE = new ConfigurationKey<String>("ignoreUrlPatternType", "REGEX");
+    ConfigurationKey<String> INCLUDE_PATTERN = new ConfigurationKey<String>("includePattern", null);
+    ConfigurationKey<String> INCLUDE_URL_PATTERN_TYPE = new ConfigurationKey<String>("includeUrlPatternType", "REGEX");
     ConfigurationKey<Class<? extends HostnameVerifier>> HOSTNAME_VERIFIER = new ConfigurationKey<Class<? extends HostnameVerifier>>("hostnameVerifier", null);
     ConfigurationKey<String> HOSTNAME_VERIFIER_CONFIG = new ConfigurationKey<String>("hostnameVerifierConfig", null);
     ConfigurationKey<Boolean> EXCEPTION_ON_VALIDATION_FAILURE = new ConfigurationKey<Boolean>("exceptionOnValidationFailure", Boolean.TRUE);