AuthProvider (Java Platform SE 6) (original) (raw)
java.security
Class AuthProvider
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 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 | |
|---|---|
| protected | [AuthProvider](../../java/security/AuthProvider.html#AuthProvider%28java.lang.String, double, java.lang.String%29)(String name, double version,String info) Constructs a provider with the specified name, version number, and information. |
| Method Summary | |
|---|---|
| abstract void | [login](../../java/security/AuthProvider.html#login%28javax.security.auth.Subject, javax.security.auth.callback.CallbackHandler%29)(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. |
| Methods inherited from class java.security.Provider |
|---|
| clear, elements, entrySet, get, getInfo, getName, getProperty, [getService](../../java/security/Provider.html#getService%28java.lang.String, java.lang.String%29), getServices, getVersion, keys, keySet, load, [put](../../java/security/Provider.html#put%28java.lang.Object, java.lang.Object%29), putAll, putService, remove, removeService, toString, values |
| Methods inherited from class java.util.Properties |
|---|
| [getProperty](../../java/util/Properties.html#getProperty%28java.lang.String, java.lang.String%29), list, list, load, loadFromXML, propertyNames, [save](../../java/util/Properties.html#save%28java.io.OutputStream, java.lang.String%29), [setProperty](../../java/util/Properties.html#setProperty%28java.lang.String, java.lang.String%29), [store](../../java/util/Properties.html#store%28java.io.OutputStream, java.lang.String%29), [store](../../java/util/Properties.html#store%28java.io.Writer, java.lang.String%29), [storeToXML](../../java/util/Properties.html#storeToXML%28java.io.OutputStream, java.lang.String%29), [storeToXML](../../java/util/Properties.html#storeToXML%28java.io.OutputStream, java.lang.String, java.lang.String%29), stringPropertyNames |
| Methods inherited from class java.util.Hashtable |
|---|
| clone, contains, containsKey, containsValue, equals, hashCode, isEmpty, rehash, size |
| Methods inherited from class java.lang.Object |
|---|
| finalize, getClass, notify, notifyAll, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29) |
| Constructor Detail |
|---|
AuthProvider
protected AuthProvider(String name, double version, String info)
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.
| Method Detail |
|---|
login
public abstract void login(Subject subject, CallbackHandler handler) throws LoginException
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 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 - 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 null
Throws:
[LoginException](../../javax/security/auth/login/LoginException.html "class in javax.security.auth.login") - if the login operation fails
[SecurityException](../../java/lang/SecurityException.html "class in java.lang") - if the caller does not pass a security check forSecurityPermission("authProvider._name_"), where name is the value returned by this provider's getName method
logout
public abstract void logout() throws LoginException
Log out from this provider.
Throws:
[LoginException](../../javax/security/auth/login/LoginException.html "class in javax.security.auth.login") - if the logout operation fails
[SecurityException](../../java/lang/SecurityException.html "class in java.lang") - if the caller does not pass a security check forSecurityPermission("authProvider._name_"), where name is the value returned by this provider's getName method
setCallbackHandler
public abstract void setCallbackHandler(CallbackHandler handler)
Set a CallbackHandler.
The provider uses this handler if one is not passed to thelogin 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 obtaining authentication information, which may be null
Throws:
[SecurityException](../../java/lang/SecurityException.html "class in java.lang") - if the caller does not pass a security check forSecurityPermission("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 Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.