Build 1.0_r1(from source)

org.apache.http.auth
Class AuthSchemeRegistry

java.lang.Object
  extended by org.apache.http.auth.AuthSchemeRegistry

public final class AuthSchemeRegistry
extends Object

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

Since:
4.0

Constructor Summary
AuthSchemeRegistry()
           
 
Method Summary
 AuthScheme getAuthScheme(String name, HttpParams params)
          Gets the authentication scheme with the given name.
 List<String> getSchemeNames()
          Obtains a list containing names of all registered authentication schemes in their default order.
 void register(String name, AuthSchemeFactory factory)
          Registers a AuthSchemeFactory with the given identifier.
 void setItems(Map<String,AuthSchemeFactory> map)
          Populates the internal collection of registered authentication schemes with the content of the map passed as a parameter.
 void unregister(String name)
          Unregisters the class implementing an authentication scheme with the given name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AuthSchemeRegistry

public AuthSchemeRegistry()
Method Detail

register

public void register(String name,
                     AuthSchemeFactory factory)
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(java.lang.String, org.apache.http.params.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
See Also:
getAuthScheme(java.lang.String, org.apache.http.params.HttpParams)

unregister

public void unregister(String name)
Unregisters the class implementing an authentication scheme with the given name.

Parameters:
name - the identifier of the class to unregister

getAuthScheme

public AuthScheme getAuthScheme(String name,
                                HttpParams params)
                         throws IllegalStateException
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

getSchemeNames

public List<String> getSchemeNames()
Obtains a list containing names of all registered authentication schemes in their default order.

Returns:
list of registered scheme names

setItems

public void setItems(Map<String,AuthSchemeFactory> map)
Populates the internal collection of registered authentication schemes with the content of the map passed as a parameter.

Parameters:
map - authentication schemes

Build 1.0_r1(from source)

Please submit a feedback, bug or feature