- All Implemented Interfaces:
Serializable
,Cloneable
,Map<Object,
Object>
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
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.security.Provider
Provider.Service
-
Field Summary
Fields inherited from class java.util.Properties
defaults
-
Constructor Summary
ModifierConstructorDescriptionprotected
AuthProvider
(String name, double version, String info) Deprecated.protected
AuthProvider
(String name, String versionStr, String info) Constructs a provider with the specified name, version string, and information. -
Method Summary
Modifier and TypeMethodDescriptionabstract 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 aCallbackHandler
.Methods inherited from class java.security.Provider
clear, compute, computeIfAbsent, computeIfPresent, configure, elements, entrySet, forEach, get, getInfo, getName, getOrDefault, getProperty, getService, getServices, getVersion, getVersionStr, isConfigured, keys, keySet, load, merge, put, putAll, putIfAbsent, putService, remove, remove, removeService, replace, replace, replaceAll, toString, values
Methods inherited from class java.util.Properties
clone, contains, containsKey, containsValue, equals, getProperty, hashCode, isEmpty, list, list, load, loadFromXML, propertyNames, rehash, save, setProperty, size, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames
-
Constructor Details
-
AuthProvider
Deprecated.useAuthProvider(String, String, String)
instead.Constructs a provider with the specified name, version number, and information.- Parameters:
name
- the provider name.version
- the provider version number.info
- a description of the provider and its services.
-
AuthProvider
Constructs a provider with the specified name, version string, and information.- Parameters:
name
- the provider name.versionStr
- the provider version string.info
- a description of the provider and its services.- Since:
- 9
-
-
Method Details
-
login
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 anull
handler to this method, the provider uses the handler set in thesetCallbackHandler
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
- theSubject
which may contain principals/credentials used for authentication, or may be populated with additional principals/credentials after successful authentication has completed. This parameter may benull
.handler
- theCallbackHandler
used by this provider to obtain authentication information from the caller, which may benull
- Throws:
IllegalStateException
- if the provider requires configuration andProvider.configure(java.lang.String)
has not been calledLoginException
- if the login operation failsSecurityException
- if the caller does not pass a security check forSecurityPermission("authProvider.name")
, wherename
is the value returned by this provider'sgetName
method
-
logout
Log out from this provider.- Throws:
IllegalStateException
- if the provider requires configuration andProvider.configure(java.lang.String)
has not been calledLoginException
- if the logout operation failsSecurityException
- if the caller does not pass a security check forSecurityPermission("authProvider.name")
, wherename
is the value returned by this provider'sgetName
method
-
setCallbackHandler
Set aCallbackHandler
.The provider uses this handler if one is not passed to the
login
method. The provider also uses this handler if it invokeslogin
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
- aCallbackHandler
for obtaining authentication information, which may benull
- Throws:
IllegalStateException
- if the provider requires configuration andProvider.configure(java.lang.String)
has not been calledSecurityException
- if the caller does not pass a security check forSecurityPermission("authProvider.name")
, wherename
is the value returned by this provider'sgetName
method
-
AuthProvider(String, String, String)
instead.