- java.lang.Object
-
- java.util.Dictionary<K,V>
-
- java.util.Hashtable<Object,Object>
-
- java.util.Properties
-
- java.security.Provider
-
- java.security.AuthProvider
-
- All Implemented Interfaces:
Serializable,Cloneable,Map<Object,Object>
public abstract class AuthProvider extends Provider
This class defines login and logout methods for a provider.While callers may invoke
logindirectly, the provider may also invokeloginon behalf of callers if it determines that a login must be performed prior to certain operations.- Since:
- 1.5
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces declared in class java.security.Provider
Provider.Service
-
-
Field Summary
-
Fields declared in class java.util.Properties
defaults
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAuthProvider(String name, double version, String info)Deprecated.useAuthProvider(String, String, String)instead.protectedAuthProvider(String name, String versionStr, String info)Constructs a provider with the specified name, version string, and information.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract voidlogin(Subject subject, CallbackHandler handler)Log in to this provider.abstract voidlogout()Log out from this provider.abstract voidsetCallbackHandler(CallbackHandler handler)Set aCallbackHandler.-
Methods declared in class java.security.Provider
clear, compute, computeIfAbsent, computeIfPresent, configure, entrySet, forEach, getInfo, getName, getOrDefault, getService, getServices, getVersion, getVersionStr, isConfigured, keySet, load, merge, put, putAll, putIfAbsent, putService, remove, remove, removeService, replace, replace, replaceAll, toString, values
-
Methods declared in class java.util.Properties
getProperty, getProperty, list, list, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames
-
-
-
-
Constructor Detail
-
AuthProvider
@Deprecated(since="9") protected AuthProvider(String name, double version, String info)
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
protected AuthProvider(String name, String versionStr, String info)
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 Detail
-
login
public abstract void login(Subject subject, CallbackHandler handler) throws LoginException
Log in to this provider.The provider relies on a
CallbackHandlerto obtain authentication information from the caller (a PIN, for example). If the caller passes anullhandler to this method, the provider uses the handler set in thesetCallbackHandlermethod. 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- theSubjectwhich 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- theCallbackHandlerused 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"), wherenameis the value returned by this provider'sgetNamemethod
-
logout
public abstract void logout() throws LoginExceptionLog 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"), wherenameis the value returned by this provider'sgetNamemethod
-
setCallbackHandler
public abstract void setCallbackHandler(CallbackHandler handler)
Set aCallbackHandler.The provider uses this handler if one is not passed to the
loginmethod. The provider also uses this handler if it invokesloginon 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- aCallbackHandlerfor 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"), wherenameis the value returned by this provider'sgetNamemethod
-
-