/* * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package java.security; import javax.security.auth.Subject; import javax.security.auth.login.LoginException; import javax.security.auth.callback.CallbackHandler; /** * This class defines login and logout methods for a provider. * *
While callers may invoke login
directly,
* the provider may also invoke login
on behalf of callers
* if it determines that a login must be performed
* prior to certain operations.
*
* @since 1.5
*/
public abstract class AuthProvider extends Provider {
/**
* Constructs a provider with the specified name, version number,
* and information.
*
* @param name the provider name.
* @param version the provider version number.
* @param info a description of the provider and its services.
*/
protected AuthProvider(String name, double version, String info) {
super(name, version, info);
}
/**
* Log in to this provider.
*
*
The provider relies on a CallbackHandler
* to obtain authentication information from the caller
* (a PIN, for example). If the caller passes a null
* handler to this method, the provider uses the handler set in the
* setCallbackHandler
method.
* If no handler was set in that method, the provider queries the
* auth.login.defaultCallbackHandler security property
* for the fully qualified class name of a default handler implementation.
* If the security property is not set,
* the provider is assumed to have alternative means
* for obtaining authentication information.
*
* @param subject the Subject
which may contain
* principals/credentials used for authentication,
* or may be populated with additional principals/credentials
* after successful authentication has completed.
* This parameter may be null
.
* @param handler the CallbackHandler
used by
* this provider to obtain authentication information
* from the caller, which may be null
*
* @exception LoginException if the login operation fails
* @exception SecurityException if the caller does not pass a
* security check for
* SecurityPermission("authProvider.name")
,
* where name is the value returned by
* this provider's getName
method
*/
public abstract void login(Subject subject, CallbackHandler handler)
throws LoginException;
/**
* Log out from this provider.
*
* @exception LoginException if the logout operation fails
* @exception SecurityException if the caller does not pass a
* security check for
* SecurityPermission("authProvider.name")
,
* where name is the value returned by
* this provider's getName
method
*/
public abstract void logout() throws LoginException;
/**
* Set a CallbackHandler
.
*
*
The provider uses this handler if one is not passed to the
* login
method. The provider also uses this handler
* if it invokes login
on behalf of callers.
* In either case if a handler is not set via this method,
* the provider queries the
* auth.login.defaultCallbackHandler security property
* for the fully qualified class name of a default handler implementation.
* If the security property is not set,
* the provider is assumed to have alternative means
* for obtaining authentication information.
*
* @param handler a CallbackHandler
for obtaining
* authentication information, which may be null
*
* @exception SecurityException if the caller does not pass a
* security check for
* SecurityPermission("authProvider.name")
,
* where name is the value returned by
* this provider's getName
method
*/
public abstract void setCallbackHandler(CallbackHandler handler);
}