ucar.nc2.util.net

Class HTTPMethod

java.lang.Object

ucar.nc2.util.net.HTTPMethod

@NotThreadSafe
public class HTTPMethod
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTTPMethod.RetryHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed

Constructor Summary

Constructors

Constructor and Description
HTTPMethod(ucar.nc2.util.net.HTTPSession.Methods m, HTTPSession session, String url) It is possible to specify a url when invoking, for example, HTTPMethod.Get.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHoldContent()
void	close()
void	consumeContent()
int	execute()
static HTTPMethod	Get(HTTPSession session)
static HTTPMethod	Get(HTTPSession session, String legalurl)
static Enumeration	getAllowedMethods()
String	getCharSet()
org.apache.commons.httpclient.HttpState	getContext()
String	getEffectiveVersion()
org.apache.commons.httpclient.HttpMethodBase	getMethod()
Object	getMethodParameter(String key)
org.apache.commons.httpclient.params.HttpMethodParams	getMethodParameters()
String	getName()
String	getPath()
String	getProtocolVersion()
org.apache.commons.httpclient.Header	getRequestHeader(String name)
org.apache.commons.httpclient.Header[]	getRequestHeaders()
String	getRequestLine()
byte[]	getResponseAsBytes()
byte[]	getResponseAsBytes(int maxsize)
InputStream	getResponseAsStream()
String	getResponseAsString()
String	getResponseAsString(String charset)
InputStream	getResponseBodyAsStream()
String	getResponseCharSet()
org.apache.commons.httpclient.Header[]	getResponseFooters()
org.apache.commons.httpclient.Header	getResponseHeader(String name)
org.apache.commons.httpclient.Header	getResponseHeaderdmh(String name)
org.apache.commons.httpclient.Header[]	getResponseHeaders()
Object	getResponseParameter(String name)
HTTPSession	getSession()
String	getSoTimeout()
int	getStatusCode()
String	getStatusLine()
String	getStatusText()
String	getURL()
String	getVirtualHost()
static HTTPMethod	Head(HTTPSession session)
static HTTPMethod	Head(HTTPSession session, String legalurl)
static HTTPMethod	Options(HTTPSession session)
static HTTPMethod	Options(HTTPSession session, String legalurl)
static HTTPMethod	Post(HTTPSession session)
static HTTPMethod	Post(HTTPSession session, String legalurl)
static HTTPMethod	Put(HTTPSession session)
static HTTPMethod	Put(HTTPSession session, String legalurl)
void	setContext(org.apache.commons.httpclient.HttpState cxt)
void	setFollowRedirects(boolean tf)
static void	setGlobalParameter(String name, Object value)
void	setMethodHeaders(List<org.apache.commons.httpclient.Header> headers)
void	setMultipartRequest(org.apache.commons.httpclient.methods.multipart.Part[] parts)
void	setRequestContentAsString(String content)
void	setRequestHeader(org.apache.commons.httpclient.Header h)
void	setRequestHeader(String name, String value)
void	setRequestParameter(String name, Object value)

Methods inherited from class java.lang.Object

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

Field Detail

closed

protected boolean closed

Constructor Detail

HTTPMethod

public HTTPMethod(ucar.nc2.util.net.HTTPSession.Methods m,
          HTTPSession session,
          String url)
           throws HTTPException

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.

Throws:

HTTPException

Method Detail

Get

public static HTTPMethod Get(HTTPSession session)
                      throws HTTPException

Throws:

HTTPException

Head

public static HTTPMethod Head(HTTPSession session)
                       throws HTTPException

Throws:

HTTPException

Put

public static HTTPMethod Put(HTTPSession session)
                      throws HTTPException

Throws:

HTTPException

Post

public static HTTPMethod Post(HTTPSession session)
                       throws HTTPException

Throws:

HTTPException

Options

public static HTTPMethod Options(HTTPSession session)
                          throws HTTPException

Throws:

HTTPException

Get

public static HTTPMethod Get(HTTPSession session,
             String legalurl)
                      throws HTTPException

Throws:

HTTPException

Head

public static HTTPMethod Head(HTTPSession session,
              String legalurl)
                       throws HTTPException

Throws:

HTTPException

Put

public static HTTPMethod Put(HTTPSession session,
             String legalurl)
                      throws HTTPException

Throws:

HTTPException

Post

public static HTTPMethod Post(HTTPSession session,
              String legalurl)
                       throws HTTPException

Throws:

HTTPException

Options

public static HTTPMethod Options(HTTPSession session,
                 String legalurl)
                          throws HTTPException

Throws:

HTTPException

setGlobalParameter

public static void setGlobalParameter(String name,
                      Object value)

execute

public int execute()
            throws HTTPException

Throws:

HTTPException

close

public void close()

consumeContent

public void consumeContent()

setContext

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

getContext

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

getStatusCode

public int getStatusCode()

getStatusLine

public String getStatusLine()

getRequestLine

public String getRequestLine()

getPath

public String getPath()

canHoldContent

public boolean canHoldContent()

getResponseBodyAsStream

public InputStream getResponseBodyAsStream()

getResponseAsStream

public InputStream getResponseAsStream()

getResponseAsBytes

public byte[] getResponseAsBytes(int maxsize)

getResponseAsBytes

public byte[] getResponseAsBytes()

getResponseAsString

public String getResponseAsString(String charset)

getResponseAsString

public String getResponseAsString()

setMethodHeaders

public void setMethodHeaders(List<org.apache.commons.httpclient.Header> headers)
                      throws HTTPException

Throws:

HTTPException

setRequestHeader

public void setRequestHeader(String name,
                    String value)
                      throws HTTPException

Throws:

HTTPException

setRequestHeader

public void setRequestHeader(org.apache.commons.httpclient.Header h)
                      throws HTTPException

Throws:

HTTPException

getRequestHeader

public org.apache.commons.httpclient.Header getRequestHeader(String name)

getRequestHeaders

public org.apache.commons.httpclient.Header[] getRequestHeaders()

getResponseHeader

public org.apache.commons.httpclient.Header getResponseHeader(String name)

getResponseHeaderdmh

public org.apache.commons.httpclient.Header getResponseHeaderdmh(String name)

getResponseHeaders

public org.apache.commons.httpclient.Header[] getResponseHeaders()

getResponseFooters

public org.apache.commons.httpclient.Header[] getResponseFooters()

setRequestParameter

public void setRequestParameter(String name,
                       Object value)

getMethodParameter

public Object getMethodParameter(String key)

getMethodParameters

public org.apache.commons.httpclient.params.HttpMethodParams getMethodParameters()

getResponseParameter

public Object getResponseParameter(String name)

setRequestContentAsString

public void setRequestContentAsString(String content)
                               throws HTTPException

Throws:

HTTPException

setMultipartRequest

public void setMultipartRequest(org.apache.commons.httpclient.methods.multipart.Part[] parts)
                         throws HTTPException

Throws:

HTTPException

getCharSet

public String getCharSet()

getName

public String getName()

getURL

public String getURL()

getEffectiveVersion

public String getEffectiveVersion()

getProtocolVersion

public String getProtocolVersion()

getSoTimeout

public String getSoTimeout()

getVirtualHost

public String getVirtualHost()

getStatusText

public String getStatusText()

getAllowedMethods

public static Enumeration getAllowedMethods()

setFollowRedirects

public void setFollowRedirects(boolean tf)

getResponseCharSet

public String getResponseCharSet()

getSession

public HTTPSession getSession()

getMethod

public org.apache.commons.httpclient.HttpMethodBase getMethod()