ucar.httpservices

Class HTTPAuthStore

java.lang.Object

ucar.httpservices.HTTPAuthStore

All Implemented Interfaces:

java.io.Serializable

public class HTTPAuthStore
extends java.lang.Object
implements java.io.Serializable

HTTPAuthStore maps (AuthSchemes X AuthScope) to a credentials provider. It can be used as a singleton class to store "default"/"global" authorizations. It can also be instantiated in an HTTPSession object to provide per-session authorization information. In practice the map is stored as Scheme x (Scope x Provider). where the latter map is actuall a list.

Access is provided in a thread safe manner. It currently supports serial access.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTTPAuthStore.Scope

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	log
protected HTTPAuthStore	parent
protected java.util.Map<java.lang.String,java.util.List<HTTPAuthStore.Scope>>	rows
static boolean	TESTING

Constructor Summary

Constructors

Constructor and Description
HTTPAuthStore()
HTTPAuthStore(HTTPAuthStore parent)

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all auth store entries
java.util.List<HTTPAuthStore.Scope>	getAllRows() Return all entries in the auth store
protected java.util.List<HTTPAuthStore.Scope>	getScopes(java.lang.String scheme)
org.apache.http.client.CredentialsProvider	insert(org.apache.http.auth.AuthScope scope, org.apache.http.client.CredentialsProvider provider)
org.apache.http.client.CredentialsProvider	lookup(org.apache.http.auth.AuthScope scope)
org.apache.http.client.CredentialsProvider	remove(org.apache.http.auth.AuthScope scope)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static org.slf4j.Logger log

TESTING

public static boolean TESTING

rows

protected java.util.Map<java.lang.String,java.util.List<HTTPAuthStore.Scope>> rows

parent

protected HTTPAuthStore parent

Constructor Detail

HTTPAuthStore

public HTTPAuthStore()

HTTPAuthStore

public HTTPAuthStore(HTTPAuthStore parent)

Method Detail

insert

public org.apache.http.client.CredentialsProvider insert(org.apache.http.auth.AuthScope scope,
                                                         org.apache.http.client.CredentialsProvider provider)
                                                  throws HTTPException

Parameters:

scope -

provider -

Returns:

old provider if entry already existed and was replaced, else null.

Throws:

HTTPException

remove

public org.apache.http.client.CredentialsProvider remove(org.apache.http.auth.AuthScope scope)
                                                  throws HTTPException

Parameters:

scope -

Returns:

old entry if entry existed and was removed

Throws:

HTTPException

clear

public void clear()

Remove all auth store entries

getAllRows

public java.util.List<HTTPAuthStore.Scope> getAllRows()

Return all entries in the auth store

lookup

public org.apache.http.client.CredentialsProvider lookup(org.apache.http.auth.AuthScope scope)

getScopes

protected java.util.List<HTTPAuthStore.Scope> getScopes(java.lang.String scheme)