| java.security.Provider
 java.security.AuthProvider
| AuthProvider | | abstract public class AuthProvider extends Provider (Code) | | 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.
version:
1.10, 05/05/07
since:
1.5 |
| Constructor Summary | |
| protected | AuthProvider(String name, double version, String info)
Constructs a provider with the specified name, version number,
and information. |
| Method Summary | |
| abstract public void | login(Subject subject, CallbackHandler handler)
Log in to this provider.
The provider relies on a CallbackHandler
to obtain authentication information from the caller
(a PIN, for example). | | abstract public void | logout()
Log out from this provider. | | abstract public void | setCallbackHandler(CallbackHandler handler)
Set a CallbackHandler.
The provider uses this handler if one is not passed to the
login method. |
| AuthProvider | | protected AuthProvider(String name, double version, String info)(Code) | | Constructs a provider with the specified name, version number,
and information.
Parameters:
name - the provider name.
Parameters:
version - the provider version number.
Parameters:
info - a description of the provider and its services. |
| login | | abstract public void login(Subject subject, CallbackHandler handler) throws LoginException(Code) | | 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.
Parameters:
subject - the Subject which may containprincipals/credentials used for authentication,or may be populated with additional principals/credentialsafter successful authentication has completed.This parameter may be null.
Parameters:
handler - the CallbackHandler used bythis provider to obtain authentication informationfrom the caller, which may be null
exception:
LoginException - if the login operation fails
exception:
SecurityException - if the caller does not pass asecurity check forSecurityPermission("authProvider.name"),where name is the value returned bythis provider's getName method |
| logout | | abstract public void logout() throws LoginException(Code) | | Log out from this provider.
exception:
LoginException - if the logout operation fails
exception:
SecurityException - if the caller does not pass asecurity check forSecurityPermission("authProvider.name"),where name is the value returned bythis provider's getName method |
| setCallbackHandler | | abstract public void setCallbackHandler(CallbackHandler handler)(Code) | | 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.
Parameters:
handler - a CallbackHandler for obtainingauthentication information, which may be null
exception:
SecurityException - if the caller does not pass asecurity check forSecurityPermission("authProvider.name"),where name is the value returned bythis provider's getName method |
| Fields inherited from java.security.Provider | final static long serialVersionUID(Code)(Java Doc)
|
|
|