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/02/23 18:05:25 UTC
[httpcomponents-website] branch master updated: Added project mode
for sample code
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
The following commit(s) were added to refs/heads/master by this push:
new 228a8da Added project mode for sample code
228a8da is described below
commit 228a8da4a5c88bc76ced3fb263216785ca24a4d0
Author: Oleg Kalnichevski <ol...@apache.org>
AuthorDate: Tue Feb 23 19:05:02 2021 +0100
Added project mode for sample code
---
pom.xml | 10 ++
samples/pom.xml | 81 +++++++++++
.../hc/client5/http/examples/AsyncQuickStart.java | 148 +++++++++++++++++++++
.../hc/client5/http/examples/QuickStart.java | 79 +++++++++++
.../http/examples/fluent/FluentQuickStart.java | 45 +++++++
.../http/client/fluent/FluentQuickStart.java | 42 ++++++
.../apache/http/examples/client/QuickStart.java | 88 ++++++++++++
7 files changed, 493 insertions(+)
diff --git a/pom.xml b/pom.xml
index 6ebe7e3..85d9fe9 100644
--- a/pom.xml
+++ b/pom.xml
@@ -143,4 +143,14 @@
</plugin>
</plugins>
</build>
+
+ <profiles>
+ <profile>
+ <id>sample-code</id>
+ <modules>
+ <module>samples</module>
+ </modules>
+ </profile>
+ </profiles>
+
</project>
diff --git a/samples/pom.xml b/samples/pom.xml
new file mode 100644
index 0000000..d3392b3
--- /dev/null
+++ b/samples/pom.xml
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ====================================================================
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+ ====================================================================
+
+ This software consists of voluntary contributions made by many
+ individuals on behalf of the Apache Software Foundation. For more
+ information on the Apache Software Foundation, please see
+ <http://www.apache.org />.
+ -->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache.httpcomponents</groupId>
+ <artifactId>website</artifactId>
+ <version>1-SNAPSHOT</version>
+ </parent>
+ <artifactId>website-samples</artifactId>
+ <name>Apache HttpComponents WebSite (sample code)</name>
+ <description>Apache HttpComponents WebSite (sample code)</description>
+ <packaging>jar</packaging>
+
+ <properties>
+ <hc4.client.version>4.5.13</hc4.client.version>
+ <hc5.client.version>5.0.3</hc5.client.version>
+ </properties>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.httpcomponents</groupId>
+ <artifactId>httpclient</artifactId>
+ <version>${hc4.client.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.httpcomponents</groupId>
+ <artifactId>fluent-hc</artifactId>
+ <version>${hc4.client.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.httpcomponents.client5</groupId>
+ <artifactId>httpclient5</artifactId>
+ <version>${hc5.client.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.httpcomponents.client5</groupId>
+ <artifactId>httpclient5-fluent</artifactId>
+ <version>${hc5.client.version}</version>
+ </dependency>
+ </dependencies>
+
+ <reporting>
+ <plugins>
+
+ <plugin>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ </plugin>
+
+ </plugins>
+ </reporting>
+
+</project>
\ No newline at end of file
diff --git a/samples/src/main/java/org/apache/hc/client5/http/examples/AsyncQuickStart.java b/samples/src/main/java/org/apache/hc/client5/http/examples/AsyncQuickStart.java
new file mode 100644
index 0000000..1d7d4fe
--- /dev/null
+++ b/samples/src/main/java/org/apache/hc/client5/http/examples/AsyncQuickStart.java
@@ -0,0 +1,148 @@
+/*
+ * ====================================================================
+ * 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/>.
+ *
+ */
+
+package org.apache.hc.client5.http.examples;
+
+
+import java.io.IOException;
+import java.nio.CharBuffer;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.Future;
+
+import org.apache.hc.client5.http.async.methods.AbstractCharResponseConsumer;
+import org.apache.hc.client5.http.async.methods.SimpleHttpRequest;
+import org.apache.hc.client5.http.async.methods.SimpleHttpRequests;
+import org.apache.hc.client5.http.async.methods.SimpleHttpResponse;
+import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient;
+import org.apache.hc.client5.http.impl.async.HttpAsyncClients;
+import org.apache.hc.core5.concurrent.FutureCallback;
+import org.apache.hc.core5.http.ContentType;
+import org.apache.hc.core5.http.HttpException;
+import org.apache.hc.core5.http.HttpResponse;
+import org.apache.hc.core5.http.nio.AsyncRequestProducer;
+import org.apache.hc.core5.http.nio.support.AsyncRequestBuilder;
+
+public class AsyncQuickStart {
+
+ public static void main (final String[] args) throws Exception {
+ try (final CloseableHttpAsyncClient httpclient = HttpAsyncClients.createDefault()) {
+ // Start the client
+ httpclient.start();
+
+ // Execute request
+ final SimpleHttpRequest request1 = SimpleHttpRequests.get("http://httpbin.org/get");
+ final Future<SimpleHttpResponse> future = httpclient.execute(request1, null);
+ // and wait until response is received
+ final SimpleHttpResponse response1 = future.get();
+ System.out.println(request1.getRequestUri() + "->" + response1.getCode());
+
+ // One most likely would want to use a callback for operation result
+ final CountDownLatch latch1 = new CountDownLatch(1);
+ final SimpleHttpRequest request2 = SimpleHttpRequests.get("http://httpbin.org/get");
+ httpclient.execute(request2, new FutureCallback<SimpleHttpResponse>() {
+
+ @Override
+ public void completed(final SimpleHttpResponse response2) {
+ latch1.countDown();
+ System.out.println(request2.getRequestUri() + "->" + response2.getCode());
+ }
+
+ @Override
+ public void failed(final Exception ex) {
+ latch1.countDown();
+ System.out.println(request2.getRequestUri() + "->" + ex);
+ }
+
+ @Override
+ public void cancelled() {
+ latch1.countDown();
+ System.out.println(request2.getRequestUri() + " cancelled");
+ }
+
+ });
+ latch1.await();
+
+ // In real world one most likely would want also want to stream
+ // request and response body content
+ final CountDownLatch latch2 = new CountDownLatch(1);
+ final AsyncRequestProducer producer3 = AsyncRequestBuilder.get("http://httpbin.org/get").build();
+ final AbstractCharResponseConsumer<HttpResponse> consumer3 = new AbstractCharResponseConsumer<HttpResponse>() {
+
+ HttpResponse response;
+
+ @Override
+ protected void start(final HttpResponse response, final ContentType contentType) throws HttpException, IOException {
+ this.response = response;
+ }
+
+ @Override
+ protected int capacityIncrement() {
+ return Integer.MAX_VALUE;
+ }
+
+ @Override
+ protected void data(final CharBuffer data, final boolean endOfStream) throws IOException {
+ // Do something useful
+ }
+
+ @Override
+ protected HttpResponse buildResult() throws IOException {
+ return response;
+ }
+
+ @Override
+ public void releaseResources() {
+ }
+
+ };
+ httpclient.execute(producer3, consumer3, new FutureCallback<HttpResponse>() {
+
+ @Override
+ public void completed(final HttpResponse response3) {
+ latch2.countDown();
+ System.out.println(request2.getRequestUri() + "->" + response3.getCode());
+ }
+
+ @Override
+ public void failed(final Exception ex) {
+ latch2.countDown();
+ System.out.println(request2.getRequestUri() + "->" + ex);
+ }
+
+ @Override
+ public void cancelled() {
+ latch2.countDown();
+ System.out.println(request2.getRequestUri() + " cancelled");
+ }
+
+ });
+ latch2.await();
+
+ }
+ }
+
+}
diff --git a/samples/src/main/java/org/apache/hc/client5/http/examples/QuickStart.java b/samples/src/main/java/org/apache/hc/client5/http/examples/QuickStart.java
new file mode 100644
index 0000000..e8e2e23
--- /dev/null
+++ b/samples/src/main/java/org/apache/hc/client5/http/examples/QuickStart.java
@@ -0,0 +1,79 @@
+/*
+ * ====================================================================
+ * 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/>.
+ *
+ */
+package org.apache.hc.client5.http.examples;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.hc.client5.http.classic.methods.HttpGet;
+import org.apache.hc.client5.http.classic.methods.HttpPost;
+import org.apache.hc.client5.http.entity.UrlEncodedFormEntity;
+import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
+import org.apache.hc.client5.http.impl.classic.CloseableHttpResponse;
+import org.apache.hc.client5.http.impl.classic.HttpClients;
+import org.apache.hc.core5.http.HttpEntity;
+import org.apache.hc.core5.http.NameValuePair;
+import org.apache.hc.core5.http.io.entity.EntityUtils;
+import org.apache.hc.core5.http.message.BasicNameValuePair;
+
+public class QuickStart {
+
+ public static void main(final String[] args) throws Exception {
+ try (final CloseableHttpClient httpclient = HttpClients.createDefault()) {
+ final HttpGet httpGet = new HttpGet("http://httpbin.org/get");
+ // 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 (final CloseableHttpResponse response1 = httpclient.execute(httpGet)) {
+ System.out.println(response1.getCode() + " " + response1.getReasonPhrase());
+ final HttpEntity entity1 = response1.getEntity();
+ // do something useful with the response body
+ // and ensure it is fully consumed
+ EntityUtils.consume(entity1);
+ }
+
+ final HttpPost httpPost = new HttpPost("http://httpbin.org/post");
+ final List<NameValuePair> nvps = new ArrayList<>();
+ nvps.add(new BasicNameValuePair("username", "vip"));
+ nvps.add(new BasicNameValuePair("password", "secret"));
+ httpPost.setEntity(new UrlEncodedFormEntity(nvps));
+
+ try (final CloseableHttpResponse response2 = httpclient.execute(httpPost)) {
+ System.out.println(response2.getCode() + " " + response2.getReasonPhrase());
+ final HttpEntity entity2 = response2.getEntity();
+ // do something useful with the response body
+ // and ensure it is fully consumed
+ EntityUtils.consume(entity2);
+ }
+ }
+ }
+
+}
diff --git a/samples/src/main/java/org/apache/hc/client5/http/examples/fluent/FluentQuickStart.java b/samples/src/main/java/org/apache/hc/client5/http/examples/fluent/FluentQuickStart.java
new file mode 100644
index 0000000..aaa52c8
--- /dev/null
+++ b/samples/src/main/java/org/apache/hc/client5/http/examples/fluent/FluentQuickStart.java
@@ -0,0 +1,45 @@
+/*
+ * ====================================================================
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+package org.apache.hc.client5.http.examples.fluent;
+
+import org.apache.hc.client5.http.fluent.Form;
+import org.apache.hc.client5.http.fluent.Request;
+
+public class FluentQuickStart {
+
+ public static void main(final String... args) throws Exception {
+ // 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();
+ }
+}
diff --git a/samples/src/main/java/org/apache/http/client/fluent/FluentQuickStart.java b/samples/src/main/java/org/apache/http/client/fluent/FluentQuickStart.java
new file mode 100644
index 0000000..9e273a7
--- /dev/null
+++ b/samples/src/main/java/org/apache/http/client/fluent/FluentQuickStart.java
@@ -0,0 +1,42 @@
+/*
+ * ====================================================================
+ * 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/>.
+ *
+ */
+package org.apache.http.client.fluent;
+
+public class FluentQuickStart {
+
+ public static void main(String[] args) throws Exception {
+ // 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();
+ }
+}
diff --git a/samples/src/main/java/org/apache/http/examples/client/QuickStart.java b/samples/src/main/java/org/apache/http/examples/client/QuickStart.java
new file mode 100644
index 0000000..cf5fed1
--- /dev/null
+++ b/samples/src/main/java/org/apache/http/examples/client/QuickStart.java
@@ -0,0 +1,88 @@
+/*
+ * ====================================================================
+ * 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/>.
+ *
+ */
+package org.apache.http.examples.client;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.http.HttpEntity;
+import org.apache.http.NameValuePair;
+import org.apache.http.client.entity.UrlEncodedFormEntity;
+import org.apache.http.client.methods.CloseableHttpResponse;
+import org.apache.http.client.methods.HttpGet;
+import org.apache.http.client.methods.HttpPost;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.impl.client.HttpClients;
+import org.apache.http.message.BasicNameValuePair;
+import org.apache.http.util.EntityUtils;
+
+public class QuickStart {
+
+ public static void main(String[] args) throws Exception {
+ CloseableHttpClient httpclient = HttpClients.createDefault();
+ try {
+ HttpGet httpGet = new HttpGet("http://httpbin.org/get");
+ 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://httpbin.org/post");
+ 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();
+ }
+ } finally {
+ httpclient.close();
+ }
+ }
+
+}