Save This Page
Home » openjdk-7 » java » security » [javadoc | source]
java.security
abstract public class: AuthProvider [javadoc | source]
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:
    Cloneable, Map, java$io$Serializable

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.

Fields inherited from java.security.Provider:
serialVersionUID
Fields inherited from java.util.Properties:
defaults
Constructor:
 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 from java.security.AuthProvider Summary:
login,   logout,   setCallbackHandler
Methods from java.security.Provider:
clear,   elements,   entrySet,   get,   getInfo,   getName,   getProperty,   getService,   getServices,   getVersion,   keySet,   keys,   load,   put,   putAll,   putService,   remove,   removeService,   toString,   values
Methods from java.util.Properties:
getProperty,   getProperty,   list,   list,   load,   load,   loadFromXML,   propertyNames,   save,   setProperty,   store,   store,   storeToXML,   storeToXML,   stringPropertyNames
Methods from java.util.Hashtable:
clear,   clone,   contains,   containsKey,   containsValue,   elements,   entrySet,   equals,   get,   hashCode,   isEmpty,   keySet,   keys,   put,   putAll,   rehash,   remove,   size,   toString,   values
Methods from java.util.Dictionary:
elements,   get,   isEmpty,   keys,   put,   remove,   size
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.security.AuthProvider Detail:
 abstract public  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 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.

 abstract public  void logout() throws LoginException
    Log out from this provider.
 abstract public  void setCallbackHandler(CallbackHandler handler)
    Set a 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.