Index: trunk/http-core/src/java/org/apache/http/message/package.html =================================================================== --- trunk/http-core/src/java/org/apache/http/message/package.html (revision 0) +++ trunk/http-core/src/java/org/apache/http/message/package.html (revision 0) @@ -0,0 +1,52 @@ + + + + + +A selection of HTTP +{@link org.apache.http.message.AbstractHttpMessage message} +implementations. + +There are basic implementations for HTTP requests +{@link org.apache.http.message.BasicHttpEntityEnclosingRequest with} +and {@link org.apache.http.message.BasicHttpRequest without} +an entity, and for +{@link org.apache.http.message.BasicHttpResponse responses}. +You will also find implementations for some of +the HTTP standard methods like +{@link org.apache.http.message.HttpGet GET}, +{@link org.apache.http.message.HttpHead HEAD}, and +{@link org.apache.http.message.HttpPost POST}. + + + + Property changes on: trunk/http-core/src/java/org/apache/http/message/package.html ___________________________________________________________________ Name: svn:mime-type + text/html Name: svn:keywords + Date Author Id Revision HeadURL Name: svn:eol-style + native Index: trunk/http-core/src/java/org/apache/http/impl/io/package.html =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/io/package.html (revision 0) +++ trunk/http-core/src/java/org/apache/http/impl/io/package.html (revision 0) @@ -0,0 +1,39 @@ + + + + + +Default implementations for interfaces in +{@link org.apache.http.io org.apache.http.io}. + + + Property changes on: trunk/http-core/src/java/org/apache/http/impl/io/package.html ___________________________________________________________________ Name: svn:mime-type + text/html Name: svn:keywords + Date Author Id Revision HeadURL Name: svn:eol-style + native Index: trunk/http-core/src/java/org/apache/http/impl/entity/package.html =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/entity/package.html (revision 0) +++ trunk/http-core/src/java/org/apache/http/impl/entity/package.html (revision 0) @@ -0,0 +1,39 @@ + + + + + +Default implementations for interfaces in +{@link org.apache.http.entity org.apache.http.entity}. + + + Property changes on: trunk/http-core/src/java/org/apache/http/impl/entity/package.html ___________________________________________________________________ Name: svn:mime-type + text/html Name: svn:keywords + Date Author Id Revision HeadURL Name: svn:eol-style + native Index: trunk/http-core/src/java/org/apache/http/impl/package.html =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/package.html (revision 0) +++ trunk/http-core/src/java/org/apache/http/impl/package.html (revision 0) @@ -0,0 +1,39 @@ + + + + + +Default implementations for interfaces in +{@link org.apache.http org.apache.http}. + + + Property changes on: trunk/http-core/src/java/org/apache/http/impl/package.html ___________________________________________________________________ Name: svn:mime-type + text/html Name: svn:keywords + Date Author Id Revision HeadURL Name: svn:eol-style + native Index: trunk/http-core/src/java/org/apache/http/protocol/package.html =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/package.html (revision 0) +++ trunk/http-core/src/java/org/apache/http/protocol/package.html (revision 0) @@ -0,0 +1,113 @@ + + + + + +HTTP protocol execution framework. + +Apart from simply sending and receiving messages, there are a lot +of things to consider when communicating with HTTP. Many details +such as transport encodings or connection management are handled +by setting up or interpreting +{@link org.apache.http.Header headers} in the messages. +In order to relieve applications from the responsibility of +implementing these nitty-gritty details of the protocol, +HTTP components provides an execution framework that sets up +some of the headers before sending a message, and interprets +headers when a message has been received. +
+An HTTP {@link org.apache.http.protocol.AbstractHttpProcessor processor} +keeps lists of so-called interceptors that will be executed +before a message is sent and after it has been received. +An application should initialize a processor, set up the lists +with the required and desired processors, and then communicate +through that processor. There are four kinds of interceptors, +depending on whether they act on +{@link org.apache.http.HttpRequestInterceptor requests} or +{@link org.apache.http.HttpResponseInterceptor responses}, +on the client or server side. The following table should +reduce your confusion: + + + + + + + + + + + + + + +
ClientServer
Requestprepares headers before a request is sentinterprets headers when a request is received
Responseinterprets headers when a response is receivedprepares headers before a response is sent
+ +

+{@link org.apache.http.protocol.HttpRequestExecutor HttpRequestExecutor} +is a processor for the client side, +{@link org.apache.http.protocol.HttpService HttpService} +for the server side. +On the client side, a {@link org.apache.http.protocol.HttpContext context} +is used to tie together a request, the response to it, and other data +that might be associated with the request execution. The request executor +is for use by a single thread only, so it has only +{@link org.apache.http.protocol.HttpRequestExecutor#getContext one} +context which will be used subsequently for all request executions. +

+ +

+ + +Information about required and recommended interceptors for the +client side will be provided elsewhere. For the time being, please +refer to the comments in the example applications or ask on +one of the mailing lists. + + +

+ +

+Note: +If you want to develop a server-side application, we recommend that +you implement your application as a servlet running in a servlet engine +like Tomcat or full-blown +JSEE container like Geronimo. +If you prefer to implement a server-side application based on our +{@link org.apache.http.protocol.HttpService HttpService}, we'll +assume that you know what you're doing and that you don't need +help in figuring out which interceptors need to be configured. +

+ + + + Property changes on: trunk/http-core/src/java/org/apache/http/protocol/package.html ___________________________________________________________________ Name: svn:mime-type + text/html Name: svn:keywords + Date Author Id Revision HeadURL Name: svn:eol-style + native Index: trunk/http-core/src/java/org/apache/http/params/package.html =================================================================== --- trunk/http-core/src/java/org/apache/http/params/package.html (revision 0) +++ trunk/http-core/src/java/org/apache/http/params/package.html (revision 0) @@ -0,0 +1,38 @@ + + + + + +The parameterization framework for HTTP components. + + + Property changes on: trunk/http-core/src/java/org/apache/http/params/package.html ___________________________________________________________________ Name: svn:mime-type + text/html Name: svn:keywords + Date Author Id Revision HeadURL Name: svn:eol-style + native Index: trunk/http-core/src/java/org/apache/http/package.html =================================================================== --- trunk/http-core/src/java/org/apache/http/package.html (revision 0) +++ trunk/http-core/src/java/org/apache/http/package.html (revision 0) @@ -0,0 +1,49 @@ + + + + + +The core interfaces and classes of the HTTP components. + +These deal with the fundamental things required for using the +HTTP protocol, such as representing a +{@link org.apache.http.HttpMessage message} including it's +{@link org.apache.http.Header headers} and optional +{@link org.apache.http.HttpEntity entity}, and +{@link org.apache.http.HttpConnection connections} +over which messages are sent. In order to prepare messages +before sending or after receiving, there are interceptors for +{@link org.apache.http.HttpRequestInterceptor requests} and +{@link org.apache.http.HttpResponseInterceptor responses}. + + + Property changes on: trunk/http-core/src/java/org/apache/http/package.html ___________________________________________________________________ Name: svn:mime-type + text/html Name: svn:keywords + Date Author Id Revision HeadURL Name: svn:eol-style + native Index: trunk/http-core/src/java/org/apache/http/io/package.html =================================================================== --- trunk/http-core/src/java/org/apache/http/io/package.html (revision 0) +++ trunk/http-core/src/java/org/apache/http/io/package.html (revision 0) @@ -0,0 +1,70 @@ + + + + + +The transport layer abstraction of the HTTP components. + +This layer is used to transfer messages over sockets. +Sockets are always created through a +{@link org.apache.http.io.SocketFactory factory}. +You can provide factories to create plain sockets, +{@link org.apache.http.io.SecureSocketFactory secure} sockets +based on SSL/TLS, sockets that connect over SOCKS hosts, +sockets that implement bandwidth throttling, +or whatever else you might think of. + +
+ +The data {@link org.apache.http.io.HttpDataTransmitter transmitter} +and {@link org.apache.http.io.HttpDataReceiver receiver} interfaces +with the respective factories provide an abstraction from +java.io and java.nio. +These interfaces are adapted to the plain +{@link org.apache.http.io.HttpDataOutputStream output} and +{@link org.apache.http.io.HttpDataInputStream input} streams +used in the {@link org.apache.http core API}. + +
+ +There are implementations of the transport encodings used by HTTP, +in particular the chunked encoding for +{@link org.apache.http.io.ChunkedOutputStream sending} and +{@link org.apache.http.io.ChunkedInputStream receiving} entities. +The helper classes for resizable +{@link org.apache.http.io.ByteArrayBuffer byte} and +{@link org.apache.http.io.CharArrayBuffer char} arrays +might be useful elsewhere, too. + + + + Property changes on: trunk/http-core/src/java/org/apache/http/io/package.html ___________________________________________________________________ Name: svn:mime-type + text/html Name: svn:keywords + Date Author Id Revision HeadURL Name: svn:eol-style + native Index: trunk/http-core/src/java/org/apache/http/entity/package.html =================================================================== --- trunk/http-core/src/java/org/apache/http/entity/package.html (revision 0) +++ trunk/http-core/src/java/org/apache/http/entity/package.html (revision 0) @@ -0,0 +1,56 @@ + + + + + +Representations for HTTP message entities. + +An {@link org.apache.http.HttpEntity entity} is the optional content of a +{@link org.apache.http.HttpMessage message}. +You'll find a basic selection of entity implementations here. +If you need to send an entity, you can provide it for example as a +{@link org.apache.http.entity.ByteArrayEntity byte array}, +{@link org.apache.http.entity.StringEntity string}, +{@link org.apache.http.entity.FileEntity file}, or through a. +{@link org.apache.http.entity.InputStreamEntity stream}. +If you receive a message with an entity, you typically get that as a +{@link org.apache.http.entity.BasicHttpEntity basic} entity. +Entity implementations can be +{@link org.apache.http.entity.HttpEntityWrapper wrapped}, +for example to +{@link org.apache.http.entity.BufferedHttpEntity buffer} +the content in memory. + + + + + Property changes on: trunk/http-core/src/java/org/apache/http/entity/package.html ___________________________________________________________________ Name: svn:mime-type + text/html Name: svn:keywords + Date Author Id Revision HeadURL Name: svn:eol-style + native Index: trunk/http-core/src/java/org/apache/http/util/package.html =================================================================== --- trunk/http-core/src/java/org/apache/http/util/package.html (revision 0) +++ trunk/http-core/src/java/org/apache/http/util/package.html (revision 0) @@ -0,0 +1,38 @@ + + + + + +Utility classes with static helper methods for various purposes. + + + Property changes on: trunk/http-core/src/java/org/apache/http/util/package.html ___________________________________________________________________ Name: svn:mime-type + text/html Name: svn:keywords + Date Author Id Revision HeadURL Name: svn:eol-style + native