View Javadoc

1   /*
2    * Copyright 2008 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.x509;
18  
19  import java.util.Set;
20  
21  import org.opensaml.xml.security.SecurityException;
22  
23  /**
24   * Interface for classes which evaluate an {@link X509Credential} against a 
25   * supplied set of trusted names.
26   */
27  public interface X509CredentialNameEvaluator {
28  
29      /**
30       * Evaluate the specified credential against the specified set of trusted names.
31       * 
32       * <p>The types of names supported, and the manner in which they are evaluated, is
33       * implementation-specific.</p>
34       * 
35       * @param credential the X.509 credential to evaluate
36       * @param trustedNames trusted names against which the credential will be evaluated
37       * 
38       * @return true if the name evaluation succeeds, false otherwise
39       * 
40       * @throws SecurityException thrown if there is an error during name evaluation
41       */
42      public boolean evaluate(X509Credential credential, Set<String> trustedNames) throws SecurityException;
43      
44  }