ucar.httpservices

Class HTTPSession

java.lang.Object

ucar.httpservices.HTTPSession

All Implemented Interfaces:

AutoCloseable

@NotThreadSafe
public class HTTPSession
extends Object
implements AutoCloseable

A session is encapsulated in an instance of the class HTTPSession. The encapsulation is with respect to a specific url This means that once a session is specified, it is tied permanently to that url.

It is important to note that Session objects do NOT correspond with the HttpClient objects of the Apache httpclient library. A Session does, however, encapsulate an instance of an Apache HttpClient.

It is possible to specify a url when invoking, for example, HTTPFactory.Get. This is because the url argument to the HTTPSession constructor actually serves two purposes. First, if the method is created without specifying a url, then the session url is used to specify the data to be retrieved by the method invocation. Second, if the method is created and specifies a url, for example, HTTPMethod m = HTTPFactory.Get(session,url2); this second url is used to specify the data to be retrieved by the method invocation. This might (and does) occur if, for example, the url given to HTTPSession represented some general url such as http://motherlode.ucar.edu/path/file.nc and the url given to HTTPFactory.Get was for something more specific such as http://motherlode.ucar.edu/path/file.nc.dds.

The important point is that in this second method, the url must be "compatible" with the session url. The term "compatible" basically means that the HTTPSession url, as a string, must be a prefix of the url given to HTTPFactory.Get. This maintains the semantics of the Session but allows flexibility in accessing data from the server.

Note that the term legalurl means that the url has reserved characters within identifieers in escaped form. This is particularly and issue for queries. Especially: ?x[0:5] is legal and the square brackets need not be encoded.

Finally, note that if the session was created with no url then all method constructions must specify a url.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTTPSession.RetryHandler

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCEPT_ENCODING
static String	ALLOW_CIRCULAR_REDIRECTS
protected HTTPAuthStore	authlocal
static String	BASIC
protected boolean	closed
static String	COMPRESSION
static String	CONN_TIMEOUT
static String	DIGEST
protected org.apache.http.protocol.HttpContext	execcontext
static String	HANDLE_AUTHENTICATION
static String	HANDLE_REDIRECTS
static String	HEADER_USERAGENT
protected String	identifier
protected List<Object>	intercepts
protected String	legalurl
protected ucar.httpservices.HTTPSession.Settings	localsettings
static org.slf4j.Logger	log
static String	MAX_REDIRECTS
protected List<HTTPMethod>	methodList
static String	NTLM
static String	PROXY
protected org.apache.http.impl.client.AbstractHttpClient	sessionClient
static String	SO_TIMEOUT
static String	SSL
static boolean	TESTING
static String	USER_AGENT

Constructor Summary

Constructors

Constructor and Description
HTTPSession()
HTTPSession(String url)

Method Summary

Methods

Modifier and Type	Method and Description
static String	canonicalpath(String path) Convert path to use '/' consistently and to remove any trailing '/'
void	clearState()
void	close() Close the session.
static void	debugHeaders(boolean print)
static HTTPUtil.InterceptRequest	debugRequestInterceptor()
static void	debugReset()
static HTTPUtil.InterceptResponse	debugResponseInterceptor()
protected static void	defineCredentialsProvider(String principal, org.apache.http.auth.AuthScope scope, org.apache.http.client.CredentialsProvider provider, HTTPAuthStore store)
protected org.apache.http.HttpResponse	execute(org.apache.http.client.methods.HttpRequestBase request)
HTTPAuthStore	getAuthStore()
static String	getCanonicalURL(String legalurl)
List<org.apache.http.cookie.Cookie>	getCookies()
static List<org.apache.http.cookie.Cookie>	getGlobalCookies()
static ucar.httpservices.HTTPSession.Settings	getGlobalSettings()
static int	getGlobalThreadCount()
static String	getGlobalUserAgent()
int	getMethodcount()
static int	getRetryCount()
ucar.httpservices.HTTPSession.Settings	getSettings()
String	getURL()
static String	getUrlAsString(String url)
boolean	isClosed()
protected static void	kill()
static int	putUrlAsString(String content, String url)
static String	removeprincipal(String u)
protected void	setAuthentication(HTTPCachingProvider hap)
void	setAuthStore(HTTPAuthStore store)
void	setConnectionTimeout(int timeout)
void	setCredentials(String scheme, org.apache.http.auth.Credentials creds)
void	setCredentialsProvider(org.apache.http.auth.AuthScope scope, org.apache.http.client.CredentialsProvider provider)
void	setCredentialsProvider(org.apache.http.client.CredentialsProvider provider)
void	setCredentialsProvider(String surl)
void	setCredentialsProvider(String scheme, org.apache.http.client.CredentialsProvider provider)
static void	setGlobalCompression()
static void	setGlobalConnectionTimeout(int timeout)
static void	setGlobalCredentials(org.apache.http.auth.AuthScope scope, org.apache.http.auth.Credentials creds)
static void	setGlobalCredentialsProvider(org.apache.http.auth.AuthScope scope, org.apache.http.client.CredentialsProvider provider)
static void	setGlobalCredentialsProvider(org.apache.http.client.CredentialsProvider provider)
static void	setGlobalMaxConnections(int nthreads)
static void	setGlobalProxy(String host, int port)
static void	setGlobalSoTimeout(int timeout)
static void	setGlobalThreadCount(int nthreads)
static void	setGlobalUserAgent(String userAgent)
void	setMaxRedirects(int n)
void	setProxy(String host, int port)
static void	setRetryCount(int count)
void	setSoTimeout(int timeout)
void	setUserAgent(String agent)
protected static void	track(HTTPSession session)

Methods inherited from class java.lang.Object

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

Field Detail

ALLOW_CIRCULAR_REDIRECTS

public static final String ALLOW_CIRCULAR_REDIRECTS

See Also:

Constant Field Values

HANDLE_REDIRECTS

public static final String HANDLE_REDIRECTS

See Also:

Constant Field Values

HANDLE_AUTHENTICATION

public static final String HANDLE_AUTHENTICATION

See Also:

Constant Field Values

MAX_REDIRECTS

public static final String MAX_REDIRECTS

See Also:

Constant Field Values

SO_TIMEOUT

public static final String SO_TIMEOUT

See Also:

Constant Field Values

CONN_TIMEOUT

public static final String CONN_TIMEOUT

See Also:

Constant Field Values

USER_AGENT

public static final String USER_AGENT

See Also:

Constant Field Values

PROXY

public static final String PROXY

See Also:

Constant Field Values

COMPRESSION

public static final String COMPRESSION

See Also:

Constant Field Values

HEADER_USERAGENT

public static final String HEADER_USERAGENT

See Also:

Constant Field Values

ACCEPT_ENCODING

public static final String ACCEPT_ENCODING

See Also:

Constant Field Values

BASIC

public static final String BASIC

See Also:

Constant Field Values

DIGEST

public static final String DIGEST

See Also:

Constant Field Values

NTLM

public static final String NTLM

See Also:

Constant Field Values

SSL

public static final String SSL

See Also:

Constant Field Values

log

public static org.slf4j.Logger log

sessionClient

protected org.apache.http.impl.client.AbstractHttpClient sessionClient

methodList

protected List<HTTPMethod> methodList

execcontext

protected org.apache.http.protocol.HttpContext execcontext

identifier

protected String identifier

legalurl

protected String legalurl

closed

protected boolean closed

localsettings

protected ucar.httpservices.HTTPSession.Settings localsettings

authlocal

protected HTTPAuthStore authlocal

intercepts

protected List<Object> intercepts

TESTING

public static boolean TESTING

Constructor Detail

HTTPSession

public HTTPSession()
            throws HTTPException

Throws:

HTTPException

HTTPSession

public HTTPSession(String url)
            throws HTTPException

Throws:

HTTPException

Method Detail

getGlobalSettings

public static ucar.httpservices.HTTPSession.Settings getGlobalSettings()

setGlobalUserAgent

public static void setGlobalUserAgent(String userAgent)

getGlobalUserAgent

public static String getGlobalUserAgent()

setGlobalThreadCount

public static void setGlobalThreadCount(int nthreads)

setGlobalMaxConnections

public static void setGlobalMaxConnections(int nthreads)

getGlobalThreadCount

public static int getGlobalThreadCount()

getGlobalCookies

public static List<org.apache.http.cookie.Cookie> getGlobalCookies()

setGlobalConnectionTimeout

public static void setGlobalConnectionTimeout(int timeout)

setGlobalSoTimeout

public static void setGlobalSoTimeout(int timeout)

setGlobalProxy

public static void setGlobalProxy(String host,
                  int port)

setGlobalCompression

public static void setGlobalCompression()

defineCredentialsProvider

protected static void defineCredentialsProvider(String principal,
                             org.apache.http.auth.AuthScope scope,
                             org.apache.http.client.CredentialsProvider provider,
                             HTTPAuthStore store)

setGlobalCredentialsProvider

public static void setGlobalCredentialsProvider(org.apache.http.auth.AuthScope scope,
                                org.apache.http.client.CredentialsProvider provider)

setGlobalCredentialsProvider

public static void setGlobalCredentialsProvider(org.apache.http.client.CredentialsProvider provider)

setGlobalCredentials

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

getRetryCount

public static int getRetryCount()

setRetryCount

public static void setRetryCount(int count)

getCanonicalURL

public static String getCanonicalURL(String legalurl)

canonicalpath

public static String canonicalpath(String path)

Convert path to use '/' consistently and to remove any trailing '/'

Parameters:

path - convert this path

Returns:

canonicalized version

removeprincipal

public static String removeprincipal(String u)

getUrlAsString

public static String getUrlAsString(String url)
                             throws HTTPException

Throws:

HTTPException

putUrlAsString

public static int putUrlAsString(String content,
                 String url)
                          throws HTTPException

Throws:

HTTPException

getAuthStore

public HTTPAuthStore getAuthStore()

setAuthStore

public void setAuthStore(HTTPAuthStore store)

getSettings

public ucar.httpservices.HTTPSession.Settings getSettings()

getURL

public String getURL()

setUserAgent

public void setUserAgent(String agent)

setSoTimeout

public void setSoTimeout(int timeout)

setConnectionTimeout

public void setConnectionTimeout(int timeout)

setMaxRedirects

public void setMaxRedirects(int n)

close

public void close()

Close the session. This implies closing any open methods.

Specified by:

close in interface AutoCloseable

getCookies

public List<org.apache.http.cookie.Cookie> getCookies()

clearState

public void clearState()

setProxy

public void setProxy(String host,
            int port)

setCredentialsProvider

public void setCredentialsProvider(org.apache.http.auth.AuthScope scope,
                          org.apache.http.client.CredentialsProvider provider)

setCredentialsProvider

public void setCredentialsProvider(org.apache.http.client.CredentialsProvider provider)

setCredentialsProvider

public void setCredentialsProvider(String scheme,
                          org.apache.http.client.CredentialsProvider provider)

setCredentials

public void setCredentials(String scheme,
                  org.apache.http.auth.Credentials creds)

setCredentialsProvider

public void setCredentialsProvider(String surl)
                            throws HTTPException

Throws:

HTTPException

setAuthentication

protected void setAuthentication(HTTPCachingProvider hap)

execute

protected org.apache.http.HttpResponse execute(org.apache.http.client.methods.HttpRequestBase request)
                                        throws IOException

Throws:

IOException

isClosed

public boolean isClosed()

getMethodcount

public int getMethodcount()

kill

protected static void kill()

track

protected static void track(HTTPSession session)

debugHeaders

public static void debugHeaders(boolean print)

debugReset

public static void debugReset()

debugRequestInterceptor

public static HTTPUtil.InterceptRequest debugRequestInterceptor()

debugResponseInterceptor

public static HTTPUtil.InterceptResponse debugResponseInterceptor()