ucar.httpservices

Class HTTPSession

java.lang.Object

ucar.httpservices.HTTPSession

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class HTTPSession
extends java.lang.Object
implements java.io.Closeable

A session is encapsulated in an instance of the class HTTPSession. The encapsulation is with respect to a specific HttpHost "realm", where the important part is is host+port. This means that once a session is specified, it is tied permanently to that realm.

A Session encapsulate a number of other objects:

• An instance of an Apache HttpClient.
• A http session id
• A RequestContext object; this also includes authentication: specifically a credential and a credentials provider.

Currently, it is assumed that only one set of credentials is needed, whether directly for server X or for server Y. This may change in the future.

As a rule, if the client gives an HTTPSession object to the "create method" procedures of HTTPFactory (e.g. HTTPFactory.Get or HTTPFactory.Post) then that creation call must specify a url that is "compatible" with the scope of the session. The method url is compatible if its host+port is the same as the session's host+port (=scope) and its scheme is compatible, where e.g. http is compatible with https (see HTTPAuthUtil.httphostCompatible)

If the HTTPFactory method creation call does not specify a session object, then one is created (and destroyed) behind the scenes along with the method.

Note that the term legalurl in the following code 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.

As of the move to Apache Httpclient 4.4 and later, the underlying HttpClient objects are generally immutable. This means that at least this class (HTTPSession) and the HTTPMethod class must store the relevant info and create the HttpClient and HttpMethod objects dynamically. This also means that when a parameter is changed (Agent, for example), any existing cached HttpClient must be thrown away and reconstructed using the change. As a rule, the HttpClient object will be created at the last minute so that multiple parameter changes can be effected without have to re-create the HttpClient for each parameter change. Also note that the immutable objects will be cached and reused if no parameters are changed.

Authorization We assume that the session supports two CredentialsProvider instances: one global to all HTTPSession objects and one specific to each HTTPSession object.

As an aside, authentication is a bit tricky because some authorization schemes use redirection. That is, the initial request is made to server X, but X says: goto to server Y" to get, say, and authorization token. Then Y says: return to X with this token and proceed.

SSL TBD.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCEPT_ENCODING
protected org.apache.http.impl.client.CloseableHttpClient	cachedclient
protected org.apache.http.client.config.RequestConfig	cachedconfig
protected boolean	cachevalid
protected static org.apache.http.HttpResponseInterceptor	CEKILL
protected boolean	closed
protected static org.apache.http.impl.conn.PoolingHttpClientConnectionManager	connmgr
protected static java.util.Map<java.lang.String,org.apache.http.client.entity.InputStreamFactory>	contentDecoderMap
protected static java.util.List<org.apache.http.HttpRequestInterceptor>	dbgreq
protected static java.util.List<org.apache.http.HttpResponseInterceptor>	dbgrsp
protected ucar.httpservices.HTTPSession.ExecState	execution
protected static java.util.Map<org.apache.http.auth.AuthScope,org.apache.http.client.CredentialsProvider>	globalcreds
protected static java.lang.Boolean	globaldebugheaders
protected static org.apache.http.conn.ssl.SSLConnectionSocketFactory	globalsslfactory
static java.lang.String	HEADER_USERAGENT
protected static org.apache.http.HttpHost	httpproxy
protected static org.apache.http.HttpHost	httpsproxy
protected java.lang.String	identifier
protected static java.lang.String	keypassword
protected static java.lang.String	keypath
protected static java.security.KeyStore	keystore
protected java.util.Map<org.apache.http.auth.AuthScope,org.apache.http.client.CredentialsProvider>	localcreds
protected ucar.httpservices.HTTPSession.Settings	localsettings
static org.slf4j.Logger	log
protected java.util.List<HTTPMethod>	methodList
protected static java.lang.String	proxypwd
protected static java.lang.String	proxyuser
protected java.net.URI	requestURI
protected org.apache.http.auth.AuthScope	scope
protected java.net.URI	scopeURI
protected org.apache.http.client.protocol.HttpClientContext	sessioncontext
protected java.lang.String	sessionURI
protected static org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory>	sslregistry
static boolean	TESTING
protected static java.lang.String	trustpassword
protected static java.lang.String	trustpath
protected static java.security.KeyStore	truststore

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HTTPSession()

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	checkCompressors(java.lang.String compressors)
HTTPSession	clearCookies()
HTTPSession	clearCredentialsCache()
void	clearState() Deprecated.
void	close() Close the session.
protected void	configClient(org.apache.http.impl.client.HttpClientBuilder cb, ucar.httpservices.HTTPSession.Settings settings)
protected org.apache.http.client.config.RequestConfig	configureRequest(org.apache.http.client.config.RequestConfig.Builder rcb, ucar.httpservices.HTTPSession.Settings settings)
static void	debugHeaders(boolean print)
static HTTPUtil.InterceptRequest	debugRequestInterceptor()
static void	debugReset()
static HTTPUtil.InterceptResponse	debugResponseInterceptor()
org.apache.http.auth.AuthScope	getAuthScope()
java.util.List<org.apache.http.cookie.Cookie>	getCookies()
org.apache.http.client.config.RequestConfig	getDebugConfig()
protected static int	getDPropInt(java.lang.String key)
static java.lang.Object	getGlobalSetting(java.lang.String key)
static int	getGlobalThreadCount()
static java.lang.String	getGlobalUserAgent()
int	getMethodcount()
org.apache.http.Header[]	getRequestHeaders()
static int	getRetryCount() Deprecated.
java.lang.String	getSessionID() Extract the sessionid cookie value
java.lang.String	getSessionURI()
java.lang.String	getSessionURL() Deprecated.
java.lang.Object	getSetting(java.lang.String key)
protected void	init(org.apache.http.auth.AuthScope scope, java.lang.String actualurl)
boolean	isClosed()
protected static void	kill()
static void	removeGlobalCompression()
protected void	setAuthenticationAndProxy(org.apache.http.impl.client.HttpClientBuilder cb) Handle authentication and Proxy'ing
HTTPSession	setConnectionTimeout(int timeout)
HTTPSession	setCredentials(org.apache.http.auth.Credentials creds) It is convenient to be able to directly set the Credentials (not the provider) when those credentials are fixed.
HTTPSession	setCredentials(org.apache.http.auth.Credentials creds, org.apache.http.auth.AuthScope scope) It is convenient to be able to directly set the Credentials (not the provider) when those credentials are fixed.
void	setCredentials(java.lang.String url, org.apache.http.auth.Credentials creds) Deprecated.
void	setCredentialsProvider(org.apache.http.auth.AuthScope scope, org.apache.http.client.CredentialsProvider provider) Deprecated.
HTTPSession	setCredentialsProvider(org.apache.http.client.CredentialsProvider provider)
HTTPSession	setCredentialsProvider(org.apache.http.client.CredentialsProvider provider, org.apache.http.auth.AuthScope scope) This is the most general case
void	setCredentialsProvider(java.lang.String url, org.apache.http.client.CredentialsProvider provider) Deprecated.
protected static void	setDefaults(ucar.httpservices.HTTPSession.Settings props)
HTTPSession	setFollowRedirects(boolean tf) Enable/disable redirection following Default is yes.
static void	setGlobalCompression() Deprecated.
static void	setGlobalCompression(java.lang.String compressors)
static void	setGlobalConnectionTimeout(int timeout)
static void	setGlobalCredentials(org.apache.http.auth.Credentials creds) It is convenient to be able to directly set the Credentials (not the provider) when those credentials are fixed.
static void	setGlobalCredentials(org.apache.http.auth.Credentials creds, org.apache.http.auth.AuthScope scope) It is convenient to be able to directly set the Credentials (not the provider) when those credentials are fixed.
static void	setGlobalCredentials(java.lang.String url, org.apache.http.auth.Credentials creds) Deprecated.
static void	setGlobalCredentialsProvider(org.apache.http.auth.AuthScope scope, org.apache.http.client.CredentialsProvider provider) Deprecated.
static void	setGlobalCredentialsProvider(org.apache.http.client.CredentialsProvider provider)
static void	setGlobalCredentialsProvider(org.apache.http.client.CredentialsProvider provider, org.apache.http.auth.AuthScope scope) This is the most general case
static void	setGlobalCredentialsProvider(org.apache.http.client.CredentialsProvider provider, java.lang.String scheme) Deprecated.
static void	setGlobalCredentialsProvider(java.lang.String url, org.apache.http.client.CredentialsProvider provider) Deprecated.
static void	setGlobalFollowRedirects(boolean tf) Enable/disable redirection following Default is yes.
static void	setGlobalMaxConnections(int nthreads)
static void	setGlobalMaxRedirects(int n) Set the max number of redirects to follow
static void	setGlobalProxy(java.lang.String proxyurl)
static void	setGlobalProxy(java.lang.String host, int port) Deprecated.
static void	setGlobalSoTimeout(int timeout)
static void	setGlobalSSLAuth(java.lang.String keypath, java.lang.String keypassword, java.lang.String trustpath, java.lang.String trustpassword)
static void	setGlobalThreadCount(int nthreads)
static void	setGlobalUserAgent(java.lang.String userAgent)
protected static void	setInterceptors(org.apache.http.impl.client.HttpClientBuilder cb)
HTTPSession	setMaxRedirects(int n) Set the max number of redirects to follow
void	setProxy(java.lang.String host, int port) Deprecated.
static void	setRetryCount(int count) Deprecated.
HTTPSession	setSoTimeout(int timeout)
HTTPSession	setUserAgent(java.lang.String agent)
HTTPSession	setUseSessions(boolean tf) Should we use sessionid's?
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

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

log

public static org.slf4j.Logger log

connmgr

protected static org.apache.http.impl.conn.PoolingHttpClientConnectionManager connmgr

CEKILL

protected static org.apache.http.HttpResponseInterceptor CEKILL

dbgreq

protected static java.util.List<org.apache.http.HttpRequestInterceptor> dbgreq

dbgrsp

protected static java.util.List<org.apache.http.HttpResponseInterceptor> dbgrsp

contentDecoderMap

protected static java.util.Map<java.lang.String,org.apache.http.client.entity.InputStreamFactory> contentDecoderMap

globalcreds

protected static java.util.Map<org.apache.http.auth.AuthScope,org.apache.http.client.CredentialsProvider> globalcreds

keystore

protected static java.security.KeyStore keystore

truststore

protected static java.security.KeyStore truststore

keypath

protected static java.lang.String keypath

keypassword

protected static java.lang.String keypassword

trustpath

protected static java.lang.String trustpath

trustpassword

protected static java.lang.String trustpassword

globalsslfactory

protected static org.apache.http.conn.ssl.SSLConnectionSocketFactory globalsslfactory

sslregistry

protected static org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> sslregistry

httpproxy

protected static org.apache.http.HttpHost httpproxy

httpsproxy

protected static org.apache.http.HttpHost httpsproxy

proxyuser

protected static java.lang.String proxyuser

proxypwd

protected static java.lang.String proxypwd

globaldebugheaders

protected static java.lang.Boolean globaldebugheaders

sessionURI

protected java.lang.String sessionURI

scopeURI

protected java.net.URI scopeURI

scope

protected org.apache.http.auth.AuthScope scope

closed

protected boolean closed

localcreds

protected java.util.Map<org.apache.http.auth.AuthScope,org.apache.http.client.CredentialsProvider> localcreds

methodList

protected java.util.List<HTTPMethod> methodList

identifier

protected java.lang.String identifier

localsettings

protected ucar.httpservices.HTTPSession.Settings localsettings

sessioncontext

protected org.apache.http.client.protocol.HttpClientContext sessioncontext

cachevalid

protected boolean cachevalid

cachedclient

protected org.apache.http.impl.client.CloseableHttpClient cachedclient

cachedconfig

protected org.apache.http.client.config.RequestConfig cachedconfig

requestURI

protected java.net.URI requestURI

execution

protected ucar.httpservices.HTTPSession.ExecState execution

TESTING

public static boolean TESTING

Constructor Detail

HTTPSession

protected HTTPSession()
               throws HTTPException

Throws:

HTTPException

Method Detail

setDefaults

protected static void setDefaults(ucar.httpservices.HTTPSession.Settings props)

getDPropInt

protected static int getDPropInt(java.lang.String key)

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()

setGlobalConnectionTimeout

public static void setGlobalConnectionTimeout(int timeout)

setGlobalSoTimeout

public static void setGlobalSoTimeout(int timeout)

setGlobalFollowRedirects

public static void setGlobalFollowRedirects(boolean tf)

Enable/disable redirection following Default is yes.

setGlobalMaxRedirects

public static void setGlobalMaxRedirects(int n)

Set the max number of redirects to follow

Parameters:

n -

getGlobalSetting

public static java.lang.Object getGlobalSetting(java.lang.String key)

setGlobalCompression

public static void setGlobalCompression(java.lang.String compressors)

removeGlobalCompression

public static void removeGlobalCompression()

checkCompressors

protected static java.lang.String checkCompressors(java.lang.String compressors)

setGlobalCredentialsProvider

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

Parameters:

provider -

Throws:

HTTPException

setGlobalCredentialsProvider

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

This is the most general case

Parameters:

provider - the credentials provider

scope - where to use it (i.e. on what host)

Throws:

HTTPException

setGlobalCredentials

public static void setGlobalCredentials(org.apache.http.auth.Credentials creds)
                                 throws HTTPException

It is convenient to be able to directly set the Credentials (not the provider) when those credentials are fixed. Scope defaults to ANY

Parameters:

creds -

Throws:

HTTPException

setGlobalCredentials

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

It is convenient to be able to directly set the Credentials (not the provider) when those credentials are fixed.

Parameters:

creds -

scope - where to use it (i.e. on what host)

Throws:

HTTPException

setGlobalSSLAuth

public static void setGlobalSSLAuth(java.lang.String keypath,
                                    java.lang.String keypassword,
                                    java.lang.String trustpath,
                                    java.lang.String trustpassword)

setGlobalProxy

public static void setGlobalProxy(java.lang.String proxyurl)

init

protected void init(org.apache.http.auth.AuthScope scope,
                    java.lang.String actualurl)
             throws HTTPException

Throws:

HTTPException

setInterceptors

protected static void setInterceptors(org.apache.http.impl.client.HttpClientBuilder cb)

getAuthScope

public org.apache.http.auth.AuthScope getAuthScope()

getSessionURI

public java.lang.String getSessionURI()

getSessionID

public java.lang.String getSessionID()

Extract the sessionid cookie value

Returns:

sessionid string

setUserAgent

public HTTPSession setUserAgent(java.lang.String agent)

setSoTimeout

public HTTPSession setSoTimeout(int timeout)

setConnectionTimeout

public HTTPSession setConnectionTimeout(int timeout)

setMaxRedirects

public HTTPSession setMaxRedirects(int n)

Set the max number of redirects to follow

Parameters:

n -

setFollowRedirects

public HTTPSession setFollowRedirects(boolean tf)

Enable/disable redirection following Default is yes.

setUseSessions

public HTTPSession setUseSessions(boolean tf)

Should we use sessionid's?

Parameters:

tf -

getCookies

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

clearCookies

public HTTPSession clearCookies()

clearCredentialsCache

public HTTPSession clearCredentialsCache()

getSetting

public java.lang.Object getSetting(java.lang.String key)

close

public void close()

Close the session. This implies closing any open methods.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

setCredentialsProvider

public HTTPSession setCredentialsProvider(org.apache.http.client.CredentialsProvider provider)
                                   throws HTTPException

Parameters:

provider -

Throws:

HTTPException

setCredentialsProvider

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

This is the most general case

Parameters:

provider - the credentials provider

scope - where to use it (i.e. on what host+port)

Throws:

HTTPException

setCredentials

public HTTPSession setCredentials(org.apache.http.auth.Credentials creds)
                           throws HTTPException

It is convenient to be able to directly set the Credentials (not the provider) when those credentials are fixed. Scope defaults to ANY

Parameters:

creds -

Throws:

HTTPException

setCredentials

public HTTPSession setCredentials(org.apache.http.auth.Credentials creds,
                                  org.apache.http.auth.AuthScope scope)
                           throws HTTPException

It is convenient to be able to directly set the Credentials (not the provider) when those credentials are fixed.

Parameters:

creds -

scope - where to use it (i.e. on what host)

Throws:

HTTPException

configureRequest

protected org.apache.http.client.config.RequestConfig configureRequest(org.apache.http.client.config.RequestConfig.Builder rcb,
                                                                       ucar.httpservices.HTTPSession.Settings settings)
                                                                throws HTTPException

Throws:

HTTPException

configClient

protected void configClient(org.apache.http.impl.client.HttpClientBuilder cb,
                            ucar.httpservices.HTTPSession.Settings settings)
                     throws HTTPException

Throws:

HTTPException

setAuthenticationAndProxy

protected void setAuthenticationAndProxy(org.apache.http.impl.client.HttpClientBuilder cb)
                                  throws HTTPException

Handle authentication and Proxy'ing

Parameters:

cb -

Throws:

HTTPException

isClosed

public boolean isClosed()

getMethodcount

public int getMethodcount()

getDebugConfig

public org.apache.http.client.config.RequestConfig getDebugConfig()

getRequestHeaders

public org.apache.http.Header[] getRequestHeaders()

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()

setGlobalCredentialsProvider

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

Deprecated.

Throws:

HTTPException

setGlobalCredentialsProvider

@Deprecated
public static void setGlobalCredentialsProvider(java.lang.String url,
                                                            org.apache.http.client.CredentialsProvider provider)
                                                     throws HTTPException

Deprecated.

Throws:

HTTPException

setGlobalCredentials

@Deprecated
public static void setGlobalCredentials(java.lang.String url,
                                                    org.apache.http.auth.Credentials creds)
                                             throws HTTPException

Deprecated.

Throws:

HTTPException

setCredentials

@Deprecated
public void setCredentials(java.lang.String url,
                                       org.apache.http.auth.Credentials creds)
                                throws HTTPException

Deprecated.

Throws:

HTTPException

setCredentialsProvider

@Deprecated
public void setCredentialsProvider(java.lang.String url,
                                               org.apache.http.client.CredentialsProvider provider)
                                        throws HTTPException

Deprecated.

Throws:

HTTPException

setCredentialsProvider

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

Deprecated.

Throws:

HTTPException

getRetryCount

@Deprecated
public static int getRetryCount()

Deprecated.

setGlobalCompression

@Deprecated
public static void setGlobalCompression()

Deprecated.

setGlobalProxy

@Deprecated
public static void setGlobalProxy(java.lang.String host,
                                              int port)

Deprecated.

setProxy

@Deprecated
public void setProxy(java.lang.String host,
                                 int port)

Deprecated.

setGlobalCredentialsProvider

@Deprecated
public static void setGlobalCredentialsProvider(org.apache.http.client.CredentialsProvider provider,
                                                            java.lang.String scheme)
                                                     throws HTTPException

Deprecated.

Throws:

HTTPException

setRetryCount

@Deprecated
public static void setRetryCount(int count)

Deprecated.

clearState

@Deprecated
public void clearState()

Deprecated.

getSessionURL

@Deprecated
public java.lang.String getSessionURL()

Deprecated.