- 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.ProviderProvider.Service
 
- 
 - 
Field Summary- 
Fields declared in class java.util.Propertiesdefaults
 
- 
 - 
Constructor SummaryConstructors 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 SummaryAll 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.Providerclear, 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.PropertiesgetProperty, 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.
 
 - 
AuthProviderprotected 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- 
loginpublic 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- the- Subjectwhich 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- CallbackHandlerused by this provider to obtain authentication information from the caller, which may be- null
- Throws:
- IllegalStateException- if the provider requires configuration and- Provider.configure(java.lang.String)has not been called
- LoginException- if the login operation fails
- SecurityException- if the caller does not pass a security check for- SecurityPermission("authProvider.name"), where- nameis the value returned by this provider's- getNamemethod
 
 - 
logoutpublic abstract void logout() throws LoginExceptionLog out from this provider.- Throws:
- IllegalStateException- if the provider requires configuration and- Provider.configure(java.lang.String)has not been called
- LoginException- if the logout operation fails
- SecurityException- if the caller does not pass a security check for- SecurityPermission("authProvider.name"), where- nameis the value returned by this provider's- getNamemethod
 
 - 
setCallbackHandlerpublic 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- a- CallbackHandlerfor obtaining authentication information, which may be- null
- Throws:
- IllegalStateException- if the provider requires configuration and- Provider.configure(java.lang.String)has not been called
- SecurityException- if the caller does not pass a security check for- SecurityPermission("authProvider.name"), where- nameis the value returned by this provider's- getNamemethod
 
 
- 
 
-