ucar.httpservices

Class HTTPSession

java.lang.Object

ucar.httpservices.HTTPSession

All Implemented Interfaces:

java.lang.AutoCloseable

@NotThreadSafe
public class HTTPSession
extends java.lang.Object
implements java.lang.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 java.lang.String	ACCEPT_ENCODING
static java.lang.String	ALLOW_CIRCULAR_REDIRECTS
protected HTTPAuthStore	authlocal
static java.lang.String	BASIC
protected boolean	closed
static java.lang.String	COMPRESSION
static java.lang.String	CONN_TIMEOUT
static java.lang.String	DIGEST
protected org.apache.http.protocol.HttpContext	execcontext
static java.lang.String	HANDLE_AUTHENTICATION
static java.lang.String	HANDLE_REDIRECTS
static java.lang.String	HEADER_USERAGENT
protected java.lang.String	identifier
protected java.util.List<java.lang.Object>	intercepts
protected java.lang.String	legalurl
protected ucar.httpservices.HTTPSession.Settings	localsettings
static org.slf4j.Logger	log
static java.lang.String	MAX_REDIRECTS
protected java.util.List<HTTPMethod>	methodList
static java.lang.String	NTLM
static java.lang.String	PROXY
protected org.apache.http.impl.client.AbstractHttpClient	sessionClient
static java.lang.String	SO_TIMEOUT
static java.lang.String	SSL
static boolean	TESTING
static java.lang.String	USER_AGENT

Constructor Summary

Constructors

Constructor and Description
HTTPSession()
HTTPSession(java.lang.String url)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	canonicalpath(java.lang.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(java.lang.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 java.lang.String	getCanonicalURL(java.lang.String legalurl)
java.util.List<org.apache.http.cookie.Cookie>	getCookies()
static java.util.List<org.apache.http.cookie.Cookie>	getGlobalCookies()
static ucar.httpservices.HTTPSession.Settings	getGlobalSettings()
static int	getGlobalThreadCount()
static java.lang.String	getGlobalUserAgent()
int	getMethodcount()
static int	getRetryCount()
ucar.httpservices.HTTPSession.Settings	getSettings()
java.lang.String	getURL()
static java.lang.String	getUrlAsString(java.lang.String url)
boolean	isClosed()
protected static void	kill()
static int	putUrlAsString(java.lang.String content, java.lang.String url)
static java.lang.String	removeprincipal(java.lang.String u)
protected void	setAuthentication(HTTPCachingProvider hap)
void	setAuthStore(HTTPAuthStore store)
void	setConnectionTimeout(int timeout)
void	setCredentials(java.lang.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(java.lang.String surl)
void	setCredentialsProvider(java.lang.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(java.lang.String host, int port)
static void	setGlobalSoTimeout(int timeout)
static void	setGlobalThreadCount(int nthreads)
static void	setGlobalUserAgent(java.lang.String userAgent)
void	setMaxRedirects(int n)
void	setProxy(java.lang.String host, int port)
static void	setRetryCount(int count)
void	setSoTimeout(int timeout)
void	setUserAgent(java.lang.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 java.lang.String ALLOW_CIRCULAR_REDIRECTS

See Also:

Constant Field Values

HANDLE_REDIRECTS

public static final java.lang.String HANDLE_REDIRECTS

See Also:

Constant Field Values

HANDLE_AUTHENTICATION

public static final java.lang.String HANDLE_AUTHENTICATION

See Also:

Constant Field Values

MAX_REDIRECTS

public static final java.lang.String MAX_REDIRECTS

See Also:

Constant Field Values

SO_TIMEOUT

public static final java.lang.String SO_TIMEOUT

See Also:

Constant Field Values

CONN_TIMEOUT

public static final java.lang.String CONN_TIMEOUT

See Also:

Constant Field Values

USER_AGENT

public static final java.lang.String USER_AGENT

See Also:

Constant Field Values

PROXY

public static final java.lang.String PROXY

See Also:

Constant Field Values

COMPRESSION

public static final java.lang.String COMPRESSION

See Also:

Constant Field Values

HEADER_USERAGENT

public static final java.lang.String HEADER_USERAGENT

See Also:

Constant Field Values

ACCEPT_ENCODING

public static final java.lang.String ACCEPT_ENCODING

See Also:

Constant Field Values

BASIC

public static final java.lang.String BASIC

See Also:

Constant Field Values

DIGEST

public static final java.lang.String DIGEST

See Also:

Constant Field Values

NTLM

public static final java.lang.String NTLM

See Also:

Constant Field Values

SSL

public static final java.lang.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 java.util.List<HTTPMethod> methodList

execcontext

protected org.apache.http.protocol.HttpContext execcontext

identifier

protected java.lang.String identifier

legalurl

protected java.lang.String legalurl

closed

protected boolean closed

localsettings

protected ucar.httpservices.HTTPSession.Settings localsettings

authlocal

protected HTTPAuthStore authlocal

intercepts

protected java.util.List<java.lang.Object> intercepts

TESTING

public static boolean TESTING

Constructor Detail

HTTPSession

public HTTPSession()
            throws HTTPException

Throws:

HTTPException

HTTPSession

public HTTPSession(java.lang.String url)
            throws HTTPException

Throws:

HTTPException

Method Detail

getGlobalSettings

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

setGlobalUserAgent

public static void setGlobalUserAgent(java.lang.String userAgent)

getGlobalUserAgent

public static java.lang.String getGlobalUserAgent()

setGlobalThreadCount

public static void setGlobalThreadCount(int nthreads)

setGlobalMaxConnections

public static void setGlobalMaxConnections(int nthreads)

getGlobalThreadCount

public static int getGlobalThreadCount()

getGlobalCookies

public static java.util.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(java.lang.String host,
                                  int port)

setGlobalCompression

public static void setGlobalCompression()

defineCredentialsProvider

protected static void defineCredentialsProvider(java.lang.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 java.lang.String getCanonicalURL(java.lang.String legalurl)

canonicalpath

public static java.lang.String canonicalpath(java.lang.String path)

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

Parameters:

path - convert this path

Returns:

canonicalized version

removeprincipal

public static java.lang.String removeprincipal(java.lang.String u)

getUrlAsString

public static java.lang.String getUrlAsString(java.lang.String url)
                                       throws HTTPException

Throws:

HTTPException

putUrlAsString

public static int putUrlAsString(java.lang.String content,
                                 java.lang.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 java.lang.String getURL()

setUserAgent

public void setUserAgent(java.lang.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 java.lang.AutoCloseable

getCookies

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

clearState

public void clearState()

setProxy

public void setProxy(java.lang.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(java.lang.String scheme,
                                   org.apache.http.client.CredentialsProvider provider)

setCredentials

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

setCredentialsProvider

public void setCredentialsProvider(java.lang.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 java.io.IOException

Throws:

java.io.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()