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 org.opensaml.xml.util.DatatypeHelper;
21  
22  /**
23   * Base class for match functions that match a regular expresion against an attribute's value.
24   */
25  public abstract class AbstractAttributeTargetedRegexMatchFunctor extends AbstractRegexMatchFunctor {
26  
27      /** ID of the attribute whose values will be evaluated. */
28      private String attributeId;
29  
30      /**
31       * Gets the ID of the attribute whose values will be evaluated.
32       * 
33       * @return ID of the attribute whose values will be evaluated
34       */
35      public String getAttributeId() {
36          return attributeId;
37      }
38  
39      /**
40       * Sets the ID of the attribute whose values will be evaluated.
41       * 
42       * @param id ID of the attribute whose values will be evaluated
43       */
44      public void setAttributeId(String id) {
45          attributeId = DatatypeHelper.safeTrimOrNullString(id);
46      }
47  }