View Javadoc

1   /*
2    * Licensed to the University Corporation for Advanced Internet Development, 
3    * Inc. (UCAID) under one or more contributor license agreements.  See the 
4    * NOTICE file distributed with this work for additional information regarding
5    * copyright ownership. The UCAID licenses this file to You under the Apache 
6    * License, Version 2.0 (the "License"); you may not use this file except in 
7    * compliance with the License.  You may obtain a copy of the License at
8    *
9    *    http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.match.basic;
19  
20  import edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute;
21  import edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.FilterProcessingException;
22  import edu.internet2.middleware.shibboleth.common.attribute.filtering.provider.ShibbolethFilteringContext;
23  
24  /**
25   * A match function that evaluates an attribute's value against the provided regular expression.
26   */
27  public class AttributeValueRegexMatchFunctor extends AbstractAttributeTargetedRegexMatchFunctor {
28  
29      /**
30       * Evaluates to true if any value for the specified attribute matches the provided regular expression.
31       * 
32       * {@inheritDoc}
33       */
34      protected boolean doEvaluatePolicyRequirement(ShibbolethFilteringContext filterContext)
35              throws FilterProcessingException {
36          BaseAttribute attribute = filterContext.getUnfilteredAttributes().get(getAttributeId());
37          
38          if (attribute != null && attribute.getValues() != null) {
39              for (Object value : attribute.getValues()) {
40                  if (isMatch(value)) {
41                      return true;
42                  }
43              }
44          }
45          return false;
46      }
47  
48      /**
49       * Evaluates to true if the given attribute value matches the provided regular expression.
50       * 
51       * {@inheritDoc}
52       */
53      protected boolean doEvaluateValue(ShibbolethFilteringContext filterContext, String id, Object attributeValue)
54              throws FilterProcessingException {
55  
56          return isMatch(attributeValue);
57      }
58  }