AuthSchemeRegistry

Authentication scheme registry that can be used to obtain the corresponding authentication scheme implementation for a given type of authorization challenge.

Summary

Public Constructors
	AuthSchemeRegistry ()

Public Constructors

AuthSchemeRegistry ()

Public Methods
synchronized AuthScheme	getAuthScheme ( String name, HttpParams params) Gets the `authentication scheme` with the given name.
synchronized List < String >	getSchemeNames () Obtains a list containing names of all registered `authentication schemes` in their default order.
synchronized void	register ( String name, AuthSchemeFactory factory) Registers a `AuthSchemeFactory` with the given identifier.
synchronized void	)">setItems ( Map < String , AuthSchemeFactory > map) Populates the internal collection of registered `authentication schemes` with the content of the map passed as a parameter.
synchronized void	unregister ( String name) Unregisters the class implementing an `authentication scheme` with the given name.

Public Methods

synchronized AuthScheme

getAuthScheme ( String name, HttpParams params)

Gets the


           
            authentication scheme

with the given name.

synchronized List < String >

getSchemeNames ()

Obtains a list containing names of all registered


           
            authentication 
 schemes

in their default order.

synchronized void

Registers a


           
            AuthSchemeFactory

with the given identifier.

synchronized void

)">setItems ( Map < String , AuthSchemeFactory > map)

Populates the internal collection of registered


           
            authentication schemes

with the content of the map passed as a parameter.

synchronized void

unregister ( String name)

Unregisters the class implementing an


           
            authentication scheme

with the given name.

[Expand]

Inherited Methods

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 () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that 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 () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method 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.

Public Methods

public synchronized AuthScheme getAuthScheme ( String name, HttpParams params)

Added in API level 1

Gets the authentication scheme with the given name.

Parameters

name	the `authentication scheme` identifier
params	the `HTTP parameters` for the authentication scheme.

Returns

authentication scheme

Throws

IllegalStateException	if a scheme with the given name cannot be found

public synchronized List < String > getSchemeNames ()

Added in API level 1

Obtains a list containing names of all registered authentication schemes in their default order.

Returns

list of registered scheme names

public synchronized void register ( String name, AuthSchemeFactory factory)

Added in API level 1

Registers a AuthSchemeFactory with the given identifier. If a factory with the given name already exists it will be overridden. This name is the same one used to retrieve the authentication scheme from getAuthScheme(String, HttpParams) .

Please note that custom authentication preferences, if used, need to be updated accordingly for the new authentication scheme to take effect.

Parameters

name	the identifier for this scheme
factory	the `AuthSchemeFactory` class to register

public synchronized void setItems ( Map < String , AuthSchemeFactory > map)

Added in API level 1

Populates the internal collection of registered authentication schemes with the content of the map passed as a parameter.

Parameters

map	authentication schemes

public synchronized void unregister ( String name)

Added in API level 1

Unregisters the class implementing an authentication scheme with the given name.

Parameters

name	the identifier of the class to unregister

Results

Interfaces

Classes

Exceptions

Class Overview

Summary

Public Constructors

public AuthSchemeRegistry ()

Public Methods

public synchronized AuthScheme getAuthScheme ( String name, HttpParams params)

Parameters

Returns

Throws

public synchronized List < String > getSchemeNames ()

Returns

public synchronized void register ( String name, AuthSchemeFactory factory)

Parameters

See Also

public synchronized void setItems ( Map < String , AuthSchemeFactory > map)

Parameters

public synchronized void unregister ( String name)

Parameters

java.lang.Object
↳	org.apache.http.auth.AuthSchemeRegistry