1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>HttpClient - Overview</title><style type="text/css" media="all">
@import url("./style/maven-base.css");
@import url("./style/maven-theme.css");@import url("./style/project.css");</style><link rel="stylesheet" href="./style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta><meta name="author" content="HttpComponents Team"></meta><meta name="email" content="httpcomponents-dev@jakarta.apache.org"></meta><meta name="author" content="Rodney Waldhoff"></meta><meta name="email" content="rwaldhoff@apache.org"></meta><meta name="author" content="Jeff Dever"></meta><meta name="email" content="jsdever@apache.org"></meta></head><body class="composite"><div id="banner"><a href="http://jakarta.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="http://jakarta.apache.org/images/jakarta-logo.gif"></img></a><a href="http://jakarta.apache.org/httpcomponents/httpclient-3.x/" id="projectLogo"><img alt="HttpClient" src="./images/httpclient_logo.png"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">Last published: 18 August 2007
<span class="separator">|</span>Doc for 3.1
</div><div class="xright"></div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuOverview"><h5>Overview</h5><ul><li class="none"><a href="features.html">Features</a></li><li class="none"><a href="news.html">News</a></li><li class="none"><a href="status.html">Status</a></li><li class="none"><a href="downloads.html">Download</a></li><li class="none"><a href="http://wiki.apache.org/jakarta-httpclient/" class="externalLink" title="External Link">Wiki</a></li><li class="expanded"><a href="userguide.html">User Guide</a><ul><li class="none"><a href="authentication.html">Authentication Guide</a></li><li class="none"><a href="charencodings.html">Character Encodings</a></li><li class="none"><a href="cookies.html">Cookies</a></li><li class="none"><a href="exception-handling.html">Exception Handling</a></li><li class="none"><a href="logging.html">Logging Guide</a></li><li class="none"><a href="methods.html">Methods</a></li><li class="none"><a href="performance.html">Optimization Guide</a></li><li class="none"><a href="preference-api.html">Preference Architecture</a></li><li class="none"><a href="redirects.html">Redirects Handling</a></li><li class="none"><a href="http://svn.apache.org/viewvc/jakarta/httpcomponents/oac.hc3x/trunk/src/examples/" class="externalLink" title="External Link">Sample Code</a></li><li class="none"><a href="sslguide.html">SSL Guide</a></li><li class="none"><a href="threading.html">Threading</a></li><li class="none"><a href="troubleshooting.html">Trouble Shooting</a></li><li class="none"><a href="tutorial.html">Tutorial</a></li></ul></li><li class="none"><a href="developerguide.html">Developer Guide</a></li></ul></div><div id="menuProject_Documentation"><h5>Project Documentation</h5><ul><li class="none"><a href="index.html">About</a></li><li class="collapsed"><a href="project-info.html">Project Info</a></li><li class="collapsed"><a href="maven-reports.html">Project Reports</a></li><li class="none"><a href="development-process.html">Development Process</a></li></ul></div><div id="legend"><h5>Legend</h5><ul><li class="externalLink">External Link</li><li class="newWindow">Opens in a new window</li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="./images/logos/mavenlogo_builtby_w.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="Scope"></a><h2>Scope</h2>
<p>
The <em>HttpClient</em> component supports the client-side of
<a href="http://www.w3.org/Protocols/rfc1945/rfc1945.txt" class="externalLink" title="External Link">RFC 1945 (HTTP/1.0)</a> and
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616.txt" class="externalLink" title="External Link">RFC 2616 (HTTP/1.1)</a>,
several related specifications
(<a href="http://www.w3.org/Protocols/rfc2109/rfc2109.txt" class="externalLink" title="External Link">RFC 2109 (Cookies)</a>,
<a href="http://www.ietf.org/rfc/rfc2617.txt" class="externalLink" title="External Link">RFC 2617 (HTTP Authentication)</a>,
etc.), and provides a framework by which new request types (methods) or HTTP
extensions can be created easily.
</p>
</div><div class="section"><a name="The_org_apache_commons_httpclient_Package"></a><h2>The org.apache.commons.httpclient Package</h2>
<p>
The basis for the abstraction is provided by three primary
types:
</p>
<ul><dl>
<dt><a href="./api/org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a></dt>
<dd>
represents a network connection to some HTTP host.
</dd>
<dt><a href="./api/org/apache/commons/httpclient/HttpMethod.html">HttpMethod</a></dt>
<dd>
represents a request to be made over some
<tt>HttpConnection</tt> and contains the server's response.
</dd>
<dt><a href="./api/org/apache/commons/httpclient/HttpState.html">HttpState</a></dt>
<dd>
contains the HTTP attributes that may persist from
request to request, such as cookies and authentication
credentials.
</dd>
</dl></ul>
<p>
and several simple bean-style classes:
</p>
<ul><dl>
<dt><a href="./api/org/apache/commons/httpclient/Cookie.html">Cookie</a></dt>
<dd>
represents HTTP cookie.
</dd>
<dt><a href="./api/org/apache/commons/httpclient/Credentials.html">Credentials</a></dt>
<dd>
an interface representing a set of authentication credentials.
</dd>
<dt><a href="./api/org/apache/commons/httpclient/Header.html">Header</a></dt>
<dd>
represents an HTTP request or response header.
</dd>
<dt><a href="./api/org/apache/commons/httpclient/HeaderElement.html">HeaderElement</a></dt>
<dd>
represents a single element of a multi-part header.
</dd>
<dt><a href="./api/org/apache/commons/httpclient/UsernamePasswordCredentials.html">UsernamePasswordCredentials</a></dt>
<dd>
a username and password pair.
</dd>
</dl></ul>
<p>
<a href="./api/org/apache/commons/httpclient/HttpClient.html">HttpClient</a>
provides a simple "user-agent" implementation that will suffice for many
applications, but whose use is not required.
</p>
<p>
<em>HttpClient</em> also provides several utilities that may be
useful when extending the framework:
</p>
<ul><dl>
<dt><a href="./api/org/apache/commons/httpclient/HttpMethodBase.html">HttpMethodBase</a></dt>
<dd>
an abstract base implementation of <tt>HttpMethod</tt>,
which may be extended to create new method types or
to support additional HTTP protocol features.
</dd>
<dt><a href="./api/org/apache/commons/httpclient/HttpStatus.html">HttpStatus</a></dt>
<dd>
an enumeration of HttpStatus codes.
</dd>
<dt><a href="./api/org/apache/commons/httpclient/RequestOutputStream.html">RequestOutputStream</a></dt>
<dd>
an <tt>OutputStream</tt> wrapper supporting the "chunked"
transfer encoding.
</dd>
<dt><a href="./api/org/apache/commons/httpclient/ResponseInputStream.html">ResponseInputStream</a></dt>
<dd>
an <tt>InputStream</tt> wrapper supporting the "chunked"
transfer encoding.
</dd>
<dt><a href="./api/org/apache/commons/httpclient/URIUtil.html">URIUtil</a></dt>
<dd>
provides utilities for encoding and decoding URI's in the
<tt>%HH</tt> format.
</dd>
</dl></ul>
</div><div class="section"><a name="The_org_apache_commons_httpclient_methods_Package"></a><h2>The org.apache.commons.httpclient.methods Package</h2>
<p>
The
<a href="./api/org/apache/commons/httpclient/methods/package-summary.html">org.apache.commons.httpclient.methods</a>
package provides <tt>HttpMethod</tt> implementations of the most
commonly used HTTP methods, including
<a href="./api/org/apache/commons/httpclient/methods/GetMethod.html">GET</a>,
<a href="./api/org/apache/commons/httpclient/methods/PostMethod.html">POST</a>,
<a href="./api/org/apache/commons/httpclient/methods/PutMethod.html">PUT</a>,
<a href="./api/org/apache/commons/httpclient/methods/OptionsMethod.html">OPTIONS</a>,
<a href="./api/org/apache/commons/httpclient/methods/HeadMethod.html">HEAD</a>
and
<a href="./api/org/apache/commons/httpclient/methods/DeleteMethod.html">DELETE</a>.
</p>
</div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright"> 2001-2007, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
|
