Updated JSON binding and async examples

Author: ok2c

httpcore5-jackson2/src/test/java/org/apache/hc/core5/jackson2/http/examples/JsonNodeResponseExample.java

@@ -44,6 +44,16 @@
 import org.apache.hc.core5.reactor.IOReactorConfig;
 import org.apache.hc.core5.util.Timeout;
 
+/**
+ * This example demonstrates how an HTTP response JSON content can be consumed as
+ * Jackson JsonNode object.
+ * <p>
+ * Please note content of incoming and outgoing HTTP messages gets streamed without making
+ * a copy of the message body content in an intermediate buffer.
+ * <p>
+ * This example uses {@link AsyncJsonClientPipeline} to simplify HTTP message execution pipeline
+ * assembly. One can also use JSON message request producers and response consumers directly.
+ */
 public class JsonNodeResponseExample {
 
     public static void main(final String... args) throws Exception {

httpcore5-jackson2/src/test/java/org/apache/hc/core5/jackson2/http/examples/JsonObjectRequestExample.java

@@ -47,6 +47,18 @@
 import org.apache.hc.core5.reactor.IOReactorConfig;
 import org.apache.hc.core5.util.Timeout;
 
+/**
+ * This example demonstrates how a plain Java Object can be serialized as a request
+ * content body in JSON format and an HTTP response JSON content can be consumed as
+ * a plain Java Object compatible with Jackson JSON bindings.
+ *
+ * <p>
+ * Please note content of incoming and outgoing HTTP messages gets streamed without making
+ * a copy of the message body content in an intermediate buffer.
+ * <p>
+ * This example uses {@link AsyncJsonClientPipeline} to simplify HTTP message execution pipeline
+ * assembly. One can also use JSON message request producers and response consumers directly.
+ */
 public class JsonObjectRequestExample {
 
     public static void main(final String... args) throws Exception {

httpcore5-jackson2/src/test/java/org/apache/hc/core5/jackson2/http/examples/JsonSequenceRequestExample.java

@@ -50,6 +50,17 @@
 import org.apache.hc.core5.reactor.IOReactorConfig;
 import org.apache.hc.core5.util.Timeout;
 
+/**
+ * This example demonstrates how to stream out a sequence plain Java Objects compatible
+ * with Jackson JSON bindings as a request content body in JSON format.
+ *
+ * <p>
+ * Please note content of incoming and outgoing HTTP messages gets streamed without making
+ * a copy of the message body content in an intermediate buffer.
+ * <p>
+ * This example uses {@link AsyncJsonClientPipeline} to simplify HTTP message execution pipeline
+ * assembly. One can also use JSON message request producers and response consumers directly.
+ */
 public class JsonSequenceRequestExample {
 
     public static void main(final String... args) throws Exception {

httpcore5-jackson2/src/test/java/org/apache/hc/core5/jackson2/http/examples/JsonSequenceResponseExample.java

@@ -43,6 +43,17 @@
 import org.apache.hc.core5.reactor.IOReactorConfig;
 import org.apache.hc.core5.util.Timeout;
 
+/**
+ * This example demonstrates how an HTTP response content can be consumed as a sequence
+ * of plain Java Objects compatible with Jackson JSON bindings.
+ *
+ * <p>
+ * Please note content of incoming and outgoing HTTP messages gets streamed without making
+ * a copy of the message body content in an intermediate buffer.
+ * <p>
+ * This example uses {@link AsyncJsonClientPipeline} to simplify HTTP message execution pipeline
+ * assembly. One can also use JSON message request producers and response consumers directly.
+ */
 public class JsonSequenceResponseExample {
 
     public static void main(final String... args) throws Exception {

httpcore5-jackson2/src/test/java/org/apache/hc/core5/jackson2/http/examples/JsonServerExample.java

@@ -57,7 +57,13 @@
 import org.apache.hc.core5.util.TimeValue;
 
 /**
- * Example of asynchronous embedded JSON server.
+ * Example of asynchronous embedded HTTP server that exchanges messages in JSON format.
+ * <p>
+ * Please note content of incoming and outgoing HTTP messages gets streamed without making
+ * a copy of the message body content in an intermediate buffer.
+ * <p>
+ * This example uses {@link AsyncJsonServerPipeline} to simplify HTTP message execution pipeline
+ * assembly. One can also use JSON message consumers and response producers directly.
  */
 public class JsonServerExample {
 

httpcore5-jackson2/src/test/java/org/apache/hc/core5/jackson2/http/examples/JsonTokenEventResponseExample.java

@@ -43,6 +43,16 @@
 import org.apache.hc.core5.reactor.IOReactorConfig;
 import org.apache.hc.core5.util.Timeout;
 
+/**
+ * This example demonstrates how an HTTP response JSON content can be consumed as
+ * a stream of events.
+ * <p>
+ * Please note content of incoming and outgoing HTTP messages gets streamed without making
+ * a copy of the message body content in an intermediate buffer.
+ * <p>
+ * This example uses {@link AsyncJsonClientPipeline} to simplify HTTP message execution pipeline
+ * assembly. One can also use JSON message request and response consumers directly.
+ */
 public class JsonTokenEventResponseExample {
 
     public static void main(final String... args) throws Exception {

httpcore5/src/test/java/org/apache/hc/core5/http/examples/AsyncClientSNIExample.java

@@ -53,6 +53,9 @@
 
 /**
  * Example of SNI (Server Name Identification) usage with async I/O.
+ * <p>
+ * This example uses {@link AsyncClientPipeline} to simplify HTTP message execution pipeline
+ * assembly. One can also use message request producers and response consumers directly.
  */
 public class AsyncClientSNIExample {
 

httpcore5/src/test/java/org/apache/hc/core5/http/examples/AsyncFileServerExample.java

@@ -63,6 +63,9 @@
 
 /**
  * Example of asynchronous embedded HTTP/1.1 file server.
+ * <p>
+ * This example uses {@link AsyncServerPipeline} to simplify HTTP message execution pipeline
+ * assembly. One can also use message request consumers and response producers directly.
  */
 public class AsyncFileServerExample {
 

httpcore5/src/test/java/org/apache/hc/core5/http/examples/AsyncPipelinedRequestExecutionExample.java

@@ -50,6 +50,9 @@
 
 /**
  * Example of asynchronous HTTP/1.1 request execution.
+ * <p>
+ * This example uses {@link AsyncClientPipeline} to simplify HTTP message execution pipeline
+ * assembly. One can also use message request producers and response consumers directly.
  */
 public class AsyncPipelinedRequestExecutionExample {
 

httpcore5/src/test/java/org/apache/hc/core5/http/examples/AsyncRequestExecutionExample.java

@@ -48,6 +48,9 @@
 
 /**
  * Example of asynchronous HTTP/1.1 request execution.
+ * <p>
+ * This example uses {@link AsyncClientPipeline} to simplify HTTP message execution pipeline
+ * assembly. One can also use message request producers and response consumers directly.
  */
 public class AsyncRequestExecutionExample {