Added project site content

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpasyncclient/trunk@1057363 13f79535-47bb-0310-9956-ffa450edef68
apache · Jan 10, 2011 · f854502 · f854502
1 parent 78c3aa0
commit f854502
Show file tree

Hide file tree

Showing 9 changed files with 407 additions and 0 deletions.
diff --git a/httpasyncclient/src/site/apt/index.apt b/httpasyncclient/src/site/apt/index.apt
@@ -0,0 +1,45 @@
+~~ ====================================================================
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements.  See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership.  The ASF licenses this file
+~~ to you 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/>.
+
+    ----------
+    HttpComponents HttpClient Module
+    ----------
+    ----------
+    ----------
+
+HttpAsyncClient
+
+    This module is a full-featured,
+    {{{http://www.ietf.org/rfc/rfc2616.txt}RFC 2616}} compliant
+    asynchronous HTTP client built on top of
+    {{{./httpcomponents/httpcomponents-core-ga/index.html}HttpCore NIO}} and
+    {{{./httpcomponents/httpcomponents-client-ga/index.html}HttpClient}}
+
+    {{{./apidocs/index.html}Javadocs}}
+
+    {{{./xref/index.html}Project sources}}
+
+    {{{./dependencies.html}Dependencies}}
+
+    {{{./issue-tracking.html}Issue Tracking}}
diff --git a/httpasyncclient/src/site/resources/css/site.css b/httpasyncclient/src/site/resources/css/site.css
@@ -0,0 +1 @@
+@import url("http://hc.apache.org/css/hc-maven.css");
diff --git a/httpasyncclient/src/site/site.xml b/httpasyncclient/src/site/site.xml
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+   ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you 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/>.
+ -->
+
+<project name="HttpAsyncClient">
+  <bannerLeft>
+    <name>Apache</name>
+    <src>http://www.apache.org/images/asf_logo_wide.gif</src>
+    <href>http://www.apache.org/</href>
+  </bannerLeft>
+
+  <bannerRight>
+    <name>HttpComponents</name>
+    <src>http://hc.apache.org/images/logos/httpcomponents.png</src>
+    <href>http://hc.apache.org/</href>
+  </bannerRight>
+
+  <body>
+    <menu name="HttpComponents">
+      <item name="Home" href="../.."/>
+    </menu>
+    <menu name="HttpAsyncClient Overview">
+      <item name="Description" href="../index.html"/>
+      <item name="Download" href="../download.html"/>
+      <item name="Examples" href="../examples.html"/>
+    </menu>
+    <menu ref="modules" />
+    <menu ref="reports"/>
+  </body>
+</project>
diff --git a/src/site/apt/download.apt b/src/site/apt/download.apt
@@ -0,0 +1,54 @@
+~~ ====================================================================
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements.  See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership.  The ASF licenses this file
+~~ to you 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/>.
+
+    ----------
+    HttpComponents HttpAsyncClient Download Page
+    ----------
+    ----------
+    ----------
+
+HttpClient Downloads
+
+    The latest release available for download:
+
+    {{{http://hc.apache.org/downloads.cgi}Release packages}} - 
+    {{{http://www.apache.org/dist/httpcomponents/httpasyncclient/RELEASE_NOTES.txt}Release Notes}} -
+    {{{http://www.apache.org/licenses/LICENSE-2.0.html}License}}
+
+{Dependency management with Maven}
+
+    If you are using {{{http://maven.apache.org}Maven}} for your project, you can create a dependency 
+    in your {{{http://maven.apache.org/guides/introduction/introduction-to-the-pom.html}pom.xml}} 
+    by adding the following block to the dependency descriptor:
+
+* {HttpComponents AsyncClient 4.0-ALPHA1}
+
+-------------------------
+  <dependency>
+    <groupId>org.apache.httpcomponents</groupId>
+    <artifactId>httpasyncclient</artifactId>
+    <version>4.0-alpha1</version>
+    <scope>compile</scope>
+  </dependency>
+-------------------------
diff --git a/src/site/apt/examples.apt b/src/site/apt/examples.apt
@@ -0,0 +1,43 @@
+~~ ====================================================================
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements.  See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership.  The ASF licenses this file
+~~ to you 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/>.
+
+    ----------
+    HttpComponents HttpAsyncClient Examples
+    ----------
+    ----------
+    ----------
+
+HttpAsyncClient Examples
+
+    * {{{./httpasyncclient/examples/org/apache/http/examples/nio/client/AsyncClientRequest.java}Asynchronous 
+      HTTP exchange}}
+
+    This example shows a basic asynchronous HTTP request / response exchange. Response content is 
+    buffered in memory.
+
+    * {{{./httpasyncclient/examples/org/apache/http/examples/nio/client/AsyncClientResponseStreaming.java}Asynchronous 
+      HTTP exchnage with content streaming}}
+
+    This shows an asynchronous HTTP request / response exchange with a full content streaming.
+
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
@@ -0,0 +1,101 @@
+~~ ====================================================================
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements.  See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership.  The ASF licenses this file
+~~ to you 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/>.
+
+    ----------
+    HttpComponents HttpClient Overview
+    ----------
+    ----------
+    ----------
+
+HttpClient Overview
+
+    The Hyper-Text Transfer Protocol (HTTP) is perhaps the most significant protocol used on the 
+    Internet today. Web services, network-enabled appliances and the growth of network computing 
+    continue to expand the role of the HTTP protocol beyond user-driven web browsers, while 
+    increasing the number of applications that require HTTP support.
+
+    Although the java.net package provides basic functionality for accessing resources via HTTP, it 
+    doesn't provide the full flexibility or functionality needed by many applications. 
+    HttpAsyncClient seeks to fill this void by providing an efficient, up-to-date, and feature-rich 
+    package implementing the client side of the most recent HTTP standards and recommendations.
+
+    Designed for extension while providing robust support for the base HTTP protocol, 
+    HttpAsyncClient may be of interest to anyone building HTTP-aware client applications based on
+    asynchronous, event driven I/O model.
+
+{Documentation}
+
+    * Some examples of HttpAsyncClient in action can be found {{{./examples.html}here}}
+
+{Features}
+
+    * Standards based, pure Java, implementation of HTTP versions 1.0 and 1.1
+
+    * Full implementation of all HTTP methods (GET, POST, PUT, DELETE, HEAD, OPTIONS, and TRACE) 
+    in an extensible OO framework.
+
+    * Supports encryption with HTTPS (HTTP over SSL) protocol.
+
+    * Transparent connections through HTTP proxies.
+
+    * Tunneled HTTPS connections through HTTP proxies, via the CONNECT method.
+
+    * Connection management support concurrent request execution. Supports setting the maximum 
+      total connections as well as the maximum connections per host. Detects and closes expired 
+      connections.
+
+    * Persistent connections using KeepAlive in HTTP/1.0 and persistance in HTTP/1.1
+
+    * The ability to set connection timeouts.
+
+    * Source code is freely available under the Apache License.
+
+{Features - Planned}
+
+    * Basic, Digest, NTLMv1, NTLMv2, NTLM2 Session, SNPNEGO/Kerberos authentication schemes.
+
+    * Plug-in mechanism for custom authentication schemes.
+
+    * Automatic Cookie handling for reading Set-Cookie: headers from the server and sending them 
+      back out in a Cookie: header when appropriate.
+
+    * Plug-in mechanism for custom cookie policies.
+
+{Standards Compliance}
+
+    HttpClient strives to conform to the following specifications endorsed by the Internet 
+    Engineering Task Force (IETF) and the internet at large:
+
+    * {{{http://www.ietf.org/rfc/rfc1945.txt}RFC 1945}} Hypertext Transfer Protocol -- HTTP/1.0
+
+    * {{{http://www.ietf.org/rfc/rfc2616.txt}RFC 2616}} Hypertext Transfer Protocol -- HTTP/1.1
+
+{Standards Compliance - Planned}
+
+    * {{{http://www.ietf.org/rfc/rfc2617.txt}RFC 2617}} HTTP Authentication: Basic and Digest Access 
+      Authentication
+
+    * {{{http://www.ietf.org/rfc/rfc2109.txt}RFC 2109}} HTTP State Management Mechanism (Cookies)
+
+    * {{{http://www.ietf.org/rfc/rfc2965.txt}RFC 2965}} HTTP State Management Mechanism (Cookies v2)
diff --git a/src/site/apt/quickstart.apt b/src/site/apt/quickstart.apt
@@ -0,0 +1,50 @@
+~~ ====================================================================
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements.  See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership.  The ASF licenses this file
+~~ to you 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/>.
+
+    ----------
+    HttpAsyncClient Quick Start
+    ----------
+    ----------
+    ----------
+
+HttpClient Quick Start
+
+    [[1]] Download 'Binary' package of the latest official release from the 
+    {{{http://hc.apache.org/downloads.cgi} project download page}}. 
+
+    There should be 6 jars in total:
+
+    * commons-logging-<x.x.x>.jar
+
+    * commons-codec-<x.x.x>.jar
+
+    * httpcore-<x.x.x>.jar
+
+    * httpcore-nio-<x.x.x>.jar
+
+    * httpclient-<x.x.x>.jar
+
+    * httpasyncclient-<x.x.x>.jar
+
+    []
diff --git a/src/site/resources/css/site.css b/src/site/resources/css/site.css
@@ -0,0 +1 @@
+@import url("http://hc.apache.org/css/hc-maven.css");