You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ol...@apache.org on 2006/04/02 22:32:24 UTC
svn commit: r390896 - in
/jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http: ./
entity/ impl/ impl/entity/ impl/io/ io/ message/ params/ protocol/ util/
Author: olegk
Date: Sun Apr 2 13:32:22 2006
New Revision: 390896
URL: http://svn.apache.org/viewcvs?rev=390896&view=rev
Log:
Package descriptions
Contributed by Roland Weber
Added:
jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/entity/package.html (with props)
jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/entity/package.html (with props)
jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/io/package.html (with props)
jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/package.html (with props)
jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/io/package.html (with props)
jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/message/package.html (with props)
jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/package.html (with props)
jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/params/package.html (with props)
jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/package.html (with props)
jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/util/package.html (with props)
Modified:
jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/HttpService.java
Added: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/entity/package.html
URL: http://svn.apache.org/viewcvs/jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/entity/package.html?rev=390896&view=auto
==============================================================================
--- jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/entity/package.html (added)
+++ jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/entity/package.html Sun Apr 2 13:32:22 2006
@@ -0,0 +1,56 @@
+<html>
+<head>
+<!--
+/*
+ * $HeadURL$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ * Copyright 2006 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+-->
+</head>
+<body>
+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 an arbitrary
+{@link org.apache.http.entity.InputStreamEntity input 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.
+
+
+
+</body>
+</html>
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/entity/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/entity/package.html
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/entity/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/entity/package.html
URL: http://svn.apache.org/viewcvs/jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/entity/package.html?rev=390896&view=auto
==============================================================================
--- jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/entity/package.html (added)
+++ jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/entity/package.html Sun Apr 2 13:32:22 2006
@@ -0,0 +1,39 @@
+<html>
+<head>
+<!--
+/*
+ * $HeadURL$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ * Copyright 2006 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+-->
+</head>
+<body>
+Default implementations for interfaces in
+{@link org.apache.http.entity org.apache.http.entity}.
+
+</body>
+</html>
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/entity/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/entity/package.html
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/entity/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/io/package.html
URL: http://svn.apache.org/viewcvs/jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/io/package.html?rev=390896&view=auto
==============================================================================
--- jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/io/package.html (added)
+++ jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/io/package.html Sun Apr 2 13:32:22 2006
@@ -0,0 +1,39 @@
+<html>
+<head>
+<!--
+/*
+ * $HeadURL$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ * Copyright 2006 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+-->
+</head>
+<body>
+Default implementations for interfaces in
+{@link org.apache.http.io org.apache.http.io}.
+
+</body>
+</html>
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/io/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/io/package.html
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/io/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/package.html
URL: http://svn.apache.org/viewcvs/jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/package.html?rev=390896&view=auto
==============================================================================
--- jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/package.html (added)
+++ jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/package.html Sun Apr 2 13:32:22 2006
@@ -0,0 +1,39 @@
+<html>
+<head>
+<!--
+/*
+ * $HeadURL$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ * Copyright 2006 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+-->
+</head>
+<body>
+Default implementations for interfaces in
+{@link org.apache.http org.apache.http}.
+
+</body>
+</html>
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/package.html
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/impl/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/io/package.html
URL: http://svn.apache.org/viewcvs/jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/io/package.html?rev=390896&view=auto
==============================================================================
--- jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/io/package.html (added)
+++ jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/io/package.html Sun Apr 2 13:32:22 2006
@@ -0,0 +1,70 @@
+<html>
+<head>
+<!--
+/*
+ * $HeadURL$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ * Copyright 2006 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+-->
+</head>
+<body>
+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.
+
+<br/>
+
+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
+<code>java.io</code> and <code>java.nio</code>.
+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}.
+
+<br/>
+
+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.
+
+
+</body>
+</html>
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/io/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/io/package.html
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/io/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/message/package.html
URL: http://svn.apache.org/viewcvs/jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/message/package.html?rev=390896&view=auto
==============================================================================
--- jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/message/package.html (added)
+++ jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/message/package.html Sun Apr 2 13:32:22 2006
@@ -0,0 +1,52 @@
+<html>
+<head>
+<!--
+/*
+ * $HeadURL$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ * Copyright 2006 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+-->
+</head>
+<body>
+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}.
+
+
+</body>
+</html>
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/message/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/message/package.html
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/message/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/package.html
URL: http://svn.apache.org/viewcvs/jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/package.html?rev=390896&view=auto
==============================================================================
--- jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/package.html (added)
+++ jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/package.html Sun Apr 2 13:32:22 2006
@@ -0,0 +1,49 @@
+<html>
+<head>
+<!--
+/*
+ * $HeadURL$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ * Copyright 2006 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+-->
+</head>
+<body>
+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}.
+
+</body>
+</html>
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/package.html
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/params/package.html
URL: http://svn.apache.org/viewcvs/jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/params/package.html?rev=390896&view=auto
==============================================================================
--- jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/params/package.html (added)
+++ jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/params/package.html Sun Apr 2 13:32:22 2006
@@ -0,0 +1,38 @@
+<html>
+<head>
+<!--
+/*
+ * $HeadURL$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ * Copyright 2006 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+-->
+</head>
+<body>
+The parameterization framework for HTTP components.
+
+</body>
+</html>
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/params/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/params/package.html
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/params/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Modified: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/HttpService.java
URL: http://svn.apache.org/viewcvs/jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/HttpService.java?rev=390896&r1=390895&r2=390896&view=diff
==============================================================================
--- jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/HttpService.java (original)
+++ jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/HttpService.java Sun Apr 2 13:32:22 2006
@@ -50,11 +50,6 @@
/**
* Minimalistic server-side implementation of an HTTP processor.
- * We have no intention of competing with the Servlet API.
- * This implementation will remain minimalistic. It is here as
- * a proof-of-concept for our API. It can also be used for
- * implementing simple server-side applications or tests that
- * can be run without installing a servlet container first.
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
Added: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/package.html
URL: http://svn.apache.org/viewcvs/jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/package.html?rev=390896&view=auto
==============================================================================
--- jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/package.html (added)
+++ jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/package.html Sun Apr 2 13:32:22 2006
@@ -0,0 +1,112 @@
+<html>
+<head>
+<!--
+/*
+ * $HeadURL$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ * Copyright 2006 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+-->
+</head>
+<body>
+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.
+<br/>
+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:
+
+<table border="1" cellpadding="5">
+<tr><th></th>
+ <th>Client</th>
+ <th>Server</th>
+</tr>
+<tr><th>Request</th>
+ <td>prepares headers before a request is sent</td>
+ <td>interprets headers when a request is received</td>
+</tr>
+<tr><th>Response</th>
+ <td>interprets headers when a response is received</td>
+ <td>prepares headers before a response is sent</td>
+</tr>
+</table>
+
+<p>
+{@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.
+</p>
+
+<p>
+<font size="+1">
+<i>
+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.
+</i>
+</font>
+</p>
+
+<p>
+<b>Note:</b>
+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 <a href="http://tomcat.apache.org/">Tomcat</a> or full-blown
+JSEE container like <a href="http://geronimo.apache.org/">Geronimo</a>.
+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.
+</p>
+
+
+</body>
+</html>
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/package.html
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/protocol/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/util/package.html
URL: http://svn.apache.org/viewcvs/jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/util/package.html?rev=390896&view=auto
==============================================================================
--- jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/util/package.html (added)
+++ jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/util/package.html Sun Apr 2 13:32:22 2006
@@ -0,0 +1,38 @@
+<html>
+<head>
+<!--
+/*
+ * $HeadURL$
+ * $Revision$
+ * $Date$
+ *
+ * ====================================================================
+ *
+ * Copyright 2006 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+-->
+</head>
+<body>
+Utility classes with static helper methods for various purposes.
+
+</body>
+</html>
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/util/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/util/package.html
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/httpcomponents/trunk/http-core/src/java/org/apache/http/util/package.html
------------------------------------------------------------------------------
svn:mime-type = text/html