hc-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ol...@apache.org
Subject svn commit: r657144 - in /httpcomponents/project/src/site: apt/index.apt apt/poweredby.apt apt/user-docs.apt resources/css/hc-maven.css site.xml
Date Fri, 16 May 2008 17:35:55 GMT
Author: olegk
Date: Fri May 16 10:35:55 2008
New Revision: 657144

URL: http://svn.apache.org/viewvc?rev=657144&view=rev
Log:
Added document on NTLM support; ported HTTP client programming primer from WIKI; minor tweaks
all over

Modified:
    httpcomponents/project/src/site/apt/index.apt
    httpcomponents/project/src/site/apt/poweredby.apt
    httpcomponents/project/src/site/apt/user-docs.apt
    httpcomponents/project/src/site/resources/css/hc-maven.css
    httpcomponents/project/src/site/site.xml

Modified: httpcomponents/project/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/index.apt?rev=657144&r1=657143&r2=657144&view=diff
==============================================================================
--- httpcomponents/project/src/site/apt/index.apt (original)
+++ httpcomponents/project/src/site/apt/index.apt Fri May 16 10:35:55 2008
@@ -44,14 +44,6 @@
     applications such as web browsers, web spiders, HTTP proxies, web service transport 
     libraries, or systems that leverage or extend the HTTP protocol for distributed communication.

     
-Commons HttpClient
-
-    The Apache HttpComponents project is charged with developing and maintaining 
-    {{{http://hc.apache.org/httpclient-3.x/index.html}Commons HttpClient}}.
-    Commons HttpClient is the current stable library of choice for most users.
-    Commons HttpClient 3 will be maintained until Apache HttpClient 4 is 
-    deemed stable enough to supersede it for use in production.
-
 HttpComponents Structure
 
     The HttpComponents project is in the process of developing low-level libraries for several

@@ -66,42 +58,44 @@
 
     HttpCore consists of several modules
 
-    <<HttpCore base module>>
+** HttpCore base module
 
     This module contains the HttpCore public API and the default implementation based on
the Java 
     classic (blocking) I/O model. It requires a Java 1.3 compatible runtime and has no dependency

     on any external libraries.
 
-    <<HttpCore NIO extensions>>
+** HttpCore NIO extensions
 
     HttpCore NIO extensions contain optional components that leverage the event driven, non-blocking

     I/O (NIO) model. HttpCore NIO extensions require a Java 5.0 compatible runtime and the
HttpCore 
-    base module.
-
-    HttpCore NIO extensions are intended for those usage scenarios where raw throughput is
less 
-    important than the ability to handle thousands of simultaneous HTTP connections in a
resource 
-    efficient manner.
+    base module. HttpCore NIO extensions are intended for those usage scenarios where raw
throughput 
+    is less important than the ability to handle thousands of simultaneous HTTP connections
in a 
+    resource efficient manner.
 
 * HttpClient
 
-    {{{httpcomponents-client/index.html}HttpClient}} developed by the HttpComponents project
serves 
-    as an easy to use facade to the lower level components of HttpCore, HttpAuth, HttpCookie,
and 
-    HttpConn. It is intended as successor of and replacement for 
-    {{{http://hc.apache.org/httpclient-3.x/index.html}Jakarta Commons HttpClient 3.x}}
-
-    <<HttpConn (presently included in HttpClient)>>
+    {{{httpcomponents-client/index.html}HttpClient}} provides components for client-side

+    authentication, HTTP state management, connection management, and an HTTP/1.1 compliant
+    HTTP agent implementation based on those components. It is intended as successor of and

+    replacement for {{{http://hc.apache.org/httpclient-3.x/index.html}Jakarta 
+    Commons HttpClient 3.x}}
+
+** HttpClient base module
+
+    The {{{httpcomponents-client/httpclient/index.html}HttpClient}} module is a full-featured,

+    HTTP/1.1 compliant agent built on top of {{{httpcomponents-core/index.html}HttpCore}}.
+
+** HttpMime module
+
+    The {{{httpcomponents-client/httpmime/index.html}HttpMime}} module extends 
+    {{{http://james.apache.org/mime4j/index.html}mime4j}} library with some HTTP specific
+    functionality and integrates it with the HttpComponents framework.
 
-    HttpConn will provide an API and a number of default implementations of components for
efficient 
-    management of HTTP connections
 
-    <<HttpCookie (presently included in HttpClient)>>
-
-    HttpCookie will provide an abstract API and pluggable implementations of standard cookie

-    policies such as those based on RFC 2109 and RFC 2965 specifications as well as cookie
policies 
-    compatible with Netscate Cookie draft and common practices of popular web browsers
-
-    <<HttpAuth (presently included in HttpClient)>>
-
-    HttpAuth will provide an abstract API and pluggable implementations of standard authentication

-    schemes such as Basic, Digest and Kerberos (SPNEGO)
+Commons HttpClient
 
+    The Apache HttpComponents project is charged with developing and maintaining 
+    {{{http://hc.apache.org/httpclient-3.x/index.html}Commons HttpClient}}.
+    Commons HttpClient is the current stable library of choice for most users.
+    Commons HttpClient 3 will be maintained until Apache HttpClient 4 is 
+    deemed stable enough to supersede it for use in production.

Modified: httpcomponents/project/src/site/apt/poweredby.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/poweredby.apt?rev=657144&r1=657143&r2=657144&view=diff
==============================================================================
--- httpcomponents/project/src/site/apt/poweredby.apt (original)
+++ httpcomponents/project/src/site/apt/poweredby.apt Fri May 16 10:35:55 2008
@@ -54,7 +54,5 @@
     chair of the Apache Synapse PMC said: "HttpCore is a key part of Apache 
     Synapse - and absolutely essential to our high-performance HTTP support. 
     The HttpComponents team have always been extremely helpful and the 
-    quality of the code speaks for itself". The Apache Synapse team has also 
-    ported the HttpCore-based transport into the 
-    {{{http://ws.apache.org/axis2/}Apache Axis2 Web Services}} project. 
+    quality of the code speaks for itself". 
 

Modified: httpcomponents/project/src/site/apt/user-docs.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/user-docs.apt?rev=657144&r1=657143&r2=657144&view=diff
==============================================================================
--- httpcomponents/project/src/site/apt/user-docs.apt (original)
+++ httpcomponents/project/src/site/apt/user-docs.apt Fri May 16 10:35:55 2008
@@ -57,8 +57,7 @@
    to a servlet, or configuring a proxy within an applet, some of the FAQs
    may prove helpful.
 
-   * {{{http://wiki.apache.org/HttpComponents/ForAbsoluteBeginners}
-        Client HTTP Programming Primer}} - 
+   * {{{httpcomponents-client/primer.html} Client HTTP Programming Primer}} - 
    The Primer describes how to submit an HTML form to a web server and
    retrieve the results. HTML forms are often used as login forms, so the
    Primer also tells you how to perform form-based login in your application.
@@ -77,30 +76,27 @@
    Commons HttpClient 3.1. The standard Java HttpUrlConnection also manages
    connections, though we're not really concerned about that.
 
-   * {{{http://wiki.apache.org/HttpComponents/FrequentlyAskedNTLMQuestions}
-        NTLM FAQ}} -
-   The limited support of HttpClient for NTLM authentication is addressed
-   by this FAQ.
+   * {{{httpcomponents-client/ntlm.html}NTLM support}} -
+   How to enable support for NTLM authentication in HttpClient.
 
 
 API Specific Information
 
 * JavaDocs
 
-  * {{{./httpcomponents-core/httpcore/apidocs/index.html}HttpCore (main)}}
+  * {{{./httpcomponents-core/httpcore/apidocs/index.html}HttpCore}}
 
-  * {{{./httpcomponents-core/httpcore-nio/apidocs/index.html}HttpNIO}}
+  * {{{./httpcomponents-core/httpcore-nio/apidocs/index.html}HttpCore NIO}}
 
   * {{{./httpcomponents-client/httpclient/apidocs/index.html}HttpClient}}
 
+  * {{{./httpcomponents-client/httpmime/apidocs/index.html}HttpMime}}
+
   * {{{./httpclient-3.x/apidocs/index.html}Commons HttpClient 3.1}}
 
 
 * HttpComponents
 
-  * {{{http://wiki.apache.org/HttpComponents/HttpComponents}
-       Informal Units of HttpComponents}}
-
   * {{{http://wiki.apache.org/HttpComponents/GuidedTourOfHttpCore}
        A Guided Tour Of HttpCore}}
 
@@ -108,11 +104,9 @@
     {{{http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/examples/org/apache/http/examples/}
        HttpCore}}
     {{{http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-nio/src/examples/org/apache/http/examples/nio/}
-       HttpNIO}}
+       HttpCore NIO}}
     {{{http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/examples/org/apache/http/examples/client/}
        HttpClient}}
-    {{{http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/examples/org/apache/http/examples/conn/}
-       HttpConn}}
     \
     Example code is meant to help you understand the API.
     It is also shipped with releases.

Modified: httpcomponents/project/src/site/resources/css/hc-maven.css
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/resources/css/hc-maven.css?rev=657144&r1=657143&r2=657144&view=diff
==============================================================================
--- httpcomponents/project/src/site/resources/css/hc-maven.css (original)
+++ httpcomponents/project/src/site/resources/css/hc-maven.css Fri May 16 10:35:55 2008
@@ -80,6 +80,15 @@
  background-repeat: no-repeat;
 }
 
+h4 {
+ color: #333;
+ margin-top: 4px;
+ margin-bottom: 4px;
+ border: none;
+ font-weight: 900;
+ font-size: 13px;
+}
+
 div#bodyColumn {
  margin-top: 0px;
  margin-left: 158px;

Modified: httpcomponents/project/src/site/site.xml
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/site.xml?rev=657144&r1=657143&r2=657144&view=diff
==============================================================================
--- httpcomponents/project/src/site/site.xml (original)
+++ httpcomponents/project/src/site/site.xml Fri May 16 10:35:55 2008
@@ -62,8 +62,10 @@
     </menu>
     <menu name="Components">
       <item name="HttpCore" href="httpcomponents-core/index.html"/>
-      <item name="HttpClient 4.0" href="httpcomponents-client/index.html"/>
-      <item name="HttpClient 3.1" href="httpclient-3.x/index.html"/>
+      <item name="HttpClient" href="httpcomponents-client/index.html"/>
+    </menu>
+    <menu name="Legacy">
+      <item name="Commons HttpClient" href="httpclient-3.x/index.html"/>
     </menu>
     <menu name="Project">
       <item name="Status" href="status.html"/>



Mime
View raw message