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 2021/01/17 09:21:38 UTC
[httpcomponents-website] branch master updated (3a06891 -> e79774c)
This is an automated email from the ASF dual-hosted git repository.
olegk pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/httpcomponents-website.git.
from 3a06891 Update quickstart.apt
new e87d673 Removed old release content
new e79774c Reference xref report resources from example pages (example sources no longer need to be deployed separately)
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../httpcomponents-asyncclient-4.0.x/download.apt | 49 --
.../httpcomponents-asyncclient-4.0.x/examples.apt | 94 ---
.../apt/httpcomponents-asyncclient-4.0.x/index.apt | 111 ----
.../quickstart.apt | 139 -----
.../httpcomponents-client-4.3.x/android-port.apt | 85 ---
.../apt/httpcomponents-client-4.3.x/download.apt | 54 --
.../apt/httpcomponents-client-4.3.x/examples.apt | 109 ----
src/site/apt/httpcomponents-client-4.3.x/index.apt | 135 -----
.../apt/httpcomponents-client-4.3.x/logging.apt | 284 ----------
src/site/apt/httpcomponents-client-4.3.x/ntlm.apt | 162 ------
.../apt/httpcomponents-client-4.3.x/primer.apt | 631 ---------------------
.../apt/httpcomponents-client-4.3.x/quickstart.apt | 114 ----
.../httpcomponents-client-5.0.x/examples-async.apt | 22 +-
.../examples-reactive.apt | 2 +-
.../apt/httpcomponents-client-5.0.x/examples.apt | 34 +-
.../apt/httpcomponents-client-5.0.x/quickstart.apt | 8 +-
.../apt/httpcomponents-core-5.0.x/examples.apt | 34 +-
.../apt/httpcomponents-core-5.1.x/examples.apt | 34 +-
18 files changed, 67 insertions(+), 2034 deletions(-)
delete mode 100644 src/site/apt/httpcomponents-asyncclient-4.0.x/download.apt
delete mode 100644 src/site/apt/httpcomponents-asyncclient-4.0.x/examples.apt
delete mode 100644 src/site/apt/httpcomponents-asyncclient-4.0.x/index.apt
delete mode 100644 src/site/apt/httpcomponents-asyncclient-4.0.x/quickstart.apt
delete mode 100644 src/site/apt/httpcomponents-client-4.3.x/android-port.apt
delete mode 100644 src/site/apt/httpcomponents-client-4.3.x/download.apt
delete mode 100644 src/site/apt/httpcomponents-client-4.3.x/examples.apt
delete mode 100644 src/site/apt/httpcomponents-client-4.3.x/index.apt
delete mode 100644 src/site/apt/httpcomponents-client-4.3.x/logging.apt
delete mode 100644 src/site/apt/httpcomponents-client-4.3.x/ntlm.apt
delete mode 100644 src/site/apt/httpcomponents-client-4.3.x/primer.apt
delete mode 100644 src/site/apt/httpcomponents-client-4.3.x/quickstart.apt
[httpcomponents-website] 02/02: Reference xref report resources
from example pages (example sources no longer need to be deployed
separately)
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olegk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/httpcomponents-website.git
commit e79774cad169d9a05ba7bbb10e57d016c7740dfc
Author: Oleg Kalnichevski <ol...@apache.org>
AuthorDate: Sun Jan 17 10:16:40 2021 +0100
Reference xref report resources from example pages (example sources no longer need to be deployed separately)
---
.../httpcomponents-client-5.0.x/examples-async.apt | 22 +++++++-------
.../examples-reactive.apt | 2 +-
.../apt/httpcomponents-client-5.0.x/examples.apt | 34 +++++++++++-----------
.../apt/httpcomponents-client-5.0.x/quickstart.apt | 8 ++---
.../apt/httpcomponents-core-5.0.x/examples.apt | 34 +++++++++++-----------
.../apt/httpcomponents-core-5.1.x/examples.apt | 34 +++++++++++-----------
6 files changed, 67 insertions(+), 67 deletions(-)
diff --git a/src/site/apt/httpcomponents-client-5.0.x/examples-async.apt b/src/site/apt/httpcomponents-client-5.0.x/examples-async.apt
index ce4e947..2eab500 100644
--- a/src/site/apt/httpcomponents-client-5.0.x/examples-async.apt
+++ b/src/site/apt/httpcomponents-client-5.0.x/examples-async.apt
@@ -30,65 +30,65 @@
HttpClient Examples (Async)
- * {{{./httpclient5/examples/AsyncClientHttpExchange.java}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncClientHttpExchange.html}
Asynchronous HTTP exchange}}
This example demonstrates a basic asynchronous HTTP request / response exchange.
Response content is buffered in memory for simplicity.
- * {{{./httpclient5/examples/AsyncClientHttpExchangeStreaming.java}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncClientHttpExchangeStreaming.html}
Asynchronous HTTP exchange with content streaming}}
This example demonstrates an asynchronous HTTP request / response exchange with a full content
streaming.
- * {{{./httpclient5/examples/AsyncClientTlsAlpn.java}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncClientTlsAlpn.html}
HTTP/2 ALPN support}}
This example demonstrates how to avoid the illegal reflective access operation warning when running
with Oracle JRE 9 or newer.
- * {{{./httpclient5/examples/AsyncClientHttp1Pipelining.java}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncClientHttp1Pipelining.html}
Pipelined HTTP/1.1 exchanges}}
This example demonstrates a pipelined execution of multiple HTTP/1.1 request / response exchanges.
Response content is buffered in memory for simplicity.
- * {{{./httpclient5/examples/AsyncClientHttp2Multiplexing.java}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncClientHttp2Multiplexing.html}
Multiplexed HTTP/2 exchanges}}
This example demonstrates a multiplexed execution of multiple HTTP/2 request / response exchanges.
Response content is buffered in memory for simplicity.
- * {{{./httpclient5/examples/AsyncClientInterceptors.java}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncClientInterceptors.html}
Request execution interceptors}}
This example demonstrates how to insert custom request interceptor and an execution interceptor to the
request execution chain.
- * {{{./httpclient5/examples/AsyncClientMessageTrailers.java}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncClientMessageTrailers.html}
Message trailers}}
This example demonstrates how to use a custom execution interceptor to add trailers to all
outgoing request enclosing an entity..
- * {{{./httpclient5/examples/AsyncClientHttp2ServerPush.java}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncClientHttp2ServerPush.html}
Multiplexed HTTP/2 exchanges}}
This example demonstrates handling of HTTP/2 message exchanges pushed by the server.
- * {{{./httpclient5/examples/AsyncClientAuthentication.java}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncClientAuthentication.html}
Client authentication}}
This example demonstrates execution of an HTTP request against a target site that requires user
authentication.
- * {{{./httpclient5/examples/AsyncClientCustomSSL.java}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncClientCustomSSL.html}
Custom SSL context}}
This example demonstrates how to create secure connections with a custom SSL context.
- * {{{./httpclient5/examples/AsyncClientConnectionEviction.java}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncClientConnectionEviction.html}
Connection eviction}}
This example demonstrates how to evict expired and idle connections from the connection pool.
diff --git a/src/site/apt/httpcomponents-client-5.0.x/examples-reactive.apt b/src/site/apt/httpcomponents-client-5.0.x/examples-reactive.apt
index fa0bdf1..aaf7c82 100644
--- a/src/site/apt/httpcomponents-client-5.0.x/examples-reactive.apt
+++ b/src/site/apt/httpcomponents-client-5.0.x/examples-reactive.apt
@@ -30,7 +30,7 @@
HttpClient Examples (Async)
- * {{{./httpclient5/examples/AsyncClientHttpExchange.java}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncClientHttpExchange.html}
HTTP exchange with Reactive Streams}}
This example demonstrates a reactive, full-duplex HTTP/1.1 message exchange using RxJava.
diff --git a/src/site/apt/httpcomponents-client-5.0.x/examples.apt b/src/site/apt/httpcomponents-client-5.0.x/examples.apt
index 7d7ce08..8333e90 100644
--- a/src/site/apt/httpcomponents-client-5.0.x/examples.apt
+++ b/src/site/apt/httpcomponents-client-5.0.x/examples.apt
@@ -30,7 +30,7 @@
HttpClient Examples (Classic)
- * {{{./httpclient5/examples/ClientWithResponseHandler.java}Response handling}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientWithResponseHandler.html}Response handling}}
This example demonstrates how to process HTTP responses using a response handler. This is
the recommended way of executing HTTP requests and processing HTTP responses. This approach
@@ -39,77 +39,77 @@ HttpClient Examples (Classic)
guarantees that the underlying HTTP connection will be released back to the connection manager
automatically in all cases.
- * {{{./httpclient5/examples/ClientConnectionRelease.java}Manual connection release}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientConnectionRelease.html}Manual connection release}}
This example demonstrates how to ensure the release of the underlying HTTP connection back to
the connection manager in case of a manual processing of HTTP responses.
- * {{{./httpclient5/examples/ClientConfiguration.java}HttpClient configuration}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientConfiguration.html}HttpClient configuration}}
This example demonstrates how to customize and configure the most common aspects of HTTP request execution
and connection management.
- * {{{./httpclient5/examples/ClientInterceptors.java}Request execution interceptors}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientInterceptors.html}Request execution interceptors}}
This example demonstrates how to insert custom request interceptor and an execution interceptor to the
request execution chain.
- * {{{./httpclient5/examples/ClientAbortMethod.java}Abort method}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientAbortMethod.html}Abort method}}
This example demonstrates how to abort an HTTP request before its normal completion.
- * {{{./httpclient5/examples/ClientAuthentication.java}Client authentication}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientAuthentication.html}Client authentication}}
This example uses HttpClient to execute an HTTP request against a target site that requires user
authentication.
- * {{{./httpclient5/examples/ClientExecuteProxy.java}Request via a proxy}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientExecuteProxy.html}Request via a proxy}}
This example demonstrates how to send an HTTP request via a proxy.
- * {{{./httpclient5/examples/ClientProxyAuthentication.java}Proxy authentication}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientProxyAuthentication.html}Proxy authentication}}
A simple example showing execution of an HTTP request over a secure connection tunneled through
an authenticating proxy.
- * {{{./httpclient5/examples/ClientChunkEncodedPost.java}Chunk encoded POST}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientChunkEncodedPost.html}Chunk encoded POST}}
This example shows how to stream out a request entity using chunk encoding.
- * {{{./httpclient5/examples/ClientCustomContext.java}Custom execution context}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientCustomContext.html}Custom execution context}}
This example demonstrates the use of a local HTTP context populated custom attributes.
- * {{{./httpclient5/examples/ClientFormLogin.java}Form based logon}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientFormLogin.html}Form based logon}}
This example demonstrates how HttpClient can be used to perform form-based logon.
- * {{{./httpclient5/examples/ClientMultiThreadedExecution.java}Threaded request execution}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientMultiThreadedExecution.html}Threaded request execution}}
An example that executes HTTP requests from multiple worker threads.
- * {{{./httpclient5/examples/ClientCustomSSL.java}Custom SSL context}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientCustomSSL.html}Custom SSL context}}
This example demonstrates how to create secure connections with a custom SSL context.
- * {{{./httpclient5/examples/ClientPreemptiveBasicAuthentication.java}Preemptive BASIC authentication}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientPreemptiveBasicAuthentication.html}Preemptive BASIC authentication}}
This example shows how HttpClient can be customized to authenticate preemptively using BASIC
scheme. Generally, preemptive authentication can be considered less secure than a response to
an authentication challenge and therefore discouraged.
- * {{{./httpclient5/examples/ClientPreemptiveDigestAuthentication.java}Preemptive DIGEST authentication}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientPreemptiveDigestAuthentication.html}Preemptive DIGEST authentication}}
This example shows how HttpClient can be customized to authenticate preemptively using DIGEST
scheme. Generally, preemptive authentication can be considered less secure than a response to
an authentication challenge and therefore discouraged.
- * {{{./httpclient5/examples/ProxyTunnelDemo.java}Proxy tunnel}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ProxyTunnelDemo.html}Proxy tunnel}}
This example shows how to use ProxyClient in order to establish a tunnel through an HTTP proxy
for an arbitrary protocol.
- * {{{./httpclient5/examples/ClientMultipartFormPost.java}Multipart encoded request entity}}
+ * {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/ClientMultipartFormPost.html}Multipart encoded request entity}}
This example shows how to execute requests enclosing a multipart encoded entity.
diff --git a/src/site/apt/httpcomponents-client-5.0.x/quickstart.apt b/src/site/apt/httpcomponents-client-5.0.x/quickstart.apt
index 27d7f9a..80f4ddb 100644
--- a/src/site/apt/httpcomponents-client-5.0.x/quickstart.apt
+++ b/src/site/apt/httpcomponents-client-5.0.x/quickstart.apt
@@ -75,8 +75,8 @@ try (CloseableHttpClient httpclient = HttpClients.createDefault()) {
}
-------------
- Source can be downloaded
- {{{./httpclient5/examples/QuickStart.java}here}}
+ Source can be found here
+ {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/QuickStart.html}here}}
[[1]] The same requests can be executed using a simpler, albeit less flexible, fluent API.
@@ -94,7 +94,7 @@ Request.Post("http://targethost/login")
-------------
Source can be downloaded
- {{{./httpclient5-fluent/examples/FluentQuickStart.java}here}}
+ {{{./httpclient5-fluent/xref-test/org/apache/hc/client5/http/examples/fluent/FluentQuickStart.html}here}}
[[1]] The below code fragment illustrates the execution of HTTP requests using
HttpClient async API.
@@ -198,6 +198,6 @@ try (CloseableHttpAsyncClient httpclient = HttpAsyncClients.createDefault()) {
---
Source can be downloaded
- {{{./httpclient5/examples/AsyncQuickStart.java}here}}
+ {{{./httpclient5/xref-test/org/apache/hc/client5/http/examples/AsyncQuickStart.java}here}}
diff --git a/src/site/apt/httpcomponents-core-5.0.x/examples.apt b/src/site/apt/httpcomponents-core-5.0.x/examples.apt
index 4cfdbf0..a7e3f56 100644
--- a/src/site/apt/httpcomponents-core-5.0.x/examples.apt
+++ b/src/site/apt/httpcomponents-core-5.0.x/examples.apt
@@ -30,93 +30,93 @@
HttpCore Examples
- * {{{./httpcore5/examples/ClassicGetExecutionExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/ClassicGetExecutionExample.java}
Classic (blocking) HTTP/1.1 GET requests}}
This example demonstrates synchronous execution of multiple HTTP/1.1 GET requests.
- * {{{./httpcore5/examples/ClassicPostExecutionExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/ClassicPostExecutionExample.java}
Classic (blocking) HTTP/1.1 POST requests}}
This example demonstrates synchronous execution of multiple HTTP/1.1 POST requests with enclosed
content of various types.
- * {{{./httpcore5/examples/AsyncRequestExecutionExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/AsyncRequestExecutionExample.java}
Asynchronous HTTP/1.1 GET requests}}
This example demonstrates asynchronous execution of multiple HTTP/1.1 requests.
- * {{{./httpcore5-h2/examples/H2RequestExecutionExample.java}
+ * {{{./httpcore5-h2/xref-test/org/apache/hc/core5/http2/examples/H2RequestExecutionExample.java}
Asynchronous HTTP/2 GET requests}}
This example demonstrates asynchronous execution of multiple HTTP/2 requests.
- * {{{./httpcore5-h2/examples/H2TlsAlpnRequestExecutionExample.java}
+ * {{{./httpcore5-h2/xref-test/org/apache/hc/core5/http2/examples/H2TlsAlpnRequestExecutionExample.java}
HTTP/2 requests over TLS connections with ALPN support}}
This example demonstrates how to execute HTTP/2 requests over TLS connections with ALPN support.
It also explains how to avoid the illegal reflective access operation warning when running
Java 9 or older.
- * {{{./httpcore5-h2/examples/H2ConscriptRequestExecutionExample.java}
+ * {{{./httpcore5-h2/xref-test/org/apache/hc/core5/http2/examples/H2ConscriptRequestExecutionExample.java}
HTTP/2 requests over TLS connections with ALPN support on Java 1.7 and Java 1.8}}
This example demonstrates how to execute HTTP/2 requests over TLS connections with ALPN support
on Java 1.7 and Java 1.8.
- * {{{./httpcore5/examples/AsyncPipelinedRequestExecutionExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/AsyncPipelinedRequestExecutionExample.java}
Asynchronous HTTP/1.1 GET requests with message pipelining}}
This example demonstrates asynchronous, pipelined execution multiple HTTP/1.1 requests.
- * {{{./httpcore5-h2/examples/H2MultiStreamExecutionExample.java}
+ * {{{./httpcore5-h2/xref-test/org/apache/hc/core5/http2/examples/H2MultiStreamExecutionExample.java}
Asynchronous HTTP/2 GET requests with multiple concurrent streams}}
This example demonstrates asynchronous, multistream execution of multiple HTTP/2 requests.
- * {{{./httpcore5/examples/ClassicFileServerExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/ClassicFileServerExample.java}
Classic (blocking) HTTP/1.1 file server}}
This is an example of an embedded HTTP/1.1 file server with a classic (blocking) message transport.
- * {{{./httpcore5/examples/ClassicServerFilterExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/ClassicServerFilterExample.java}
Request filters with classic (blocking) HTTP/1.1 server}}
This is an example of using synchronous request filters with an embedded HTTP/1.1 server.
- * {{{./httpcore5/examples/AsyncFileServerExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/AsyncFileServerExample.java}
Asynchronous HTTP/1.1 file server}}
This is an example of an embedded HTTP/1.1 file server with an event driven, non-blocking message transport.
- * {{{./httpcore5/examples/AsyncServerFilterExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/AsyncServerFilterExample.java}
Request filters with asynchronous HTTP/1.1 server}}
This is an example of using asynchronous request filters with an embedded HTTP/1.1 server.
- * {{{./httpcore5-h2/examples/H2FileServerExample.java}
+ * {{{./httpcore5-h2/xref-test/org/apache/hc/core5/http2/examples/H2FileServerExample.java}
Asynchronous HTTP/2 file server}}
This is an example of an embedded HTTP/2 file server with an event driven, non-blocking message transport.
- * {{{./httpcore5/examples/ClassicReverseProxyExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/ClassicReverseProxyExample.java}
Classic (blocking) HTTP reverse proxy}}
This is an example of an embedded HTTP/1.1 reverse proxy with a classic (blocking) message transport.
- * {{{./httpcore5/examples/AsyncReverseProxyExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/AsyncReverseProxyExample.java}
Asynchronous HTTP reverse proxy}}
This is an example of an embedded HTTP/1.1 reverse proxy with an event driven, non-blocking message transport.
HttpCore Reactive Streams Examples
- * {{{./httpcore5-reactive/examples/ReactiveFullDuplexClientExample.java}
+ * {{{./httpcore5-reactive/xref-test/org/apache/hc/core5/reactive/examples/ReactiveFullDuplexClientExample.java}
Client Reactive Streams}}
This is an example of full-duplex HTTP/1.1 client side message exchanges using reactive streaming.
- * {{{./httpcore5-reactive/examples/ReactiveFullDuplexServerExample.java}
+ * {{{./httpcore5-reactive/xref-test/org/apache/hc/core5/reactive/examples/ReactiveFullDuplexServerExample.java}
Server Reactive Streams}}
This is an example of full-duplex HTTP/1.1 server side message exchanges using reactive streaming.
diff --git a/src/site/apt/httpcomponents-core-5.1.x/examples.apt b/src/site/apt/httpcomponents-core-5.1.x/examples.apt
index 4cfdbf0..6ab5682 100644
--- a/src/site/apt/httpcomponents-core-5.1.x/examples.apt
+++ b/src/site/apt/httpcomponents-core-5.1.x/examples.apt
@@ -30,93 +30,93 @@
HttpCore Examples
- * {{{./httpcore5/examples/ClassicGetExecutionExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/ClassicGetExecutionExample.html}
Classic (blocking) HTTP/1.1 GET requests}}
This example demonstrates synchronous execution of multiple HTTP/1.1 GET requests.
- * {{{./httpcore5/examples/ClassicPostExecutionExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/ClassicPostExecutionExample.html}
Classic (blocking) HTTP/1.1 POST requests}}
This example demonstrates synchronous execution of multiple HTTP/1.1 POST requests with enclosed
content of various types.
- * {{{./httpcore5/examples/AsyncRequestExecutionExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/AsyncRequestExecutionExample.html}
Asynchronous HTTP/1.1 GET requests}}
This example demonstrates asynchronous execution of multiple HTTP/1.1 requests.
- * {{{./httpcore5-h2/examples/H2RequestExecutionExample.java}
+ * {{{./httpcore5-h2/xref-test/org/apache/hc/core5/http2/examples/H2RequestExecutionExample.html}
Asynchronous HTTP/2 GET requests}}
This example demonstrates asynchronous execution of multiple HTTP/2 requests.
- * {{{./httpcore5-h2/examples/H2TlsAlpnRequestExecutionExample.java}
+ * {{{./httpcore5-h2/xref-test/org/apache/hc/core5/http2/examples/H2TlsAlpnRequestExecutionExample.html}
HTTP/2 requests over TLS connections with ALPN support}}
This example demonstrates how to execute HTTP/2 requests over TLS connections with ALPN support.
It also explains how to avoid the illegal reflective access operation warning when running
Java 9 or older.
- * {{{./httpcore5-h2/examples/H2ConscriptRequestExecutionExample.java}
+ * {{{./httpcore5-h2/xref-test/org/apache/hc/core5/http2/examples/H2ConscriptRequestExecutionExample.html}
HTTP/2 requests over TLS connections with ALPN support on Java 1.7 and Java 1.8}}
This example demonstrates how to execute HTTP/2 requests over TLS connections with ALPN support
on Java 1.7 and Java 1.8.
- * {{{./httpcore5/examples/AsyncPipelinedRequestExecutionExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/AsyncPipelinedRequestExecutionExample.html}
Asynchronous HTTP/1.1 GET requests with message pipelining}}
This example demonstrates asynchronous, pipelined execution multiple HTTP/1.1 requests.
- * {{{./httpcore5-h2/examples/H2MultiStreamExecutionExample.java}
+ * {{{./httpcore5-h2/xref-test/org/apache/hc/core5/http2/examples/H2MultiStreamExecutionExample.html}
Asynchronous HTTP/2 GET requests with multiple concurrent streams}}
This example demonstrates asynchronous, multistream execution of multiple HTTP/2 requests.
- * {{{./httpcore5/examples/ClassicFileServerExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/ClassicFileServerExample.html}
Classic (blocking) HTTP/1.1 file server}}
This is an example of an embedded HTTP/1.1 file server with a classic (blocking) message transport.
- * {{{./httpcore5/examples/ClassicServerFilterExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/ClassicServerFilterExample.html}
Request filters with classic (blocking) HTTP/1.1 server}}
This is an example of using synchronous request filters with an embedded HTTP/1.1 server.
- * {{{./httpcore5/examples/AsyncFileServerExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/AsyncFileServerExample.html}
Asynchronous HTTP/1.1 file server}}
This is an example of an embedded HTTP/1.1 file server with an event driven, non-blocking message transport.
- * {{{./httpcore5/examples/AsyncServerFilterExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/AsyncServerFilterExample.html}
Request filters with asynchronous HTTP/1.1 server}}
This is an example of using asynchronous request filters with an embedded HTTP/1.1 server.
- * {{{./httpcore5-h2/examples/H2FileServerExample.java}
+ * {{{./httpcore5-h2/xref-test/org/apache/hc/core5/http2/examples/H2FileServerExample.html}
Asynchronous HTTP/2 file server}}
This is an example of an embedded HTTP/2 file server with an event driven, non-blocking message transport.
- * {{{./httpcore5/examples/ClassicReverseProxyExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/ClassicReverseProxyExample.html}
Classic (blocking) HTTP reverse proxy}}
This is an example of an embedded HTTP/1.1 reverse proxy with a classic (blocking) message transport.
- * {{{./httpcore5/examples/AsyncReverseProxyExample.java}
+ * {{{./httpcore5/xref-test/org/apache/hc/core5/http/examples/AsyncReverseProxyExample.html}
Asynchronous HTTP reverse proxy}}
This is an example of an embedded HTTP/1.1 reverse proxy with an event driven, non-blocking message transport.
HttpCore Reactive Streams Examples
- * {{{./httpcore5-reactive/examples/ReactiveFullDuplexClientExample.java}
+ * {{{./httpcore5-reactive/xref-test/org/apache/hc/core5/reactive/examples/ReactiveFullDuplexClientExample.html}
Client Reactive Streams}}
This is an example of full-duplex HTTP/1.1 client side message exchanges using reactive streaming.
- * {{{./httpcore5-reactive/examples/ReactiveFullDuplexServerExample.java}
+ * {{{./httpcore5-reactive/xref-test/org/apache/hc/core5/reactive/examples/ReactiveFullDuplexServerExample.html}
Server Reactive Streams}}
This is an example of full-duplex HTTP/1.1 server side message exchanges using reactive streaming.
[httpcomponents-website] 01/02: Removed old release content
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olegk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/httpcomponents-website.git
commit e87d6737630186323ae31e1f125299cdbe3dd8d8
Author: Oleg Kalnichevski <ol...@apache.org>
AuthorDate: Sun Jan 17 10:15:57 2021 +0100
Removed old release content
---
.../httpcomponents-asyncclient-4.0.x/download.apt | 49 --
.../httpcomponents-asyncclient-4.0.x/examples.apt | 94 ---
.../apt/httpcomponents-asyncclient-4.0.x/index.apt | 111 ----
.../quickstart.apt | 139 -----
.../httpcomponents-client-4.3.x/android-port.apt | 85 ---
.../apt/httpcomponents-client-4.3.x/download.apt | 54 --
.../apt/httpcomponents-client-4.3.x/examples.apt | 109 ----
src/site/apt/httpcomponents-client-4.3.x/index.apt | 135 -----
.../apt/httpcomponents-client-4.3.x/logging.apt | 284 ----------
src/site/apt/httpcomponents-client-4.3.x/ntlm.apt | 162 ------
.../apt/httpcomponents-client-4.3.x/primer.apt | 631 ---------------------
.../apt/httpcomponents-client-4.3.x/quickstart.apt | 114 ----
12 files changed, 1967 deletions(-)
diff --git a/src/site/apt/httpcomponents-asyncclient-4.0.x/download.apt b/src/site/apt/httpcomponents-asyncclient-4.0.x/download.apt
deleted file mode 100644
index 1b303aa..0000000
--- a/src/site/apt/httpcomponents-asyncclient-4.0.x/download.apt
+++ /dev/null
@@ -1,49 +0,0 @@
-~~ ====================================================================
-~~ 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
- ----------
- ----------
- ----------
-
-HttpAsyncClient Downloads
-
- The latest release available for download:
-
- {{{http://hc.apache.org/downloads.cgi}Release packages}} -
- {{{http://www.apache.org/dist/httpcomponents/httpasyncclient/RELEASE_NOTES-4.0.x.txt}Release Notes}} -
- {{{http://www.apache.org/licenses/LICENSE-2.0.html}License}}
-
-{Dependency management}
-
- If you are using a dependency manager for your project such as
- {{{http://maven.apache.org}Apache Maven}} or
- {{{http://ant.apache.org/projects/ivy.html}Apache Ivy}},
- you can create a dependency on HttpClient modules by using this information:
-
- {{{./httpasyncclient/dependency-info.html}HttpAsyncClient}}
-
- {{{./httpasyncclient-cache/dependency-info.html}HttpAsyncClient Cache}}
-
diff --git a/src/site/apt/httpcomponents-asyncclient-4.0.x/examples.apt b/src/site/apt/httpcomponents-asyncclient-4.0.x/examples.apt
deleted file mode 100644
index 8b78456..0000000
--- a/src/site/apt/httpcomponents-asyncclient-4.0.x/examples.apt
+++ /dev/null
@@ -1,94 +0,0 @@
-~~ ====================================================================
-~~ 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/AsyncClientHttpExchange.java}
- Asynchronous HTTP exchange}}
-
- This example demonstrates a basic asynchronous HTTP request / response exchange.
- Response content is buffered in memory for simplicity.
-
- * {{{./httpasyncclient/examples/org/apache/http/examples/nio/client/AsyncClientHttpExchangeStreaming.java}
- Event based content streaming}}
-
- This example demonstrates an asynchronous HTTP request / response exchange with a full content
- streaming.
-
- * {{{./httpasyncclient/examples/org/apache/http/examples/nio/client/AsyncClientHttpExchangeFutureCallback.java}
- Concurrent asynchronous HTTP exchanges}}
-
- This example demonstrates a fully asynchronous execution of multiple HTTP exchanges where the
- result of an individual operation is reported using a callback interface.
-
- * {{{./httpasyncclient/examples/org/apache/http/examples/nio/client/AsyncClientExecuteProxy.java}
- Asynchronous request via a proxy}}
-
- This example demonstrates how to send an HTTP request via a proxy.
-
- * {{{./httpasyncclient/examples/org/apache/http/examples/nio/client/AsyncClientConfiguration.java}
- HttpAsyncClient configuration}}
-
- This example demonstrates how to customize and configure the most common aspects of HTTP request execution
- and connection management.
-
- * {{{./httpasyncclient/examples/org/apache/http/examples/nio/client/AsyncClientCustomContext.java}
- Custom execution context}}
-
- This example demonstrates the use of a local execution context with custom context settings.
-
- * {{{./httpasyncclient/examples/org/apache/http/examples/nio/client/AsyncClientAuthentication.java}
- Client authentication}}
-
- This example demonstrates execution of an HTTP request against a target site that requires user
- authentication.
-
- * {{{./httpasyncclient/examples/org/apache/http/examples/nio/client/AsyncClientProxyAuthentication.java}
- Proxy authentication}}
-
- This example shows execution of an HTTP request over a secure connection tunneled through
- an authenticating proxy.
-
- * {{{./httpasyncclient/examples/org/apache/http/examples/nio/client/AsyncClientCustomSSL.java}
- Custom SSL context}}
-
- This example demonstrates how to create secure connections with a custom SSL context.
-
- * {{{./httpasyncclient/examples/org/apache/http/examples/nio/client/ZeroCopyHttpExchange.java}
- Zero copy file upload / download}}
-
- This example demonstrates how HttpAsyncClient can be used to upload or download files without
- creating an intermediate content buffer in memory (zero copy file transfer).
-
- * {{{./httpasyncclient/examples/org/apache/http/examples/nio/client/AsyncClientEvictExpiredConnections.java}
- Connection eviction}}
-
- This example demonstrates how to evict expired and idle connections from the connection pool.
-
diff --git a/src/site/apt/httpcomponents-asyncclient-4.0.x/index.apt b/src/site/apt/httpcomponents-asyncclient-4.0.x/index.apt
deleted file mode 100644
index a3a9786..0000000
--- a/src/site/apt/httpcomponents-asyncclient-4.0.x/index.apt
+++ /dev/null
@@ -1,111 +0,0 @@
-~~ ====================================================================
-~~ 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 Overview
- ----------
- ----------
- ----------
-
-HttpAsyncClient 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}
-
- [[1]] {{{./quickstart.html}Quick Start}} - contains a simple, complete example of asynchronous
- request execution.
-
- [[1]] {{{./examples.html}HttpAsyncClient Examples}} - a set of examples demonstrating some of
- the more complex behavior.
-
- [[1]] Project reports
-
- * {{{./httpasyncclient/project-reports.html}HttpAsyncClient}}
-
- * {{{./httpasyncclient-cache/project-reports.html}HttpAsyncClient Cache}}
-
- * {{{./httpasyncclient-osgi/project-reports.html}HttpAsyncClient OSGi}}
-
-{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.
-
- * Basic, Digest, NTLMv1, NTLMv2, NTLM2 Session, SNPNEGO and 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.
-
- * Support for HTTP/1.1 response caching.
-
-{Standards Compliance}
-
- HttpAsyncClient 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
-
- * {{{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/httpcomponents-asyncclient-4.0.x/quickstart.apt b/src/site/apt/httpcomponents-asyncclient-4.0.x/quickstart.apt
deleted file mode 100644
index 0921503..0000000
--- a/src/site/apt/httpcomponents-asyncclient-4.0.x/quickstart.apt
+++ /dev/null
@@ -1,139 +0,0 @@
-~~ ====================================================================
-~~ 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
- ----------
- ----------
- ----------
-
-HttpAsyncClient Quick Start
-
- [[1]] Download 'Binary' package of the latest HttpAsyncClient 4.0 release or configure
- dependency on {{{./httpasyncclient/dependency-info.html}HttpAsyncClient}} module using
- a dependency manager of your choice as described {{{./download.html}here}}.
-
- [[1]] HttpAsyncClient 4.0 requires Java 1.5 or newer.
-
- [[1]] The code fragment below illustrates the most fundamental aspects of asynchronous
- request execution with HttpAsyncClient.
-
--------------
-CloseableHttpAsyncClient httpclient = HttpAsyncClients.createDefault();
-try {
- // Start the client
- httpclient.start();
-
- // Execute request
- final HttpGet request1 = new HttpGet("http://www.apache.org/");
- Future<HttpResponse> future = httpclient.execute(request1, null);
- // and wait until a response is received
- HttpResponse response1 = future.get();
- System.out.println(request1.getRequestLine() + "->" + response1.getStatusLine());
-
- // One most likely would want to use a callback for operation result
- final CountDownLatch latch1 = new CountDownLatch(1);
- final HttpGet request2 = new HttpGet("http://www.apache.org/");
- httpclient.execute(request2, new FutureCallback<HttpResponse>() {
-
- public void completed(final HttpResponse response2) {
- latch1.countDown();
- System.out.println(request2.getRequestLine() + "->" + response2.getStatusLine());
- }
-
- public void failed(final Exception ex) {
- latch1.countDown();
- System.out.println(request2.getRequestLine() + "->" + ex);
- }
-
- public void cancelled() {
- latch1.countDown();
- System.out.println(request2.getRequestLine() + " cancelled");
- }
-
- });
- latch1.await();
-
- // In real world one most likely would also want to stream
- // request and response body content
- final CountDownLatch latch2 = new CountDownLatch(1);
- final HttpGet request3 = new HttpGet("http://www.apache.org/");
- HttpAsyncRequestProducer producer3 = HttpAsyncMethods.create(request3);
- AsyncCharConsumer<HttpResponse> consumer3 = new AsyncCharConsumer<HttpResponse>() {
-
- HttpResponse response;
-
- @Override
- protected void onResponseReceived(final HttpResponse response) {
- this.response = response;
- }
-
- @Override
- protected void onCharReceived(final CharBuffer buf, final IOControl ioctrl) throws IOException {
- // Do something useful
- }
-
- @Override
- protected void releaseResources() {
- }
-
- @Override
- protected HttpResponse buildResult(final HttpContext context) {
- return this.response;
- }
-
- };
- httpclient.execute(producer3, consumer3, new FutureCallback<HttpResponse>() {
-
- public void completed(final HttpResponse response3) {
- latch2.countDown();
- System.out.println(request2.getRequestLine() + "->" + response3.getStatusLine());
- }
-
- public void failed(final Exception ex) {
- latch2.countDown();
- System.out.println(request2.getRequestLine() + "->" + ex);
- }
-
- public void cancelled() {
- latch2.countDown();
- System.out.println(request2.getRequestLine() + " cancelled");
- }
-
- });
- latch2.await();
-
-} finally {
- httpclient.close();
-}
--------------
-
- [[1]] Take a look at the {{{../httpcomponents-core-ga/tutorial/html/index.html}HttpCore
- tutorial}} for introduction to fundamentals of asynchronous HTTP communication with
- HttpComponents.
-
- [[1]] Another good way of getting started with HttpAsyncClient is by seeing it in action. Take
- a look at the samples shipped with the release package or available {{{./examples.html}online}}.
-
-
diff --git a/src/site/apt/httpcomponents-client-4.3.x/android-port.apt b/src/site/apt/httpcomponents-client-4.3.x/android-port.apt
deleted file mode 100644
index 63b74df..0000000
--- a/src/site/apt/httpcomponents-client-4.3.x/android-port.apt
+++ /dev/null
@@ -1,85 +0,0 @@
-~~ ====================================================================
-~~ 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/>.
-
- ----------
- HttpClient for Android
- ----------
- ----------
- ----------
-
-HttpClient for Android
-
- This project represents an effort to provide an implementation of Apache HttpClient, which can
- be deployed on Google Android in parallel to the outdated version shipped with the platform while
- remaining partially API compatible with Apache HttpClient 4.3.
-
-* {Background}
-
- Google Android 1.0 was released with a pre-BETA snapshot of Apache HttpClient. To coincide with
- the first Android release Apache HttpClient 4.0 APIs had to be frozen prematurely, while many
- of interfaces and internal structures were still not fully worked out. As Apache HttpClient 4.0
- was maturing the project was expecting Google to incorporate the latest code improvements into
- their code tree. Unfortunately it did not happen. Version of Apache HttpClient shipped with
- Android has effectively become a fork. Eventually Google decided to discontinue further
- development of their fork while refusing to upgrade to the stock version of Apache HttpClient
- citing compatibility concerns as a reason for such decision. As a result those Android
- developers who would like to continue using Apache HttpClient APIs on Android cannot take advantage
- of newer features, performance improvements and bug fixes.
-
- Apache HttpClient 4.3 port for Android is intended to remedy the situation by providing
- official releases compatible with Google Android.
-
-* {Differences with the stock version of Apache HttpClient}
-
- [[1]] Compiled against HttpClient 4.0 APIs.
-
- [[1]] Commons Logging replaced with Android Logging.
-
- [[1]] Base64 implementation from Commons Codec replaced with Android Base64.
-
- [[1]] Android default SSLSocketFactory used by for SSL/TLS connections.
-
-
-* {Compatibility notes}
-
- [[1]] HttpClient port for Android is compiled against the official Android SDK and is expected
- to be fully compatible with any code consuming HttpClient services through its interface
- (HttpClient) rather than the default implementation (DefaultHttpClient).
-
- [[1]] Code compiled against stock versions of Apache HttpClient 4.3 is not fully compatible with
- the HttpClient port for Android. Some of the implementation classes had to be copied (or shaded)
- with different names in order to avoid conflicts with the older versions of the same classes
- included in the Android runtime. One can increase compatibility of with the stock version of
- HttpClient by avoiding 'org.apache.http.**.*HC4' classes.
-
-* {Download}
-
- HttpClient 4.3 for Android is available from the Maven central and can be added to Gradle
- builds as the following dependency:
-
-----
-dependencies {
- compile group: 'org.apache.httpcomponents' , name: 'httpclient-android' , version: '4.3.5.1'
-}
-----
diff --git a/src/site/apt/httpcomponents-client-4.3.x/download.apt b/src/site/apt/httpcomponents-client-4.3.x/download.apt
deleted file mode 100644
index fccf5b1..0000000
--- a/src/site/apt/httpcomponents-client-4.3.x/download.apt
+++ /dev/null
@@ -1,54 +0,0 @@
-~~ ====================================================================
-~~ 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 Download Page
- ----------
- ----------
- ----------
-
-HttpClient Downloads
-
- The latest release available for download:
-
- {{{http://hc.apache.org/downloads.cgi}Release packages}} -
- {{{http://www.apache.org/dist/httpcomponents/httpclient/RELEASE_NOTES-4.3.x.txt}Release Notes}} -
- {{{http://www.apache.org/licenses/LICENSE-2.0.html}License}}
-
-{Dependency management}
-
- If you are using a dependency manager for your project such as
- {{{http://maven.apache.org}Apache Maven}} or
- {{{http://ant.apache.org/projects/ivy.html}Apache Ivy}},
- you can create a dependency on HttpClient modules by using this information:
-
- {{{./httpclient/dependency-info.html}HttpClient}}
-
- {{{./httpclient-cache/dependency-info.html}HttpClient Cache}}
-
- {{{./httpmime/dependency-info.html}HttpMime}}
-
- {{{./fluent-hc/dependency-info.html}Fluent HC}}
-
-
diff --git a/src/site/apt/httpcomponents-client-4.3.x/examples.apt b/src/site/apt/httpcomponents-client-4.3.x/examples.apt
deleted file mode 100644
index 44f189c..0000000
--- a/src/site/apt/httpcomponents-client-4.3.x/examples.apt
+++ /dev/null
@@ -1,109 +0,0 @@
-~~ ====================================================================
-~~ 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 Examples
- ----------
- ----------
- ----------
-
-HttpClient Examples
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientWithResponseHandler.java}Response handling}}
-
- This example demonstrates how to process HTTP responses using a response handler. This is
- the recommended way of executing HTTP requests and processing HTTP responses. This approach
- enables the caller to concentrate on the process of digesting HTTP responses and to delegate
- the task of system resource deallocation to HttpClient. The use of an HTTP response handler
- guarantees that the underlying HTTP connection will be released back to the connection manager
- automatically in all cases.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientConnectionRelease.java}Manual connection release}}
-
- This example demonstrates how to ensure the release of the underlying HTTP connection back to
- the connection manager in case of a manual processing of HTTP responses.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientConfiguration.java}HttpClient configuration}}
-
- This example demonstrates how to customize and configure the most common aspects of HTTP request execution
- and connection management.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientAbortMethod.java}Abort method}}
-
- This example demonstrates how to abort an HTTP request before its normal completion.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientAuthentication.java}Client authentication}}
-
- This example uses HttpClient to execute an HTTP request against a target site that requires user
- authentication.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientExecuteProxy.java}Request via a proxy}}
-
- This example demonstrates how to send an HTTP request via a proxy.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientProxyAuthentication.java}Proxy authentication}}
-
- A simple example showing execution of an HTTP request over a secure connection tunneled through
- an authenticating proxy.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientChunkEncodedPost.java}Chunk encoded POST}}
-
- This example shows how to stream out a request entity using chunk encoding.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientCustomContext.java}Custom execution context}}
-
- This example demonstrates the use of a local HTTP context populated custom attributes.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientFormLogin.java}Form based logon}}
-
- This example demonstrates how HttpClient can be used to perform form-based logon.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientMultiThreadedExecution.java}Threaded request execution}}
-
- An example that executes HTTP requests from multiple worker threads.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientCustomSSL.java}Custom SSL context}}
-
- This example demonstrates how to create secure connections with a custom SSL context.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientPreemptiveBasicAuthentication.java}Preemptive BASIC authentication}}
-
- This example shows how HttpClient can be customized to authenticate preemptively using BASIC
- scheme. Generally, preemptive authentication can be considered less secure than a response to
- an authentication challenge and therefore discouraged.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ClientPreemptiveDigestAuthentication.java}Preemptive DIGEST authentication}}
-
- This example shows how HttpClient can be customized to authenticate preemptively using DIGEST
- scheme. Generally, preemptive authentication can be considered less secure than a response to
- an authentication challenge and therefore discouraged.
-
- * {{{./httpclient/examples/org/apache/http/examples/client/ProxyTunnelDemo.java}Proxy tunnel}}
-
- This example shows how to use ProxyClient in order to establish a tunnel through an HTTP proxy
- for an arbitrary protocol.
-
- * {{{./httpmime/examples/org/apache/http/examples/entity/mime/ClientMultipartFormPost.java}Multipart encoded request entity}}
-
- This example shows how to execute requests enclosing a multipart encoded entity.
diff --git a/src/site/apt/httpcomponents-client-4.3.x/index.apt b/src/site/apt/httpcomponents-client-4.3.x/index.apt
deleted file mode 100644
index f79225c..0000000
--- a/src/site/apt/httpcomponents-client-4.3.x/index.apt
+++ /dev/null
@@ -1,135 +0,0 @@
-~~ ====================================================================
-~~ 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. HttpClient
- 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, HttpClient
- may be of interest to anyone building HTTP-aware client applications such as web browsers, web
- service clients, or systems that leverage or extend the HTTP protocol for distributed
- communication.
-
-{Documentation}
-
- [[1]] {{{./quickstart.html}Quick Start}} - contains a simple, complete example of an HTTP GET
- and POST with parameters.
-
- [[1]] {{{./tutorial/html/index.html}HttpClient Tutorial}} - gives a detailed examination of the
- HttpClient API, which was written in close accordance with the (sometimes not very intuitive)
- HTTP specification/standard. A copy is also shipped with the release.
- {{{./tutorial/pdf/httpclient-tutorial.pdf}A PDF version}} is also available
-
- [[1]] {{{./examples.html}HttpClient Examples}} - a set of examples demonstrating some of
- the more complex behavior.
-
- [[1]] {{{./primer.html}HttpClient Primer}} - explains the scope of HttpClient.
- Note that HttpClient is not a browser. It lacks the UI, HTML renderer and a JavaScript engine
- that a browser will possess.
-
- [[1]] Project reports
-
- * {{{./httpclient/project-reports.html}HttpClient}}
-
- * {{{./fluent-hc/project-reports.html}HC Fluent}}
-
- * {{{./httpmime/project-reports.html}HttpMime}}
-
- * {{{./httpclient-cache/project-reports.html}HttpClient Cache}}
-
- * {{{./httpclient-osgi/project-reports.html}HttpClient OSGi}}
-
-{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.
-
- * Basic, Digest, NTLMv1, NTLMv2, NTLM2 Session, SNPNEGO, Kerberos authentication schemes.
-
- * Plug-in mechanism for custom authentication schemes.
-
- * Pluggable secure socket factories, making it easier to use third party solutions
-
- * Connection management support for use in multi-threaded applications. Supports setting the
- maximum total connections as well as the maximum connections per host. Detects and closes
- stale connections.
-
- * 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.
-
- * Request output streams to avoid buffering any content body by streaming directly to the socket
- to the server.
-
- * Response input streams to efficiently read the response body by streaming directly from the
- socket to the server.
-
- * Persistent connections using KeepAlive in HTTP/1.0 and persistance in HTTP/1.1
-
- * Direct access to the response code and headers sent by the server.
-
- * The ability to set connection timeouts.
-
- * Support for HTTP/1.1 response caching.
-
- * Source code is freely available under the Apache License.
-
-{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
-
- * {{{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/httpcomponents-client-4.3.x/logging.apt b/src/site/apt/httpcomponents-client-4.3.x/logging.apt
deleted file mode 100644
index bd6cdb8..0000000
--- a/src/site/apt/httpcomponents-client-4.3.x/logging.apt
+++ /dev/null
@@ -1,284 +0,0 @@
-~~ ====================================================================
-~~ 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/>.
-
- ----------
- HttpClient Logging Practices
- ----------
- ----------
- ----------
-
-Logging Practices
-
- Being a library HttpClient is not to dictate which logging framework the user has to use.
- Therefore HttpClient utilizes the logging interface provided by the
- {{{http://commons.apache.org/logging/}Commons Logging}} package. <<<Commons Logging>>> provides
- a simple and generalized
- {{{http://commons.apache.org/logging/commons-logging-1.0.4/docs/apidocs/}log interface}} to
- various logging packages. By using <<<Commons Logging>>>, HttpClient can be configured for a
- variety of different logging behaviours. That means the user will have to make a choice which
- logging framework to use. By default <<<Commons Logging>>> supports the following logging
- frameworks:
-
- * {{{http://logging.apache.org/log4j/docs/index.html}Log4J}}
-
- * {{{http://docs.oracle.com/javase/7/docs/api/java/util/logging/package-summary.html}
- java.util.logging}}
-
- * {{{http://commons.apache.org/logging/commons-logging-1.0.4/docs/apidocs/org/apache/commons/logging/impl/SimpleLog.html}
- SimpleLog}} (internal to <<<Commons Logging>>>)
-
- By implementing some simple interfaces <<<Commons Logging>>> can be extended to support
- basically any other custom logging framework. <<<Commons Logging>>> tries to automatically
- discover the logging framework to use. If it fails to select the expected one, you must
- configure <<<Commons Logging>>> by hand. Please refer to the <<<Commons Logging>>>
- documentation for more information.
-
- HttpClient performs three different kinds of logging: the standard context logging used within
- each class, HTTP header logging and full wire logging.
-
-* {Context Logging}
-
- Context logging contains information about the internal operation of HttpClient as it performs
- HTTP requests. Each class has its own log named according to the class's fully qualified name.
- For example the class <<<DefaultHttpClient>>> has a log named
- <<<org.apache.http.impl.client.DefaultHttpClient>>>. Since all classes follow this convention
- it is possible to configure context logging for all classes using the single log named
- <<<org.apache.http.impl.client>>>.
-
-* {Wire Logging}
-
- The wire log is used to log all data transmitted to and from servers when executing HTTP
- requests. The wire log uses the <<<org.apache.http.wire>>> logging category. This log should
- only be enabled to debug problems, as it will produce an extremely large amount of log data.
-
-* {HTTP header Logging}
-
- Because the content of HTTP requests is usually less important for debugging than the HTTP
- headers, the <<<org.apache.http.headers>>> logging category for capturing HTTP headers only.
-
-* {Configuration Examples}
-
- <<<Commons Logging>>> can delegate to a variety of loggers for processing the actual output.
- Below are configuration examples for <<<Commons Logging>>>, <<<Log4j>>> and
- <<<java.util.logging>>>.
-
-** {Commons Logging Examples}
-
- <<<Commons Logging>>> comes with a basic logger called <<<SimpleLog>>>. This logger writes all
- logged messages to <<<System.err>>>. The following examples show how to configure
- <<<Commons Logging>>> via system properties to use <<<SimpleLog>>>. It is strongly recommended
- to configure <<<Commons Logging>>> system properties through JVM process arguments at the
- start up.
-
- * Enable header wire + context logging - <<Best for Debugging>>
-
---------------------------------------
--Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog
--Dorg.apache.commons.logging.simplelog.showdatetime=true
--Dorg.apache.commons.logging.simplelog.log.org.apache.http=DEBUG
--Dorg.apache.commons.logging.simplelog.log.org.apache.http.wire=ERROR
---------------------------------------
-
- * Enable full wire + context logging
-
---------------------------------------
--Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog
--Dorg.apache.commons.logging.simplelog.showdatetime=true
--Dorg.apache.commons.logging.simplelog.log.org.apache.http=DEBUG
---------------------------------------
-
- * Enable context logging for connection management
-
---------------------------------------
--Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog
--Dorg.apache.commons.logging.simplelog.showdatetime=true
--Dorg.apache.commons.logging.simplelog.log.org.apache.http.impl.conn=DEBUG
---------------------------------------
-
- * Enable context logging for connection management / request execution
-
---------------------------------------
--Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog
--Dorg.apache.commons.logging.simplelog.showdatetime=true
--Dorg.apache.commons.logging.simplelog.log.org.apache.http.impl.conn=DEBUG
--Dorg.apache.commons.logging.simplelog.log.org.apache.http.impl.client=DEBUG
--Dorg.apache.commons.logging.simplelog.log.org.apache.http.client=DEBUG
---------------------------------------
-
-** {Log4j Examples}
-
- The simplest way to configure <<<Log4j>>> is via a <<<log4j.properties>>> file. <<<Log4j>>>
- will automatically read and configure itself using a file named <<<log4j.properties>>> when
- it's present at the root of the application classpath. Below are some <<<Log4j>>> configuration
- examples.
-
- <<Note:>> <<<Log4j>>> is not included in the <<<HttpClient>>> distribution.
-
- * Enable header wire + context logging - <<Best for Debugging>>
-
---------------------------------------
-log4j.rootLogger=INFO, stdout
-
-log4j.appender.stdout=org.apache.log4j.ConsoleAppender
-log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
-log4j.appender.stdout.layout.ConversionPattern=%5p [%c] %m%n
-
-log4j.logger.org.apache.http=DEBUG
-log4j.logger.org.apache.http.wire=ERROR
---------------------------------------
-
- * Enable full wire + context logging
-
---------------------------------------
-log4j.rootLogger=INFO, stdout
-
-log4j.appender.stdout=org.apache.log4j.ConsoleAppender
-log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
-log4j.appender.stdout.layout.ConversionPattern=%5p [%c] %m%n
-
-log4j.logger.org.apache.http=DEBUG
---------------------------------------
-
- * Enable context logging for connection management
-
---------------------------------------
-log4j.rootLogger=INFO, stdout
-
-log4j.appender.stdout=org.apache.log4j.ConsoleAppender
-log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
-log4j.appender.stdout.layout.ConversionPattern=%5p [%c] %m%n
-
-log4j.logger.org.apache.http.impl.conn=DEBUG
---------------------------------------
-
- * Enable context logging for connection management / request execution
-
---------------------------------------
-log4j.rootLogger=INFO, stdout
-
-log4j.appender.stdout=org.apache.log4j.ConsoleAppender
-log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
-log4j.appender.stdout.layout.ConversionPattern=%5p [%c] %m%n
-
-log4j.logger.org.apache.http.impl.conn=DEBUG
-log4j.logger.org.apache.http.impl.client=DEBUG
-log4j.logger.org.apache.http.client=DEBUG
---------------------------------------
-
- []
-
- Note that the default configuration for Log4J is very inefficient as it causes all the logging
- information to be generated but not actually sent anywhere. The <<<Log4J>>> manual is the
- best reference for how to configure <<<Log4J>>>. It is available at
- {{{http://logging.apache.org/log4j/docs/manual.html}
- http://logging.apache.org/log4j/docs/manual.html}}.
-
-** {java.util.logging Examples}
-
- Since JDK 1.4 there has been a package
- {{{http://docs.oracle.com/javase/7/docs/api/java/util/logging/package-summary.html}
- java.util.logging}} that provides a logging framework similar to <<<Log4J>>>. By default it
- reads a config file from <<<$JAVA_HOME/jre/lib/logging.properties>>> which looks like this
- (comments stripped):
-
---------------------------------------
-handlers=java.util.logging.ConsoleHandler
-.level=INFO
-java.util.logging.FileHandler.pattern = %h/java%u.log
-java.util.logging.FileHandler.limit = 50000
-java.util.logging.FileHandler.count = 1
-java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter
-java.util.logging.ConsoleHandler.level = INFO
-java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
-com.xyz.foo.level = SEVERE
---------------------------------------
-
- To customize logging a custom <<<logging.properties>>> file should be created in the project
- directory. The location of this file must be passed to the JVM as asystem property. This can be
- done on the command line like so:
-
---------------------------------------
-$JAVA_HOME/java -Djava.util.logging.config.file=$HOME/myapp/logging.properties
--classpath $HOME/myapp/target/classes com.myapp.Main
---------------------------------------
-
- Alternatively {{{http://docs.oracle.com/javase/7/docs/api/java/util/logging/LogManager.html#readConfiguration(java.io.InputStream)"}
- LogManager#readConfiguration(InputStream)}} can be used to pass it the desired configuration.
-
- * Enable header wire + context logging - <<Best for Debugging>>
-
---------------------------------------
-.level = INFO
-
-handlers=java.util.logging.ConsoleHandler
-java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
-java.util.logging.ConsoleHandler.level = ALL
-
-org.apache.http.level = FINEST
-org.apache.http.wire.level = SEVERE
---------------------------------------
-
- * Enable full wire + context logging
-
---------------------------------------
-.level = INFO
-
-handlers=java.util.logging.ConsoleHandler
-java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
-java.util.logging.ConsoleHandler.level = ALL
-
-org.apache.http.level = FINEST
---------------------------------------
-
- * Enable context logging for connection management
-
---------------------------------------
-.level = INFO
-
-handlers=java.util.logging.ConsoleHandler
-java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
-java.util.logging.ConsoleHandler.level = ALL
-
-org.apache.http.impl.conn.level = FINEST
---------------------------------------
-
- * Enable context logging for connection management / request execution
-
---------------------------------------
-.level = INFO
-
-handlers=java.util.logging.ConsoleHandler
-java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
-java.util.logging.ConsoleHandler.level = ALL
-
-org.apache.http.impl.conn.level = FINEST
-org.apache.http.impl.client.level = FINEST
-org.apache.http.client.level = FINEST
---------------------------------------
-
- []
-
- More detailed information is available from the
- {{{http://docs.oracle.com/javase/7/docs/technotes/guides/logging/overview.html}
- Java Logging documentation}}.
diff --git a/src/site/apt/httpcomponents-client-4.3.x/ntlm.apt b/src/site/apt/httpcomponents-client-4.3.x/ntlm.apt
deleted file mode 100644
index e669d5c..0000000
--- a/src/site/apt/httpcomponents-client-4.3.x/ntlm.apt
+++ /dev/null
@@ -1,162 +0,0 @@
-~~ ====================================================================
-~~ 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/>.
-
- ----------
- NTLM support in HttpClient
- ----------
- ----------
- ----------
-
-NTLM support in HttpClient
-
-* {Background}
-
- NTLM is a proprietary authentication scheme developed by Microsoft and optimized for
- Windows operating system.
-
- Until year 2008 there was no official, publicly available, complete documentation of
- the protocol. {{{http://davenport.sourceforge.net/ntlm.html}Unofficial}} 3rd party
- protocol descriptions existed as a result of reverse-engineering efforts. It was not
- really known whether the protocol based on the reverse-engineering were complete or
- even correct.
-
- Microsoft published {{{http://download.microsoft.com/download/a/e/6/ae6e4142-aa58-45c6-8dcf-a657e5900cd3/%5BMS-NLMP%5D.pdf}MS-NLMP}}
- and {{{http://download.microsoft.com/download/a/e/6/ae6e4142-aa58-45c6-8dcf-a657e5900cd3/%5BMS-NTHT%5D.pdf}MS-NTHT}}
- specifications in February 2008 as a part of its
- {{{http://www.microsoft.com/interop/principles/default.mspx}Interoperability
- Principles initiative}}.
-
- HttpClient as of version 4.1 initially supported NTLMv1, NTLMv2, and NTLM2SessionResponse
- authentication protocols, based on the reverse engineering approach. As of version
- 4.2.3, HttpClient now supports a more correct implementation, based in large part on
- Microsoft's own specifications. This is expected to correct a number of problems, especially
- since Microsoft (as of Windows Server 2008 R2) began using a new implementation of its
- protocols. This new Microsoft implementation has led to authentication failures in some
- cases from some of the older reverse-engineered client implementations of NTLM.
-
- The new HttpClient NTLM implementation is known to have been tried successfully against
- at least the following systems:
-
- * Windows Server 2000 and Server 2003 systems, configured to use LM and NTLMv1 authentication
-
- * Windows Server 2003 systems, configured to use NTLMv2 authentication
-
- * Windows Server 2008 R2 systems, configured to use NTLM2SessionResponse authentication
-
- []
-
- If the current HttpClient NTLM implementation should prove problematic in your environment,
- we'd definitely like to hear about it. You are also welcome to try an alternative NTLM
- implementation, should it seem necessary. One can also use {{{http://jcifs.samba.org/}JCIFS}},
- which includes an NTLM engine developed by members of the Samba project.
-
-* {Using Samba JCIFS as an alternative NTLM engine}
-
- Follow these instructions to build an NTLMEngine implementation using JCIFS library
-
- <<Disclaimer: Use code at your own discretion. Do NOT report any issues related to
- the use of JCIFS library to Apache HttpComponents project>>.
-
- * Download version 1.3.14 or newer of the JCIFS library from the
- {{{http://jcifs.samba.org/}Samba}} web site
-
- * Implement NTLMEngine interface
-
-----------------------------------------
-import java.io.IOException;
-
-import jcifs.ntlmssp.NtlmFlags;
-import jcifs.ntlmssp.Type1Message;
-import jcifs.ntlmssp.Type2Message;
-import jcifs.ntlmssp.Type3Message;
-import jcifs.util.Base64;
-
-import org.apache.http.impl.auth.NTLMEngine;
-import org.apache.http.impl.auth.NTLMEngineException;
-
-public final class JCIFSEngine implements NTLMEngine {
-
- private static final int TYPE_1_FLAGS =
- NtlmFlags.NTLMSSP_NEGOTIATE_56 |
- NtlmFlags.NTLMSSP_NEGOTIATE_128 |
- NtlmFlags.NTLMSSP_NEGOTIATE_NTLM2 |
- NtlmFlags.NTLMSSP_NEGOTIATE_ALWAYS_SIGN |
- NtlmFlags.NTLMSSP_REQUEST_TARGET;
-
- public String generateType1Msg(final String domain, final String workstation)
- throws NTLMEngineException {
- final Type1Message type1Message = new Type1Message(TYPE_1_FLAGS, domain, workstation);
- return Base64.encode(type1Message.toByteArray());
- }
-
- public String generateType3Msg(final String username, final String password,
- final String domain, final String workstation, final String challenge)
- throws NTLMEngineException {
- Type2Message type2Message;
- try {
- type2Message = new Type2Message(Base64.decode(challenge));
- } catch (final IOException exception) {
- throw new NTLMEngineException("Invalid NTLM type 2 message", exception);
- }
- final int type2Flags = type2Message.getFlags();
- final int type3Flags = type2Flags
- & (0xffffffff ^ (NtlmFlags.NTLMSSP_TARGET_TYPE_DOMAIN | NtlmFlags.NTLMSSP_TARGET_TYPE_SERVER));
- final Type3Message type3Message = new Type3Message(type2Message, password, domain,
- username, workstation, type3Flags);
- return Base64.encode(type3Message.toByteArray());
- }
-
-}
-----------------------------------------
-
- * Implement AuthSchemeProvider interface
-
-----------------------------------------
-public class JCIFSNTLMSchemeFactory implements AuthSchemeProvider {
-
- public AuthScheme create(final HttpContext context) {
- return new NTLMScheme(new JCIFSEngine());
- }
-}
-----------------------------------------
-
- * Register NTLMSchemeFactory with the HttpClient instance you want to NTLM
- enable.
-
-----------------------------------------
-Registry<AuthSchemeProvider> authSchemeRegistry = RegistryBuilder.<AuthSchemeProvider>create()
- .register(AuthSchemes.NTLM, new JCIFSNTLMSchemeFactory())
- .register(AuthSchemes.BASIC, new BasicSchemeFactory())
- .register(AuthSchemes.DIGEST, new DigestSchemeFactory())
- .register(AuthSchemes.SPNEGO, new SPNegoSchemeFactory())
- .register(AuthSchemes.KERBEROS, new KerberosSchemeFactory())
- .build();
-CloseableHttpClient httpClient = HttpClients.custom()
- .setDefaultAuthSchemeRegistry(authSchemeRegistry)
- .build();
-----------------------------------------
-
- * Set NTCredentials for the web server you are going to access.
-
-
diff --git a/src/site/apt/httpcomponents-client-4.3.x/primer.apt b/src/site/apt/httpcomponents-client-4.3.x/primer.apt
deleted file mode 100644
index cebcd5f..0000000
--- a/src/site/apt/httpcomponents-client-4.3.x/primer.apt
+++ /dev/null
@@ -1,631 +0,0 @@
-~~ ====================================================================
-~~ 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/>.
-
- ----------
- Client HTTP Programming Primer
- ----------
- ----------
- ----------
-
-Client HTTP Programming Primer
-
-* {About}
-
- This document is intended for people who suddenly have to or want to implement
- an application that automates something usually done with a browser,
- but are missing the background to understand what they actually need to do.
- It provides guidance on the steps required to implement a program that
- interacts with a web site which is designed to be used with a browser.
- It does not save you from eventually learning the background of what
- you are doing, but it should help you to get started quickly and learn
- the details later.
-
- This document has evolved from discussions on the HttpClient mailing lists.
- Although it refers to HttpClient, the concepts described here apply equally
- to HttpComponents or Java's {{{http://docs.oracle.com/javase/7/docs/api/java/net/HttpURLConnection.html}HttpURLConnection}}
- or any other HTTP communication library for any programming language. So you
- might find it useful even if you're not using Java and HttpClient.
-
- The existence of this document does not imply that the HttpClient community
- feels responsible for teaching you how to program a client HTTP application.
- It is merely a way for us to reduce the noise on the mailing list without
- just leaving the newbies out in the cold.
-
-* {Scenario}
-
- Let's assume that you have some kind of repetitive, web-based task that
- you want to automate. Something like:
-
- * goto page http://xxx.yyy.zzz/login.html
-
- * enter username and password in a web form and hit the "login" button
-
- * navigate to a specific page
-
- * check the number/headline/whatever shown on that page
-
- []
-
- At this time, we don't have a specific example which could be developed
- into a sample application. So this document is all bla-bla, and you will
- have to work out the details - all the details - yourself. Such is life.
-
-* {Caveat}
-
- This scenario describes a hobbyist usage of HTTP, in other words:
- <<a bad practice>>. Web sites are designed for user interaction, not
- as an application programming interface (API). The interface of a
- web site is the user interface displayed by a browser. The HTTP
- communication between the browser and the server is an internal API,
- subject to change without notice.
-
- A web site can be redesigned at any point in time. The server then
- sends different documents and a browser will display the new content.
- The user easily adjusts to click the appropriate links, and the browser
- communicates via HTTP as specified by the new documents from the server.
- Your application that only mimicks a browser will simply break.
-
- Nevertheless, implementing this scenario will help you to get
- familiar with HTTP communication. It is also "good enough" for
- hobbyists applications, for example if you want to download the
- latest installment of your favorite daily webcomic to install
- it as the screen background. There is no big damage if such an
- application breaks.
-
- If you want to implement a solid application, you should use only
- published APIs. For example, to check for new mail on your webmail
- account, you should ask the webmail provider for POP or IMAP access.
- These are standardized protocols supported my most EMail client applications.
- If you want to have a newsticker, look for RSS feeds from the provider and
- applications that display them.
-
- As another example, if you want to perform a web search, there are
- search companies that provide an API for using their search engines.
- Unlike the examples before, such APIs are proprietary. You will still
- have to implement an application, but then you are using a published API
- that the provider will not change without notice.
-
-
-* {Not a Browser}
-
- HttpClient is not a browser. It is an HTTP communication library
- and as such it provides only a subset of functions expected from
- a common browser application. The most fundamental difference is
- absence of user interface in HttpClient. The browser needs a rendering
- engine to display pages, and to interpret user input such as mouse clicks
- somewhere on the displayed page. There is a layout engine which computes
- how an HTML page should be displayed, including cascading style sheets
- and images. A JavaScript interpreter runs JavaScript code embedded in
- or referenced from HTML pages. Events from the user interface are passed
- to the JavaScript interpreter for processing. On top of that, there are
- interfaces for plugins that can handle Applets, embedded media objects
- like PDF files, Quicktime movies and Flash animations, or ActiveX
- controls that can do anything. HttpClient can only be used
- programmatically through its APIs to transmit and receive HTTP messages.
- HttpClient is also completely content agnostic. It can transfer message
- content but it is unable to render or process it in any fashion.
-
- Another major difference is tolerance for bad input or HTTP standard
- violations. There needs to be tolerance for invalid user input to make
- the browser user friendly. There also needs to be tolerance for malformed
- documents retrieved from servers, and for flaws in server behavior when
- executing protocols, to make as many websites as possible accessible to
- the user. HttpClient is however strives to adhere to the HTTP standard
- specification and related standards as close and as possible by default.
- It also provides means to relaxing some of the restrictions imposed
- by the specification where permissible or required for compatibility
- with non-compliant HTTP origin or proxy servers.
-
-* {Terminology}
-
- This section introduces some important terms you have to know to
- understand the rest of this document.
-
- <<<{HTTP Message}>>>
-
- consists of a header section and an optional entity. There are two kinds
- of messages, requests and responses. They differ in the format of the
- first line, but both can have header fields and an optional entity.
-
- <<<{HTTP Request}>>>
-
- is sent from a client to a server. The first line includes the URI for
- which the request is sent, and a method that the server should execute
- for the client.
-
- <<<{HTTP Response}>>>
-
- is sent from a server to a client in response to a request. The first
- line includes a status code that tells about success or failure of
- the request. HTTP defines a set of status codes, like 200 for success
- and 404 for not found. Other protocols based on HTTP can define
- additional status codes.
-
- <<<{Method}>>>
-
- is an operation requested from the server. HTTP defines a set of
- operations, the most frequent being GET and POST. Other protocols
- based on HTTP can define additional methods.
-
- <<<{Header Fields}>>>
-
- are name-value pairs, where both name and value are text. The name of
- a header field is not case sensitive. Multiple values can be assigned
- to the same name. RFC 2616 defines a wide range
- of header fields for handling various aspects of the HTTP protocol.
- Other specifications, like RFC 2617 and RFC 2965, define additional
- headers. Some of the defined headers are for general use, others are
- meant for exclusive use with either requests or responses, still others
- are meant for use only with an entity.
-
- <<<{Entity}>>>
-
- is data sent with an HTTP message. For example, a response can contain
- the page or image you are downloading as an entity, or a request can
- include the parameters that you entered into a web form.
- The entity of an HTTP message can have an arbitrary data format, which
- is usually specified as a MIME type in a header field.
-
- <<<{Session}>>>
-
- is a series of requests from a single source to a server. The server
- can keep session data, and needs to recognize the session to which
- each incoming request belongs. For example, if you execute a web search,
- the server will only return one page of search results. But it keeps
- track of the other results and makes them available when you click on
- the link to the "next" page. The server needs to know from the request
- that it is you and your session for which more results are requested,
- and not me and my session. That's because I searched for something else.
-
- <<<{Cookies}>>>
-
- are the preferred way for servers to track sessions. The server supplies
- a piece of data, called a cookie, in response to a request. The server
- expects the client to send that piece of data in a header field with each
- following request of the same session.
- The cookie is different for each session, so the server can identify to
- which session a request belongs by looking at the cookie. If the cookie
- is missing from a request, the server will not respond as expected.
-
-* {Step by Step}
-
-** {GET the Login Page}
-
- Create and execute a GET request for the login page.
- Just use the link you would type into the browser as the URL.
- This is what a browser does when you enter a URL in the address bar
- or when you click on a link that points to another web page.
-
- Inspect the response from the server:
-
- * do you get the page you expected?
-
- []
-
- It should be sent as the entity of the response to your request.
- The entity is also referred to as the response body.
-
- * do you get a session cookie?
-
- []
-
- Cookies are sent in a header field named Set-Cookie or Set-Cookie2.
- It is possible that you don't get a session cookie until you log in.
- If there is no session cookie in the response, you'll have to do perform
- step 2 later, after you reach the point where the cookie is set.
-
- If you do not get the page you expect, check the URL you are requesting.
- If it is correct, the server may use a browser detection. You will have
- to set the header field User-Agent to a value used by a popular browser
- to pretend that the request is coming from that browser.
-
- If you can't get the login page, get the home page instead now.
- Get the login page in the next step, when you establish the session.
-
-** {Establish the Session}
-
- Create and execute another GET request for a page.
- You can simply request the login page again, or some other page
- of which you know the URL. Do NOT try to get a page which would
- be returned in response to submitting a web form. Use something
- you can reach simply by clicking on a link in the browser. Something
- where you can see the URL in the browser status line while the
- mouse pointer is hovering over the link.
-
- This step is important when developing the application. Once you know
- that your application does establish the session correctly, you may
- be able to remove it. Only if you couldn't get the login page directly
- and had to get the home page first, you know you have to leave it in.
-
- Inspect the request being sent to the server.
-
- * is the session cookie sent with the request?
-
- []
-
- You can see what is sent to the server by enabling the wire log
- for HttpClient. You only need to see the request headers, not the body.
- The session cookie should be sent in a header field called Cookie.
- There may be several of those, and other cookies might be sent as well.
-
- Inspect the response from the server:
-
- * do you get another session cookie?
-
- []
-
- You should not get another session cookie. If you get the same session
- cookie as before, the server behaves a little strange but that should
- not be a problem. If you get a new session cookie, then the server did
- not recognize the session for the request. Usually, this happens if the
- request did not contain the session cookie. But servers might use other
- means to track sessions, or to detect session hijacking.
-
- If the session cookie is not sent in the request, one of two things
- has gone wrong. Either the cookie was not detected in the previous
- response, or the cookie was not selected for being sent with the new
- request.
-
- HttpClient automatically parses cookies sent in responses and puts them
- into a cookie store. HttpClient uses a configurable cookie policy
- to decide whether a cookie being sent from a server is correct.
- The default policy complies strictly with RFC 2109, but many servers
- do not. Play around with the cookie policies until the cookie is
- accepted and put into the cookie store.
-
- If the cookie is accepted from the previous response but still not
- sent with the new request, make sure that HttpClient uses the same
- cookie store object. Unless you explicitly manage cookie store
- objects (not recommended for newbies!), this will be the case if you
- use the same HttpClient object to execute both requests.
-
- If the cookie is still not sent with the request, make sure that the
- URL you are requesting is in the scope for the cookie. Cookies are
- only sent to the domain and path specified in the cookie scope.
- A cookie for host "jakarta.apache.org" will not be sent to host
- "tomcat.apache.org". A cookie for domain ".apache.org" will be sent
- to both. A cookie for host "apache.org", without the leading dot,
- will not be sent to "jakarta.apache.org". The latter case can be
- resolved by using a different cookie spec that adds the leading dot.
- In the other cases, use a URL that in the cookie scope to establish
- the session.
-
- If the session cookie is sent with the request, but a new session cookie
- is set in the response anyway, check whether there are cookies other
- than the session cookie in the request. Some servers are incapable of
- detecting multiple cookies sent in individual header fields. HttpClient
- can be advised to put all cookies into a single header field.
-
- If that doesn't help, you are in trouble. The server may use additional
- means to track the session, for example the header field named Referer.
- Set that field to the URL of the previous request.
- ({{{http://mail-archives.apache.org/mod_mbox/jakarta-httpclient-user/200602.mbox/%3c19b.44e04b45.31166eaa@aol.com%3e}see this mail}})
-
- If that doesn't help either, you will have to compare the request from
- your application to a corresponding one generated by a browser. The
- instructions in step 5 for POST requests apply for GET requests as well.
- It's even simpler with GET, since you don't have an entity.
-
-** {Analyze the Form}
-
- Now it is time to analyze the form defined in the HTML markup of the page.
- A form in HTML is a set of name-value-pairs called parameters, where some
- of the values can be entered in the browser. By analyzing the HTML markup,
- you can learn which parameters you have to define and how to send them
- to the server.
-
- Look for the <form> tag in the page source. There may be several forms in
- the page, but they can not be nested. Locate the form you want to submit.
- Locate the matching </form> tag. Everything in between the two may be
- relevant. Let's start with the {attributes of the <form> tag}:
-
- <<<{method}=>>>
-
- specifies the method used for submitting the form. If it is GET or
- not specified at all, then you need to create a GET request. The parameters
- will be added as a query string to the URL. If the method is POST, you
- need to create a POST request. The parameters will be put in the entity
- of the request, also referred to as the request body.
- How to do that is discussed in step 5.
-
- <<<{action}=>>>
-
- specifies the URL to which the request has to be sent. Do not try to
- get this URL from the address bar of your browser! A browser will
- automatically follow redirects and only displays the final URL, which
- can be different from the URL in this attribute.
- It is possible that the URL includes a query string that specifies
- some parameters. If so, keep that in mind.
-
- <<<{enctype}=>>>
-
- specifies the MIME type for the entity of the request generated by the
- form. The two common cases are url-encoded (default) and multipart-mime.
- Note that these terms are just informally used here, the exact values
- that need to be written in an HTML document are specified elsewhere.
- This attribute is only used for the POST method. If the method is GET,
- the parameters will always be url-encoded, but not in an entity.
-
- <<<{accept-charset}=>>>
-
- specifies the character set that the browser should allow for user input.
- It will not be discussed here, but you will have to consider this value
- if you experience charset related problems.
-
- Except for optional query parameters in the action attribute, the parameters
- of a form are specified by HTML tags between <form> and </form>.
- The following is a list of tags that can be used to define parameters.
- Except where stated otherwise, they have a name attribute which specifies
- the name of the parameter. The value of the parameter usually depends on
- user input.
-
-----------------------------------------
-<input type="text" name="...">
-<input type="password" name="...">
-----------------------------------------
-
- specify single-line input fields. Using the return key in one of these
- fields will submit the form, so the value really is a single line of
- input from the user.
-
-----------------------------------------
-<input type="text" readonly name="..." value="...">
-<input type="hidden" name="..." value="...">
-----------------------------------------
-
- specify a parameter that can not be changed by the user.
- The value of the parameter is given by the value attribute.
-
-----------------------------------------
-<input type="radio" name="..." value="...">
-<input type="checkbox" name="..." value="...">
-----------------------------------------
-
- specify a parameter that can be included or omitted. There usually is
- more than one tag with the same name. For radio buttons, only one can
- be selected and the value of the parameter is the value of the selected
- radio button. For checkboxes, more than one can be selected. There will
- be one name-value-pair for each selected checkbox, with the same name
- for all of them.
-
-----------------------------------------
-<input type="submit" name="..." value="...">
-<button type="submit" name="..." value="...">
-----------------------------------------
-
- specify a button to submit the form. The parameter will only be added
- to the form if that button is used to submit. If another button is used,
- or the form is submitted by pressing the return key in a text input field,
- the parameter is not part of the submitted form data. If the name attribute
- is missing, no parameter is added to the form data for that button.
-
-----------------------------------------
-<textarea name="...">
-<textarea value="..." readonly>
-----------------------------------------
-
- specify a multi-line input field. In the readonly case, the value of
- the parameter is the text between the <textarea> and </textarea> tags.
-
-----------------------------------------
-<select name="..." multiple>}}}
- <option value="...">...</option>}}}
- <option value="...">...</option>}}}
- ...
-</select>
-----------------------------------------
-
- specify a selection list or drop-down menu. If the multiple attribute is
- not present, only one option can be selected. There will be one
- name-value-pair for each selected option, with the same name for all of them.
- If there is no value attribute, the value for that option is
- the text between <option> and </option>.
-
-----------------------------------------
-<input type="image" name="...">
-----------------------------------------
-
- specifies an image that can be clicked to submit the form. If that image
- is clicked to submit the form, two parameters are added to the form data.
- The name attribute is suffixed with ".x" and ".y", the values for the
- parameters are the relative coordinates of the mouse pointer within the
- image at the time of the click, in pixel. If the name attribute is missing,
- no parameters will be added to the form data.
-
-----------------------------------------
-<input type="file" name="...">
-----------------------------------------
-
- specifies a file selection box. The user can select a file that should
- be sent as part of the form data. This is only possible if the encoding
- is multipart-mime. Unlike other parameters, the file is not mapped to a
- simple name-value-pair. File upload is not a topic for beginners.
-
- These tags are used to define parameters in static HTML. With dynamic HTML,
- in particular JavaScript, the parameter values can be changed before the
- form is submitted. If that is the case, you are in trouble. Learn JavaScript,
- analyze the code that is executed, and modify your application to match
- that behavior.
-
-
-** {Analyze the Form, Again}
-
- After you have determined the action URL and name-value-pairs of
- a form, you should exit the program you used to get the HTML source,
- start it again and repeat the analysis with the new page.
-
- Most parameters will be the same for both pages. But some parameters,
- in particular those from hidden input fields, may change from session
- to session, or even with every request. The same can be the case with
- the action URL.
-
- Parameters that remain the same can be hard-coded in your program.
- If parameters change (except for user input), then your application
- has to request the page with the form and extract the dynamic parameters
- at runtime. If you're lucky you can locate them by simple string searches.
- If you're unlucky, you need an HTML parser to make sense of the page.
- HTML parsing is out of scope for HttpClient, but you'll find some
- HTML parsers mentioned in the mailing list archives.
-
- Note that a redesign of the form on the server can break your application
- at any time. Whenever that happens, you have to repeat the analysis with
- the new form returned by the server after the redesign, and adjust your
- application accordingly.
-
-
-** {POST the Form}
-
- After analyzing the form, it is time to create a request that matches
- what a browser would generate. If the method is GET, just add the
- name-value-pairs for all parameters to the query string. If the method
- is POST, things are a little more complicated.
-
- It depends on the server how closely you have to match browser behavior.
- For example, a servlet will not distinguish between parameters in the
- query string and url-encoded parameters of the entity. But other server
- side code might make that distinction. The safe way is always to match
- browser behavior exactly.
-
- HttpClient supports both encoding types, url-encoded and multipart-mime.
- To send parameters url-encoded, use the POST request and add the parameters
- directly there. To send parameters in multipart-mime, collect the parameters
- in a multipart-encoded request entity and add set the entity for the
- POST request. You will also find support for file upload in the multipart
- package. Note that these techniques are mutually exclusive, they can not be
- combined. Parameters defined in the query string of the URL can remain there.
-
- Send the request. Inspect the response from the server:
-
- * do you get a status code 303 or 307?
-
- []
-
- That is called a redirect. Follow redirects to the ultimate page
- and inspect that response. See step 6 on following redirects.
-
- * do you get the page you expected?
-
- []
-
- If the server response to your POST request indicates a problem,
- try to enable or disable the expect-continue handshake, or switch
- the protocol version to HTTP/1.0. If that doesn't help...
-
- Inspect the request you are sending:
-
- * are there significant differences to the request of a browser?
-
- []
-
- There is a variety of sniffer programs you can use to grep the
- browser request. Some of them are mentioned in the responses
- to {{{http://mail-archives.apache.org/mod_mbox/jakarta-httpclient-user/200603.mbox/%3c981224FF5B88B349B7C1FED584D2620E02A2CBB2@CORPUSMX50B.corp.emc.com%3e this question}on the mailing list}}.
-
- Candidates for problems are missing or wrong parameters, and differences
- in the header fields. The parameters are all up to you. As a general rule
- for the header fields, you should send the same as the browser does. The
- order of the fields does not matter.
-
- But there's a caveat: some header fields are controlled by HttpClient and
- can not be set explicitly. Other header fields are used to indicate
- capabilities which a browser has, but your application probably has not.
- For these, the request from your application has to and should differ.
- Here is a possibly incomplete {list of headers that need special consideration}:
-
- <<<{Host}:>>>
-
- controlled by HttpClient. The value is usually obtained from the URL
- you are posting to. It is possible to set a different value, called
- a "virtual host".
-
- <<<{Content-Type}:>>>
-
- <<<{Content-Length}:>>>
-
- <<<{Transfer-Encoding}:>>>
-
- controlled by HttpClient. The values are obtained from the request entity.
-
- <<<{Connection}:>>>
-
- usually controlled by HttpClient to handle connection keep-alive.
- Leave it alone or set the value to "close".
-
- <<<{Content-Encoding}:>>>
-
- used to indicate the capability to process compressed responses.
- Do not set this, unless you are prepared to implement decompression.
-
-** {Follow Redirects}
-
- It is quite common for servers to respond with a 303 or 307 status code
- to a POST request. These redirects indicate that your application has to
- send another request to retrieve the actual result of the operation you
- have triggered with the POST request.
-
- HttpClient can be configured to follow some redirects automatically.
- Others it is not allowed to follow automatically, since RFC 2616 specifies
- that a user interaction should take place. We will make sure that HttpClient
- is compliant with this requirement, but we can't stop you from implementing
- a different behavior in your application. The Location header field in the
- redirect response indicates the URL from which to fetch the actual page.
- It is common practice that servers return a relative URL as the location,
- although the specification requires an absolute URL.
-
- Note that there may be more than one redirect in succession. Your
- application then has to follow the redirect for a redirect, but make sure
- that you do not enter an infinite loop. If you find that there are more
- than two redirects in succession, something probably is fishy.
-
-
-** {Logout}
-
- Your application can send as many GET and POST requests and follow as many
- redirects as is required. But you should remember that there is a session
- tracked by the server. Once your application is done, and if the web site
- does provide a logout link, you should send a final request to log out.
- This will tell the server that the session data can be discarded. If the
- server prevents multiple logins with the same user ID and your application
- has to run repeatedly, logout may even be required.
-
-* {Further Reading}
-
- ReferenceMaterials: a list of technical specifications for HTTP and related
- stuff.
-
- * {{{http://www.w3.org/TR/html4/interact/forms.html} HTML 4.01 Specification,
- Section on Forms}}: Includes how browsers have to generate the data to submit
- to the server.
-
- * {{{https://digital.com/tools/html-cheatsheet/} Giving Form to Forms}}:
- Explains how to define HTML forms and what is submitted to the server.
- Probably easier to digest than the HTML 4.01 Specification.
-
- * {{{http://jakarta.apache.org/commons/fileupload/} Commons File Upload}}:
- Server-side library for parsing multipart requests.
-
- * {{{http://www.cs.tut.fi/~jkorpela/forms/file.html} Tutorial on File Upload
- in HTML}}
-
- []
diff --git a/src/site/apt/httpcomponents-client-4.3.x/quickstart.apt b/src/site/apt/httpcomponents-client-4.3.x/quickstart.apt
deleted file mode 100644
index b5974de..0000000
--- a/src/site/apt/httpcomponents-client-4.3.x/quickstart.apt
+++ /dev/null
@@ -1,114 +0,0 @@
-~~ ====================================================================
-~~ 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/>.
-
- ----------
- HttpClient Quick Start
- ----------
- ----------
- ----------
-
-HttpClient Quick Start
-
- [[1]] Download 'Binary' package of the latest HttpClient 4.3 release or configure
- dependency on {{{./httpclient/dependency-info.html}HttpClient}} and
- {{{./fluent-hc/dependency-info.html}Fluent HC}} modules using a dependency manager of your
- choice as described {{{./download.html}here}}.
-
- [[1]] HttpClient 4.3 requires Java 1.5 or newer.
-
- [[1]] The below code fragment illustrates the execution of HTTP GET and POST requests using
- the HttpClient native API.
-
--------------
-
-CloseableHttpClient httpclient = HttpClients.createDefault();
-HttpGet httpGet = new HttpGet("http://targethost/homepage");
-CloseableHttpResponse response1 = httpclient.execute(httpGet);
-// The underlying HTTP connection is still held by the response object
-// to allow the response content to be streamed directly from the network socket.
-// In order to ensure correct deallocation of system resources
-// the user MUST call CloseableHttpResponse#close() from a finally clause.
-// Please note that if response content is not fully consumed the underlying
-// connection cannot be safely re-used and will be shut down and discarded
-// by the connection manager.
-try {
- System.out.println(response1.getStatusLine());
- HttpEntity entity1 = response1.getEntity();
- // do something useful with the response body
- // and ensure it is fully consumed
- EntityUtils.consume(entity1);
-} finally {
- response1.close();
-}
-
-HttpPost httpPost = new HttpPost("http://targethost/login");
-List <NameValuePair> nvps = new ArrayList <NameValuePair>();
-nvps.add(new BasicNameValuePair("username", "vip"));
-nvps.add(new BasicNameValuePair("password", "secret"));
-httpPost.setEntity(new UrlEncodedFormEntity(nvps));
-CloseableHttpResponse response2 = httpclient.execute(httpPost);
-
-try {
- System.out.println(response2.getStatusLine());
- HttpEntity entity2 = response2.getEntity();
- // do something useful with the response body
- // and ensure it is fully consumed
- EntityUtils.consume(entity2);
-} finally {
- response2.close();
-}
--------------
-
- Source can be downloaded
- {{{./httpclient/examples/org/apache/http/examples/client/QuickStart.java}here}}
-
- [[1]] The same requests can be executed using a simpler, albeit less flexible, fluent API.
-
--------------
-
-// The fluent API relieves the user from having to deal with manual deallocation of system
-// resources at the cost of having to buffer response content in memory in some cases.
-
-Request.Get("http://targethost/homepage")
- .execute().returnContent();
-Request.Post("http://targethost/login")
- .bodyForm(Form.form().add("username", "vip").add("password", "secret").build())
- .execute().returnContent();
-
--------------
-
- Source can be downloaded
- {{{./fluent-hc/examples/org/apache/http/client/fluent/FluentQuickStart.java}here}}
-
- [[1]] {{{./examples.html}HttpClient Examples}} - a set of examples demonstrating some of
- the more complex behavior.
-
- [[1]] {{{./tutorial/html/index.html}HttpClient Tutorial}} - gives a detailed examination of the
- HttpClient API, which was written in close accordance with the (sometimes not very intuitive)
- HTTP specification/standard. A copy is also shipped with the release.
- {{{./tutorial/pdf/httpclient-tutorial.pdf}A PDF version}} is also available
-
- [[1]] {{{./primer.html}HttpClient Primer}} - explains the scope of HttpClient.
- Note that HttpClient is not a browser. It lacks the UI, HTML renderer and a JavaScript engine
- that a browser will possess.