ucar.httpservices

Class HTTPCachingProvider

java.lang.Object

ucar.httpservices.HTTPCachingProvider

All Implemented Interfaces:

org.apache.http.client.CredentialsProvider

public class HTTPCachingProvider
extends java.lang.Object
implements org.apache.http.client.CredentialsProvider

With httpclient 4.2.x, credentials caching is pushed to the CredentialsProvider implementation. See org.apache.http.impl.client.BasicCredentialsProvider, for an example. However, most existing CredentialsProviders do not do caching.

So this class is used as a wrapper around CredentialsProviders to supply caching support. The cache itself is a singleton kept as static data in this class.

Previously, the cache was per-session, but this turn out to be a mistake because the opendap code repeatedly calls the server in checkifdods() with a new HTTPSession, so we get repeated requests to the credentials provider.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTTPCachingProvider.Triple

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.auth.AuthScope	authscope
protected static java.util.List<HTTPCachingProvider.Triple>	cache
protected java.lang.String	principal
static java.lang.String	PROXY_AUTH_RESP
protected HTTPAuthStore	store
static boolean	TESTING
protected static java.util.List<HTTPCachingProvider.Triple>	testlist
static java.lang.String	WWW_AUTH_RESP

Constructor Summary

Constructors

Constructor and Description
HTTPCachingProvider(HTTPAuthStore store, org.apache.http.auth.AuthScope authscope, java.lang.String principal)

Method Summary

Modifier and Type	Method and Description
protected static org.apache.http.auth.Credentials	cacheCredentials(java.lang.String principal, org.apache.http.auth.AuthScope scope, org.apache.http.auth.Credentials creds) Insert a credentials into the cache; will return any previous value.
protected static org.apache.http.auth.Credentials	checkCache(java.lang.String principal, org.apache.http.auth.AuthScope scope) Retrieve a credentials from the cache.
void	clear()
static void	clearCache()
static java.util.List<HTTPCachingProvider.Triple>	getCache()
org.apache.http.auth.Credentials	getCredentials(org.apache.http.auth.AuthScope scope)
static java.util.List<HTTPCachingProvider.Triple>	getTestList()
static void	invalidate(org.apache.http.auth.AuthScope scope) Clear some entries matching the argument
void	setCredentials(org.apache.http.auth.AuthScope scope, org.apache.http.auth.Credentials creds)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

WWW_AUTH_RESP

public static final java.lang.String WWW_AUTH_RESP

See Also:

Constant Field Values

PROXY_AUTH_RESP

public static final java.lang.String PROXY_AUTH_RESP

See Also:

Constant Field Values

TESTING

public static boolean TESTING

store

protected HTTPAuthStore store

authscope

protected org.apache.http.auth.AuthScope authscope

principal

protected java.lang.String principal

cache

protected static java.util.List<HTTPCachingProvider.Triple> cache

testlist

protected static java.util.List<HTTPCachingProvider.Triple> testlist

Constructor Detail

HTTPCachingProvider

public HTTPCachingProvider(HTTPAuthStore store,
                           org.apache.http.auth.AuthScope authscope,
                           java.lang.String principal)

Method Detail

getCredentials

public org.apache.http.auth.Credentials getCredentials(org.apache.http.auth.AuthScope scope)

Specified by:

getCredentials in interface org.apache.http.client.CredentialsProvider

setCredentials

public void setCredentials(org.apache.http.auth.AuthScope scope,
                           org.apache.http.auth.Credentials creds)

Specified by:

setCredentials in interface org.apache.http.client.CredentialsProvider

clear

public void clear()

Specified by:

clear in interface org.apache.http.client.CredentialsProvider

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

cacheCredentials

protected static org.apache.http.auth.Credentials cacheCredentials(java.lang.String principal,
                                                                   org.apache.http.auth.AuthScope scope,
                                                                   org.apache.http.auth.Credentials creds)

Insert a credentials into the cache; will return any previous value.

Parameters:

scope - the key for retrieving a credentials object.

creds - the credentials object associated with this key

Returns:

the old credentials object if overwriting, else null

checkCache

protected static org.apache.http.auth.Credentials checkCache(java.lang.String principal,
                                                             org.apache.http.auth.AuthScope scope)

Retrieve a credentials from the cache.

Parameters:

principal - a key for retrieving a credentials object.

scope - a key for retrieving a credentials object.

Returns:

the matching credentials object, else null

invalidate

public static void invalidate(org.apache.http.auth.AuthScope scope)

Clear some entries matching the argument

clearCache

public static void clearCache()

getCache

public static java.util.List<HTTPCachingProvider.Triple> getCache()

getTestList

public static java.util.List<HTTPCachingProvider.Triple> getTestList()