org.opensaml.xml.security.x509.PKIXValidationInformationResolver 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.Criteria;
import org.opensaml.xml.security.CriteriaSet;
import org.opensaml.xml.security.Resolver;
import org.opensaml.xml.security.SecurityException;

/**
 * A resolver which uses {@link Criteria} to resolve {@link PKIXValidationInformation}, which will typically be used
 * PKIX-based trust engines.
 * 
 * Implementations may also optionally implement {@link #resolveTrustedNames(CriteriaSet)}, which will 
 * return a set of trusted names associated with the entity implied by the criteria.  These trusted names
 * may be used to validate (in an application-specific manner) that an entity is trusted to wield a particular
 * certificate.
 */
public interface PKIXValidationInformationResolver extends Resolver {
    
    /**
     * Resolve a set of trusted names associated with the entity indicated by the criteria.  This method
     * is optional to implement.
     * 
     * @param criteriaSet set of criteria used to determine or resolve the trusted names
     * @return the set of certificate names trusted for an entity
     * @throws SecurityException thrown if there is an error resolving the trusted names
     * @throws UnsupportedOperationException thrown if this optional method is not supported by the implementation
     */
    public Set resolveTrustedNames(CriteriaSet criteriaSet)
        throws SecurityException, UnsupportedOperationException;
    
    /**
     * Check whether resolution of trusted names is supported.
     * 
     * @return true if the implementation supports resolution of trusted names, otherwise false
     */
    public boolean supportsTrustedNameResolution();

}