ucar.httpservices

Class HTTPAuthStore

java.lang.Object

ucar.httpservices.HTTPAuthStore

All Implemented Interfaces:

Serializable

public class HTTPAuthStore
extends Object
implements Serializable

HTTPAuthStore maps (Principal 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 a pair: an authscope and a credentialsprovider.

Access is provided in a thread safe manner. It currently supports serial access, but can be extended to support single writer / multiple reader semantics using the procedures {acquire,release}writeaccess and {acquire,release}readaccess

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTTPAuthStore.Entry

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY_PRINCIPAL
static HTTPAuthStore	DEFAULT
static String	DEFAULT_SCHEME
protected boolean	isdefault
static org.slf4j.Logger	log
protected List<HTTPAuthStore.Entry>	rows
static boolean	TESTING

Constructor Summary

Constructors

Constructor and Description
HTTPAuthStore()
HTTPAuthStore(boolean isdefault)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Remove all auth store entries
void	deserialize(InputStream istream, String password)
List<HTTPAuthStore.Entry>	getAllRows() Return all entries in the auth store
static HTTPAuthStore	getDefault()
protected static List<HTTPAuthStore.Entry>	getDeserializedEntries(ObjectInputStream ois)
static HTTPAuthStore	getDeserializedStore(ObjectInputStream ois)
org.apache.http.client.CredentialsProvider	insert(HTTPAuthStore.Entry entry)
org.apache.http.client.CredentialsProvider	insert(String principal, org.apache.http.auth.AuthScope scope, org.apache.http.client.CredentialsProvider provider)
static ObjectInputStream	openobjectstream(InputStream istream, String password)
void	print(PrintStream p)
void	print(PrintWriter p)
HTTPAuthStore.Entry	remove(HTTPAuthStore.Entry entry)
List<HTTPAuthStore.Entry>	search(String principal, org.apache.http.auth.AuthScope scope) Search for all equivalent rows, then sort on the path.
void	serialize(OutputStream ostream, String password)

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

DEFAULT_SCHEME

public static final String DEFAULT_SCHEME

See Also:

Constant Field Values

ANY_PRINCIPAL

public static final String ANY_PRINCIPAL

TESTING

public static boolean TESTING

DEFAULT

public static HTTPAuthStore DEFAULT

rows

protected List<HTTPAuthStore.Entry> rows

isdefault

protected boolean isdefault

Constructor Detail

HTTPAuthStore

public HTTPAuthStore()

HTTPAuthStore

public HTTPAuthStore(boolean isdefault)

Method Detail

getDefault

public static HTTPAuthStore getDefault()

insert

public org.apache.http.client.CredentialsProvider insert(String principal,
                                                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

insert

public org.apache.http.client.CredentialsProvider insert(HTTPAuthStore.Entry entry)
                                                  throws HTTPException

Parameters:

entry -

Returns:

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

Throws:

HTTPException

remove

public HTTPAuthStore.Entry remove(HTTPAuthStore.Entry entry)
                           throws HTTPException

Parameters:

entry -

Returns:

old entry if entry existed and was removed

Throws:

HTTPException

clear

public void clear()

Remove all auth store entries

getAllRows

public List<HTTPAuthStore.Entry> getAllRows()

Return all entries in the auth store

search

public List<HTTPAuthStore.Entry> search(String principal,
                               org.apache.http.auth.AuthScope scope)

Search for all equivalent rows, then sort on the path.

Parameters:

scope -

Returns:

list of matching entries

print

public void print(PrintStream p)
           throws IOException

Throws:

IOException

print

public void print(PrintWriter p)
           throws IOException

Throws:

IOException

serialize

public void serialize(OutputStream ostream,
             String password)
               throws HTTPException

Throws:

HTTPException

deserialize

public void deserialize(InputStream istream,
               String password)
                 throws HTTPException

Throws:

HTTPException

openobjectstream

public static ObjectInputStream openobjectstream(InputStream istream,
                                 String password)
                                          throws HTTPException

Throws:

HTTPException

getDeserializedStore

public static HTTPAuthStore getDeserializedStore(ObjectInputStream ois)
                                          throws HTTPException

Throws:

HTTPException

getDeserializedEntries

protected static List<HTTPAuthStore.Entry> getDeserializedEntries(ObjectInputStream ois)
                                                           throws HTTPException

Throws:

HTTPException