org.opensaml.xml.security.x509.X509CredentialNameEvaluator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xmltooling Show documentation

XMLTooling-J is a low-level library that may be used to construct libraries that allow developers to work with XML in a Java beans manner.

There is a newer version: 1.4.4

Show newest version

/*
 * Licensed to the University Corporation for Advanced Internet Development, 
 * Inc. (UCAID) under one or more contributor license agreements.  See the 
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID licenses this file to You under the Apache 
 * License, Version 2.0 (the "License"); you may not use this file except in 
 * compliance with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.opensaml.xml.security.x509;

import java.util.Set;

import org.opensaml.xml.security.SecurityException;

/**
 * Interface for classes which evaluate an {@link X509Credential} against a 
 * supplied set of trusted names.
 */
public interface X509CredentialNameEvaluator {

    /**
     * Evaluate the specified credential against the specified set of trusted names.
     * 
     * The types of names supported, and the manner in which they are evaluated, is
     * implementation-specific.
     * 
     * @param credential the X.509 credential to evaluate
     * @param trustedNames trusted names against which the credential will be evaluated
     * 
     * @return true if the name evaluation succeeds, false otherwise
     * 
     * @throws SecurityException thrown if there is an error during name evaluation
     */
    public boolean evaluate(X509Credential credential, Set trustedNames) throws SecurityException;
    
}