org.acegisecurity.providers.x509.X509AuthoritiesPopulator Maven / Gradle / Ivy
/* Copyright 2004, 2005 Acegi Technology Pty Limited
*
* Licensed 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.acegisecurity.providers.x509;
import org.acegisecurity.AuthenticationException;
import org.acegisecurity.userdetails.UserDetails;
import java.security.cert.X509Certificate;
/**
* Populates the UserDetails
associated with the X.509
* certificate presented by a client.
*
* Although the certificate will already have been validated by the web container,
* implementations may choose to perform additional application-specific checks on
* the certificate content here. If an implementation chooses to reject the certificate,
* it should throw a {@link org.acegisecurity.BadCredentialsException}.
*
*
* @author Luke Taylor
* @version $Id: X509AuthoritiesPopulator.java,v 1.5 2005/12/21 00:48:57 luke_t Exp $
*/
public interface X509AuthoritiesPopulator {
/**
* Obtains the granted authorities for the specified user.
*
*
* May throw any AuthenticationException
or return
* null
if the authorities are unavailable.
*
*
* @param userCertificate the X.509 certificate supplied
*
* @return the details of the indicated user (at minimum the granted
* authorities and the username)
*
* @throws org.acegisecurity.AuthenticationException if the user details are not available
* or the certificate isn't valid for the application's purpose.
*/
UserDetails getUserDetails(X509Certificate userCertificate)
throws AuthenticationException;
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy