public abstract class AuthProvider extends 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.
Provider.Servicedefaults| Modifier | Constructor and Description |
|---|---|
protected |
AuthProvider(String name,
double version,
String info)
Constructs a provider with the specified name, version number,
and information.
|
| Modifier and Type | Method and Description |
|---|---|
abstract void |
login(Subject subject,
CallbackHandler handler)
Log in to this provider.
|
abstract void |
logout()
Log out from this provider.
|
abstract void |
setCallbackHandler(CallbackHandler handler)
Set a
CallbackHandler. |
clear, compute, computeIfAbsent, computeIfPresent, elements, entrySet, forEach, get, getInfo, getName, getOrDefault, getProperty, getService, getServices, getVersion, keys, keySet, load, merge, put, putAll, putIfAbsent, putService, remove, remove, removeService, replace, replace, replaceAll, toString, valuesgetProperty, list, list, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNamesclone, contains, containsKey, containsValue, equals, hashCode, isEmpty, rehash, sizepublic abstract void login(Subject subject, CallbackHandler handler) throws LoginException
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.
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.handler - the CallbackHandler used by
this provider to obtain authentication information
from the caller, which may be nullLoginException - if the login operation failsSecurityException - if the caller does not pass a
security check for
SecurityPermission("authProvider.name"),
where name is the value returned by
this provider's getName methodpublic abstract void logout()
throws LoginException
LoginException - if the logout operation failsSecurityException - if the caller does not pass a
security check for
SecurityPermission("authProvider.name"),
where name is the value returned by
this provider's getName methodpublic abstract void setCallbackHandler(CallbackHandler handler)
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.
handler - a CallbackHandler for obtaining
authentication information, which may be nullSecurityException - 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 Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.