AuthProvider (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.security
class AuthProvider

java.lang.Object
  java.util.Dictionary
      java.util.Hashtable
          java.util.Properties
              java.security.Provider
                  java.security.AuthProvider

All Implemented Interfaces:: Serializable, Cloneable, Map

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.

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(String name, double version, String info)` Constructs a provider with the specified name, version number, and information.

Method Summary
`abstract 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 a `CallbackHandler`.

Methods inherited from class java.security.Provider
`clear, elements, entrySet, get, getInfo, getName, getProperty, getService, getServices, getVersion, keys, keySet, load, put, putAll, putService, remove, removeService, toString, values`

Methods inherited from class java.util.Properties
`getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames`

Methods inherited from class java.util.Hashtable
`clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values`

Methods inherited from class java.util.Dictionary
`elements, get, isEmpty, keys, put, remove, size`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

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

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.

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 - if the login operation fails

logout

public abstract void logout()
                     throws LoginException

Log out from this provider.

Throws:: LoginException - if the logout operation fails

setCallbackHandler

public abstract 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.

Parameters:: handler - a CallbackHandler for obtaining authentication information, which may be null