Summary: Inherited Fields | Protected Ctors | Methods | Inherited Methods | [Expand All]

public abstract class

AuthProvider

extends Provider

java.lang.Object
↳	java.util.Dictionary<K, V>
	↳	java.util.Hashtable<K, V>
		↳	java.util.Properties
			↳	java.security.Provider
				↳	java.security.AuthProvider

Class Overview

AuthProvider is an abstract superclass for Java Security Provider which provide login and logout.

Summary

[Expand]

Inherited Fields

From class java.util.Properties

Protected Constructors
	AuthProvider(String name, double version, String info) Constructs a new instance of `AuthProvider` with its name, version and description.

Public Methods
abstract void	login(Subject subject, CallbackHandler handler) Performs a login into this `AuthProvider`.
abstract void	logout() Performs a logout from this `AuthProvider`.
abstract void	setCallbackHandler(CallbackHandler handler) Sets the `CallbackHandler` to this `AuthProvider`.

[Expand]

Inherited Methods

From class java.security.Provider

synchronized void	clear() Clears all properties used to look up services implemented by this `Provider`.
synchronized Set<Entry<Object, Object>>	entrySet() Returns a set of the mappings contained in this `Hashtable`.
String	getInfo() Returns a description of the services being provided.
String	getName() Returns the name of this provider.
synchronized Provider.Service	getService(String type, String algorithm) Returns the service with the specified `type` implementing the specified `algorithm`, or `null` if no such implementation exists.
synchronized Set<Provider.Service>	getServices() Returns an unmodifiable `Set` of all services registered by this provider.
double	getVersion() Returns the version number for the services being provided.
Set<Object>	keySet() Returns a set of the keys contained in this `Hashtable`.
synchronized void	load(InputStream inStream) Loads properties from the specified `InputStream`.
synchronized Object	put(Object key, Object value) Maps the specified `key` property name to the specified `value`.
synchronized void	putAll(Map<?, ?> t) Copies all from the provided map to this `Provider`.
synchronized void	putService(Provider.Service s) Adds a `Service` to this `Provider`.
synchronized Object	remove(Object key) Removes the specified `key` and its associated value from this `Provider`.
synchronized void	removeService(Provider.Service s) Removes a previously registered `Service` from this `Provider`.
String	toString() Returns a string containing a concise, human-readable description of this `Provider` including its name and its version.
Collection<Object>	values() Returns a collection of the values contained in this `Hashtable`.

From class java.util.Properties

String	getProperty(String name, String defaultValue) Searches for the property with the specified name.
String	getProperty(String name) Searches for the property with the specified name.
void	list(PrintStream out) Lists the mappings in this `Properties` to the specified `PrintStream` in a human readable form.
void	list(PrintWriter writer) Lists the mappings in this `Properties` to the specified `PrintWriter` in a human readable form.
synchronized void	load(InputStream in) Loads properties from the specified `InputStream`.
synchronized void	loadFromXML(InputStream in) Loads the properties from an `InputStream` containing the properties in XML form.
Enumeration<?>	propertyNames() Returns all of the property names that this `Properties` object contains.
void	save(OutputStream out, String comment) This method is deprecated. This method ignores any `IOException` thrown while writing -- use `store(OutputStream, String)` instead for better exception handling.
Object	setProperty(String name, String value) Maps the specified key to the specified value.
synchronized void	store(OutputStream out, String comment) Stores the mappings in this `Properties` to the specified `OutputStream`, putting the specified comment at the beginning.
void	storeToXML(OutputStream os, String comment) Writes all properties stored in this instance into the `OutputStream` in XML representation.
synchronized void	storeToXML(OutputStream os, String comment, String encoding) Writes all properties stored in this instance into the `OutputStream` in XML representation.

From class java.util.Hashtable

synchronized void	clear() Removes all key/value pairs from this `Hashtable`, leaving the size zero and the capacity unchanged.
synchronized Object	clone() Returns a new `Hashtable` with the same key/value pairs, capacity and load factor.
boolean	contains(Object value) Returns true if this `Hashtable` contains the specified object as the value of at least one of the key/value pairs.
synchronized boolean	containsKey(Object key) Returns true if this `Hashtable` contains the specified object as a key of one of the key/value pairs.
synchronized boolean	containsValue(Object value) Searches this `Hashtable` for the specified value.
synchronized Enumeration<V>	elements() Returns an enumeration on the values of this `Hashtable`.
synchronized Set<Entry<K, V>>	entrySet() Returns a set of the mappings contained in this `Hashtable`.
synchronized boolean	equals(Object object) Compares this `Hashtable` with the specified object and indicates if they are equal.
synchronized V	get(Object key) Returns the value associated with the specified key in this `Hashtable`.
synchronized int	hashCode() Returns an integer hash code for this object.
synchronized boolean	isEmpty() Returns true if this `Hashtable` has no key/value pairs.
synchronized Set<K>	keySet() Returns a set of the keys contained in this `Hashtable`.
synchronized Enumeration<K>	keys() Returns an enumeration on the keys of this `Hashtable` instance.
synchronized V	put(K key, V value) Associate the specified value with the specified key in this `Hashtable`.
synchronized void	putAll(Map<? extends K, ? extends V> map) Copies every mapping to this `Hashtable` from the specified map.
void	rehash() Increases the capacity of this `Hashtable`.
synchronized V	remove(Object key) Removes the key/value pair with the specified key from this `Hashtable`.
synchronized int	size() Returns the number of key/value pairs in this `Hashtable`.
synchronized String	toString() Returns the string representation of this `Hashtable`.
synchronized Collection<V>	values() Returns a collection of the values contained in this `Hashtable`.

From class java.util.Dictionary

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Is called before the object's memory is being reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of `Class` which represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.

From interface java.util.Map

abstract void	clear() Removes all elements from this `Map`, leaving it empty.
abstract boolean	containsKey(Object key) Returns whether this `Map` contains the specified key.
abstract boolean	containsValue(Object value) Returns whether this `Map` contains the specified value.
abstract Set<Entry<K, V>>	entrySet() Returns a `Set` containing all of the mappings in this `Map`.
abstract boolean	equals(Object object) Compares the argument to the receiver, and returns `true` if the specified object is a `Map` and both `Map`s contain the same mappings.
abstract V	get(Object key) Returns the value of the mapping with the specified key.
abstract int	hashCode() Returns an integer hash code for the receiver.
abstract boolean	isEmpty() Returns whether this map is empty.
abstract Set<K>	keySet() Returns a set of the keys contained in this `Map`.
abstract V	put(K key, V value) Maps the specified key to the specified value.
abstract void	putAll(Map<? extends K, ? extends V> map) Copies every mapping in the specified `Map` to this `Map`.
abstract V	remove(Object key) Removes a mapping with the specified key from this `Map`.
abstract int	size() Returns the number of mappings in this `Map`.
abstract Collection<V>	values() Returns a `Collection` of the values contained in this `Map`.

Protected Constructors

protected AuthProvider (String name, double version, String info)

Since: API Level 1

Constructs a new instance of AuthProvider with its name, version and description.

Parameters

name	the name of the provider.
version	the version of the provider.
info	a description of the provider.

Public Methods

public abstract void login (Subject subject, CallbackHandler handler)

Since: API Level 1

Performs a login into this AuthProvider. The specified CallbackHandler is used to obtain information from the caller.

If a SecurityManager is installed, code calling this method needs the SecurityPermission authProvider.NAME (where NAME is the provider name) to be granted, otherwise a SecurityException will be thrown.

Parameters

subject	the subject that is used to login.
handler	the handler to obtain authentication information from the caller.

Throws

LoginException	if the login fails.
SecurityException	if a `SecurityManager` is installed and the caller does not have permission to invoke this method.

public abstract void logout ()

Since: API Level 1

Performs a logout from this AuthProvider.

If a SecurityManager is installed, code calling this method needs the SecurityPermission authProvider.NAME (where NAME is the provider name) to be granted, otherwise a SecurityException will be thrown.

Throws

LoginException	if the logout fails.
SecurityException	if a `SecurityManager` is installed and the caller does not have permission to invoke this method.

public abstract void setCallbackHandler (CallbackHandler handler)

Since: API Level 1

Sets the CallbackHandler to this AuthProvider. If no handler is passed to the login(Subject, CallbackHandler) method, this AuthProvider is using the specified CallbackHandler.

If no handler is set, this AuthProvider uses the CallbackHandler specified by the auth.login.defaultCallbackHandler security property.

If a SecurityManager is installed, code calling this method needs the SecurityPermission authProvider.NAME (where NAME is the provider name) to be granted, otherwise a SecurityException will be thrown.

Parameters

handler	the handler to obtain authentication information from the caller.

Throws

SecurityException	if a `SecurityManager` is installed and the caller does not have permission to invoke this method.

Interfaces

Classes

Enums

Exceptions

AuthProvider

Class Overview

Summary

Protected Constructors

protected AuthProvider (String name, double version, String info)

Parameters

Public Methods

public abstract void login (Subject subject, CallbackHandler handler)

Parameters

Throws

public abstract void logout ()

Throws

public abstract void setCallbackHandler (CallbackHandler handler)

Parameters

Throws