View Javadoc

1   /*
2    * Copyright [2007] [University Corporation for Advanced Internet Development, Inc.]
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.opensaml.xml.security.criteria;
18  
19  import org.opensaml.xml.security.Criteria;
20  import org.opensaml.xml.security.credential.UsageType;
21  
22  
23  /**
24   * An implementation of {@link Criteria} which specifies criteria pertaining 
25   * usage of the resolved credential. 
26   */
27  public final class UsageCriteria implements Criteria {
28     
29      /** Key usage type of resolved credentials. */
30      private UsageType credUsage;
31      
32      /**
33      * Constructor.
34       *
35       * @param usage the usage for which a credential is intended
36       */
37      public UsageCriteria(UsageType usage) {
38          setUsage(usage);
39      }
40  
41      /**
42       * Get the key usage criteria.
43       * 
44       * @return Returns the usage.
45       */
46      public UsageType getUsage() {
47          return credUsage;
48      }
49  
50      /**
51       * Set the key usage criteria.
52       * 
53       * @param usage The usage to set.
54       */
55      public void setUsage(UsageType usage) {
56          if (usage != null) {
57              credUsage = usage;
58          } else {
59              credUsage = UsageType.UNSPECIFIED;
60          }
61      }
62  
63  }