ucar.nc2.util.net

Class HTTPSession

java.lang.Object

ucar.nc2.util.net.HTTPSession

@NotThreadSafe
public class HTTPSession
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOW_CIRCULAR_REDIRECTS
static HTTPAuthScheme	BASIC
static String	CONNECTION_TIMEOUT
static HTTPAuthScheme	DIGEST
static String	HTTP_CONNECTION
static String	HTTP_CONTENT_CHARSET
static String	HTTP_ELEMENT_CHARSET
static String	HTTP_PROXY_HOST
static String	HTTP_REQ_SENT
static String	HTTP_REQUEST
static String	HTTP_RESPONSE
static String	HTTP_TARGET_HOST
static org.slf4j.Logger	log
static String	MAX_REDIRECTS
static HTTPAuthScheme	NTLM
static String	ORIGIN_SERVER
static String	PROTOCOL_VERSION
static int	SC_NOT_FOUND
static int	SC_OK
static int	SC_UNAUTHORIZED
static String	SO_TIMEOUT
static HTTPAuthScheme	SSL
static String	STRICT_TRANSFER_ENCODING
static String	USE_EXPECT_CONTINUE
static String	USER_AGENT
static String	VIRTUAL_HOST
static String	WAIT_FOR_CONTINUE

Constructor Summary

Constructors

Constructor and Description
HTTPSession()
HTTPSession(String legalurl) A session is encapsulated in an instance of the class HTTPSession.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addMethod(HTTPMethod m)
static String	canonicalpath(String path) Convert path to use '/' consistently and to remove any trailing '/'
void	clearState()
void	close()
protected void	construct(String legalurl)
static String	getCanonicalURL(String legalurl)
org.apache.commons.httpclient.HttpState	getContext()
String	getCookiePolicy()
org.apache.commons.httpclient.Cookie[]	getCookies()
static org.apache.commons.httpclient.Cookie[]	getGlobalCookies()
static int	getGlobalThreadCount()
static String	getGlobalUserAgent()
static org.apache.commons.httpclient.protocol.Protocol	getProtocol(String protocol, int port)
String	getURL()
static String	getUrlAsString(String url)
static int	putUrlAsString(String content, String url)
static void	registerProtocol(String protocol, int port, org.apache.commons.httpclient.protocol.Protocol handler)
protected void	removeMethod(HTTPMethod m)
static String	removeprincipal(String u)
static void	setAnyCredentialsProvider(HTTPAuthScheme scheme, String url, org.apache.commons.httpclient.auth.CredentialsProvider provider)
void	setAuthenticationPreemptive(boolean tf)
static void	setConnectionManagerTimeout(int timeout)
void	setConnectionTimeout(int timeout)
void	setContext(org.apache.commons.httpclient.HttpState cxt)
void	setCredentials(HTTPAuthScheme scheme, org.apache.commons.httpclient.Credentials creds)
void	setCredentialsProvider(org.apache.commons.httpclient.auth.CredentialsProvider provider)
void	setCredentialsProvider(HTTPAuthScheme scheme, org.apache.commons.httpclient.auth.CredentialsProvider provider)
void	setCredentialsProvider(String url)
static void	setGlobalAuthenticationPreemptive(boolean tf)
static void	setGlobalConnectionTimeout(int timeout)
static void	setGlobalCredentials(HTTPAuthScheme scheme, org.apache.commons.httpclient.Credentials creds)
static void	setGlobalCredentialsProvider(org.apache.commons.httpclient.auth.CredentialsProvider provider)
static void	setGlobalCredentialsProvider(HTTPAuthScheme scheme, org.apache.commons.httpclient.auth.CredentialsProvider provider)
static void	setGlobalCredentialsProvider(String url)
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)
void	setSoTimeout(int timeout)
void	setUserAgent(String agent)

Methods inherited from class java.lang.Object

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

Field Detail

BASIC

public static final HTTPAuthScheme BASIC

DIGEST

public static final HTTPAuthScheme DIGEST

NTLM

public static final HTTPAuthScheme NTLM

SSL

public static final HTTPAuthScheme SSL

SC_NOT_FOUND

public static int SC_NOT_FOUND

SC_UNAUTHORIZED

public static int SC_UNAUTHORIZED

SC_OK

public static int SC_OK

CONNECTION_TIMEOUT

public static String CONNECTION_TIMEOUT

SO_TIMEOUT

public static String SO_TIMEOUT

ALLOW_CIRCULAR_REDIRECTS

public static String ALLOW_CIRCULAR_REDIRECTS

MAX_REDIRECTS

public static String MAX_REDIRECTS

USER_AGENT

public static String USER_AGENT

PROTOCOL_VERSION

public static String PROTOCOL_VERSION

VIRTUAL_HOST

public static String VIRTUAL_HOST

USE_EXPECT_CONTINUE

public static String USE_EXPECT_CONTINUE

STRICT_TRANSFER_ENCODING

public static String STRICT_TRANSFER_ENCODING

HTTP_ELEMENT_CHARSET

public static String HTTP_ELEMENT_CHARSET

HTTP_CONTENT_CHARSET

public static String HTTP_CONTENT_CHARSET

HTTP_CONNECTION

public static String HTTP_CONNECTION

HTTP_PROXY_HOST

public static String HTTP_PROXY_HOST

HTTP_REQ_SENT

public static String HTTP_REQ_SENT

HTTP_REQUEST

public static String HTTP_REQUEST

HTTP_RESPONSE

public static String HTTP_RESPONSE

HTTP_TARGET_HOST

public static String HTTP_TARGET_HOST

ORIGIN_SERVER

public static String ORIGIN_SERVER

WAIT_FOR_CONTINUE

public static String WAIT_FOR_CONTINUE

log

public static org.slf4j.Logger log

Constructor Detail

HTTPSession

public HTTPSession(String legalurl)
            throws HTTPException

A session is encapsulated in an instance of the class HTTPSession. The encapsulation is with respect to a specific url and (optionally) principal. This means that once a session is specified, it is tied permanently to that url and principal. Note that the term "principal" is another name for user id. If no principal is ever set, the the session assumes a special principal called ANY_PRINCIPAL. Currently principals are ignored, but will become important when new authorization mechanisms are put in place. Also, per-instance setting of principals is disabled because the Apache httpclient-3 library cannot utilize them. They will be activated when the httpclient-4 library replaces the httpclient-3 library. It is important to note that Session objects do NOT correspond with the HttpClient objects of the Apache httpclient library. A Session encapulates an instance of an Apache HttpClient, but Sessions also wrap and control httpclient library methods such as GetMethod via the class HTTPMethod. This is so it can ensure that the Session - url correspondence is not violated. It is possible to specify a url when invoking, for example, HTTPMethod.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 = HTTPMethod.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 HTTPMethod.Get was for something more specific such as http://motherlode.ucar.edu/path/file.nc.dds. The important point is that this second, method, 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 HTTPMethod.Get. This maintains the semantics of the Session but allows flexibility in accessing data from the server. Note that if the session was created with no url then all method constructions must specify a url. Note: 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.

Throws:

HTTPException

HTTPSession

public HTTPSession()
            throws HTTPException

Throws:

HTTPException

Method Detail

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 org.apache.commons.httpclient.Cookie[] getGlobalCookies()

registerProtocol

public static void registerProtocol(String protocol,
                    int port,
                    org.apache.commons.httpclient.protocol.Protocol handler)
                             throws IllegalArgumentException

Throws:

IllegalArgumentException

getProtocol

public static org.apache.commons.httpclient.protocol.Protocol getProtocol(String protocol,
                                                          int port)
                                                                   throws IllegalArgumentException,
                                                                          IllegalStateException

Throws:

IllegalArgumentException

IllegalStateException

construct

protected void construct(String legalurl)
                  throws HTTPException

Throws:

HTTPException

getURL

public String getURL()

setUserAgent

public void setUserAgent(String agent)

setAuthenticationPreemptive

public void setAuthenticationPreemptive(boolean tf)

setSoTimeout

public void setSoTimeout(int timeout)

setConnectionTimeout

public void setConnectionTimeout(int timeout)

close

public void close()

getCookiePolicy

public String getCookiePolicy()

getCookies

public org.apache.commons.httpclient.Cookie[] getCookies()

addMethod

protected void addMethod(HTTPMethod m)

removeMethod

protected void removeMethod(HTTPMethod m)

setMaxRedirects

public void setMaxRedirects(int n)

setContext

public void setContext(org.apache.commons.httpclient.HttpState cxt)

getContext

public org.apache.commons.httpclient.HttpState getContext()

clearState

public void clearState()

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

setConnectionManagerTimeout

public static void setConnectionManagerTimeout(int timeout)

setGlobalConnectionTimeout

public static void setGlobalConnectionTimeout(int timeout)

setGlobalSoTimeout

public static void setGlobalSoTimeout(int timeout)

setGlobalProxy

public static void setGlobalProxy(String host,
                  int port)

setProxy

public void setProxy(String host,
            int port)

setGlobalAuthenticationPreemptive

public static void setGlobalAuthenticationPreemptive(boolean tf)

setAnyCredentialsProvider

public static void setAnyCredentialsProvider(HTTPAuthScheme scheme,
                             String url,
                             org.apache.commons.httpclient.auth.CredentialsProvider provider)

setGlobalCredentialsProvider

public static void setGlobalCredentialsProvider(HTTPAuthScheme scheme,
                                org.apache.commons.httpclient.auth.CredentialsProvider provider)

setGlobalCredentialsProvider

public static void setGlobalCredentialsProvider(org.apache.commons.httpclient.auth.CredentialsProvider provider)

setGlobalCredentialsProvider

public static void setGlobalCredentialsProvider(String url)

setCredentialsProvider

public void setCredentialsProvider(HTTPAuthScheme scheme,
                          org.apache.commons.httpclient.auth.CredentialsProvider provider)

setCredentialsProvider

public void setCredentialsProvider(org.apache.commons.httpclient.auth.CredentialsProvider provider)

setCredentialsProvider

public void setCredentialsProvider(String url)

setGlobalCredentials

public static void setGlobalCredentials(HTTPAuthScheme scheme,
                        org.apache.commons.httpclient.Credentials creds)

setCredentials

public void setCredentials(HTTPAuthScheme scheme,
                  org.apache.commons.httpclient.Credentials creds)