Updated documentation and javadoc for Connectors

Signed-off-by: jansupol <[email protected]>
eclipse-ee4j · Apr 28, 2022 · 444a91c · 444a91c
1 parent b0e7b1e
commit 444a91c
Show file tree

Hide file tree

Showing 15 changed files with 949 additions and 40 deletions.
diff --git a/bundles/apidocs/pom.xml b/bundles/apidocs/pom.xml
@@ -58,11 +58,21 @@
             <artifactId>jersey-apache-connector</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.glassfish.jersey.connectors</groupId>
+            <artifactId>jersey-apache5-connector</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.glassfish.jersey.connectors</groupId>
             <artifactId>jersey-grizzly-connector</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.glassfish.jersey.connectors</groupId>
+            <artifactId>jersey-helidon-connector</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.glassfish.jersey.connectors</groupId>
             <artifactId>jersey-jdk-connector</artifactId>
@@ -190,6 +200,11 @@
             <artifactId>jersey-mp-config</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.glassfish.jersey.ext.microprofile</groupId>
+            <artifactId>jersey-mp-rest-client</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.glassfish.jersey.ext</groupId>
             <artifactId>jersey-wadl-doclet</artifactId>

diff --git a/...connector/src/main/java/org/glassfish/jersey/apache/connector/ApacheClientProperties.java b/...connector/src/main/java/org/glassfish/jersey/apache/connector/ApacheClientProperties.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, 2020 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2022 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -89,8 +89,8 @@ public final class ApacheClientProperties {
 
     /**
      * A value of {@code true} indicates that configured connection manager should be shared
-     * among multiple Jersey {@link org.glassfish.jersey.client.ClientRuntime} instances. It means that closing
-     * a particular {@link org.glassfish.jersey.client.ClientRuntime} instance does not shut down the underlying
+     * among multiple Jersey {@code ClientRuntime} instances. It means that closing
+     * a particular {@code ClientRuntime} instance does not shut down the underlying
      * connection manager automatically. In such case, the connection manager life-cycle
      * should be fully managed by the application code. To release all allocated resources,
      * caller code should especially ensure {@link org.apache.http.conn.HttpClientConnectionManager#shutdown()} gets
@@ -114,7 +114,7 @@ public final class ApacheClientProperties {
      * <p/>
      * The value MUST be an instance of {@link org.apache.http.client.config.RequestConfig}.
      * <p/>
-     * If the property is absent default request configuration will be used.
+     * If the property is absent the default request configuration will be used.
      * <p/>
      * The name of the configuration property is <tt>{@value}</tt>.
      *
@@ -137,9 +137,9 @@ public final class ApacheClientProperties {
     /**
      * ConnectionReuseStrategy for the {@link org.apache.http.client.HttpClient}.
      * <p/>
-     * The value MUST be an instance of {@link org.apache.http.impl.ConnectionReuseStrategy}.
+     * The value MUST be an instance of {@link org.apache.http.ConnectionReuseStrategy}.
      * <p/>
-     * If the property is absent the default reuse strategy of the Apache HTTP library will be used
+     * If the property is absent the default reuse strategy of the Apache HTTP library will be used.
      * <p/>
      * The name of the configuration property is <tt>{@value}</tt>.
      */
@@ -158,7 +158,9 @@ public final class ApacheClientProperties {
 
 
     /**
-     * Strategy that closes the Apache Connection. Accepts an instance of {@link ApacheConnectionClosingStrategy}.
+     * <p>
+     *  Strategy that closes the Apache Connection. Accepts an instance of {@link ApacheConnectionClosingStrategy}.
+     * </p>
      *
      * @see ApacheConnectionClosingStrategy
      * @since 2.30

diff --git a/...apache-connector/src/main/java/org/glassfish/jersey/apache/connector/ApacheConnector.java b/...apache-connector/src/main/java/org/glassfish/jersey/apache/connector/ApacheConnector.java
@@ -110,18 +110,22 @@
  * <p/>
  * The following properties are only supported at construction of this class:
  * <ul>
+ * <li>{@link ApacheClientProperties#CONNECTION_CLOSING_STRATEGY}</li>
  * <li>{@link ApacheClientProperties#CONNECTION_MANAGER}</li>
- * <li>{@link ApacheClientProperties#REQUEST_CONFIG}</li>
+ * <li>{@link ApacheClientProperties#CONNECTION_MANAGER_SHARED}</li>
+ * <li>{@link ApacheClientProperties#CONNECTION_CLOSING_STRATEGY}</li>
  * <li>{@link ApacheClientProperties#CREDENTIALS_PROVIDER}</li>
  * <li>{@link ApacheClientProperties#DISABLE_COOKIES}</li>
  * <li>{@link ApacheClientProperties#KEEPALIVE_STRATEGY}</li>
+ * <li>{@link ApacheClientProperties#PREEMPTIVE_BASIC_AUTHENTICATION}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_URI}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_USERNAME}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_PASSWORD}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#REQUEST_ENTITY_PROCESSING} - default value is {@link org.glassfish.jersey.client.RequestEntityProcessing#CHUNKED}</li>
- * <li>{@link ApacheClientProperties#PREEMPTIVE_BASIC_AUTHENTICATION}</li>
+ * <li>{@link ApacheClientProperties#REQUEST_CONFIG}</li>
  * <li>{@link ApacheClientProperties#RETRY_HANDLER}</li>
  * <li>{@link ApacheClientProperties#REUSE_STRATEGY}</li>
+ * <li>{@link ApacheClientProperties#USE_SYSTEM_PROPERTIES}</li>
  * </ul>
  * <p>
  * This connector uses {@link RequestEntityProcessing#CHUNKED chunked encoding} as a default setting. This can

diff --git a/...onnector/src/main/java/org/glassfish/jersey/apache/connector/ApacheConnectorProvider.java b/...onnector/src/main/java/org/glassfish/jersey/apache/connector/ApacheConnectorProvider.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, 2019 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2022 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -33,19 +33,23 @@
  * <p>
  * The following connector configuration properties are supported:
  * <ul>
+ * <li>{@link ApacheClientProperties#CONNECTION_CLOSING_STRATEGY}</li>
  * <li>{@link ApacheClientProperties#CONNECTION_MANAGER}</li>
- * <li>{@link ApacheClientProperties#REQUEST_CONFIG}</li>
+ * <li>{@link ApacheClientProperties#CONNECTION_MANAGER_SHARED}</li>
+ * <li>{@link ApacheClientProperties#CONNECTION_CLOSING_STRATEGY}</li>
  * <li>{@link ApacheClientProperties#CREDENTIALS_PROVIDER}</li>
  * <li>{@link ApacheClientProperties#DISABLE_COOKIES}</li>
  * <li>{@link ApacheClientProperties#KEEPALIVE_STRATEGY}</li>
+ * <li>{@link ApacheClientProperties#PREEMPTIVE_BASIC_AUTHENTICATION}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_URI}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_USERNAME}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_PASSWORD}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#REQUEST_ENTITY_PROCESSING}
  * - default value is {@link org.glassfish.jersey.client.RequestEntityProcessing#CHUNKED}</li>
- * <li>{@link ApacheClientProperties#PREEMPTIVE_BASIC_AUTHENTICATION}</li>
+ * <li>{@link ApacheClientProperties#REQUEST_CONFIG}</li>
  * <li>{@link ApacheClientProperties#RETRY_HANDLER}</li>
  * <li>{@link ApacheClientProperties#REUSE_STRATEGY}</li>
+ * <li>{@link ApacheClientProperties#USE_SYSTEM_PROPERTIES}</li>
  * </ul>
  * </p>
  * <p>

diff --git a/...nnector/src/main/java/org/glassfish/jersey/apache5/connector/Apache5ClientProperties.java b/...nnector/src/main/java/org/glassfish/jersey/apache5/connector/Apache5ClientProperties.java
@@ -90,8 +90,8 @@ public final class Apache5ClientProperties {
 
     /**
      * A value of {@code true} indicates that configured connection manager should be shared
-     * among multiple Jersey {@link org.glassfish.jersey.client.ClientRuntime} instances. It means that closing
-     * a particular {@link org.glassfish.jersey.client.ClientRuntime} instance does not shut down the underlying
+     * among multiple Jersey {@code ClientRuntime} instances. It means that closing
+     * a particular {@code ClientRuntime} instance does not shut down the underlying
      * connection manager automatically. In such case, the connection manager life-cycle
      * should be fully managed by the application code. To release all allocated resources,
      * caller code should especially ensure {@link org.apache.hc.client5.http.io.HttpClientConnectionManager#close()} gets
@@ -124,7 +124,7 @@ public final class Apache5ClientProperties {
     public static final String REQUEST_CONFIG = "jersey.config.apache5.client.requestConfig";
 
     /**
-     * HttpRequestRetryHandler which will be used to create {@link org.apache.hc.client5.http.classic.HttpClient}.
+     * HttpRequestRetryStrategy which will be used to create {@link org.apache.hc.client5.http.classic.HttpClient}.
      * <p/>
      * The value MUST be an instance of {@link org.apache.hc.client5.http.HttpRequestRetryStrategy}.
      * <p/>

diff --git a/...che5-connector/src/main/java/org/glassfish/jersey/apache5/connector/Apache5Connector.java b/...che5-connector/src/main/java/org/glassfish/jersey/apache5/connector/Apache5Connector.java
@@ -107,18 +107,21 @@
  * <p/>
  * The following properties are only supported at construction of this class:
  * <ul>
+ * <li>{@link Apache5ClientProperties#CONNECTION_CLOSING_STRATEGY}</li>
  * <li>{@link Apache5ClientProperties#CONNECTION_MANAGER}</li>
- * <li>{@link Apache5ClientProperties#REQUEST_CONFIG}</li>
- * <li>{@link Apache5ClientProperties#CREDENTIALS_PROVIDER}</li>
+ * <li>{@link Apache5ClientProperties#CONNECTION_MANAGER_SHARED}</li>
  * <li>{@link Apache5ClientProperties#DISABLE_COOKIES}</li>
+ * <li>{@link Apache5ClientProperties#CREDENTIALS_PROVIDER}</li>
  * <li>{@link Apache5ClientProperties#KEEPALIVE_STRATEGY}</li>
+ * <li>{@link Apache5ClientProperties#PREEMPTIVE_BASIC_AUTHENTICATION}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_URI}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_USERNAME}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_PASSWORD}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#REQUEST_ENTITY_PROCESSING} - default value is {@link org.glassfish.jersey.client.RequestEntityProcessing#CHUNKED}</li>
- * <li>{@link Apache5ClientProperties#PREEMPTIVE_BASIC_AUTHENTICATION}</li>
+ * <li>{@link Apache5ClientProperties#REQUEST_CONFIG}</li>
  * <li>{@link Apache5ClientProperties#RETRY_STRATEGY}</li>
  * <li>{@link Apache5ClientProperties#REUSE_STRATEGY}</li>
+ * <li>{@link Apache5ClientProperties#USE_SYSTEM_PROPERTIES}</li>
  * </ul>
  * <p>
  * This connector uses {@link RequestEntityProcessing#CHUNKED chunked encoding} as a default setting. This can

diff --git a/...nector/src/main/java/org/glassfish/jersey/apache5/connector/Apache5ConnectorProvider.java b/...nector/src/main/java/org/glassfish/jersey/apache5/connector/Apache5ConnectorProvider.java
@@ -32,19 +32,22 @@
  * <p>
  * The following connector configuration properties are supported:
  * <ul>
+ * <li>{@link Apache5ClientProperties#CONNECTION_CLOSING_STRATEGY}</li>
  * <li>{@link Apache5ClientProperties#CONNECTION_MANAGER}</li>
- * <li>{@link Apache5ClientProperties#REQUEST_CONFIG}</li>
- * <li>{@link Apache5ClientProperties#CREDENTIALS_PROVIDER}</li>
+ * <li>{@link Apache5ClientProperties#CONNECTION_MANAGER_SHARED}</li>
  * <li>{@link Apache5ClientProperties#DISABLE_COOKIES}</li>
+ * <li>{@link Apache5ClientProperties#CREDENTIALS_PROVIDER}</li>
  * <li>{@link Apache5ClientProperties#KEEPALIVE_STRATEGY}</li>
+ * <li>{@link Apache5ClientProperties#PREEMPTIVE_BASIC_AUTHENTICATION}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_URI}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_USERNAME}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_PASSWORD}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#REQUEST_ENTITY_PROCESSING}
  * - default value is {@link org.glassfish.jersey.client.RequestEntityProcessing#CHUNKED}</li>
- * <li>{@link Apache5ClientProperties#PREEMPTIVE_BASIC_AUTHENTICATION}</li>
+ * <li>{@link Apache5ClientProperties#REQUEST_CONFIG}</li>
  * <li>{@link Apache5ClientProperties#RETRY_STRATEGY}</li>
  * <li>{@link Apache5ClientProperties#REUSE_STRATEGY}</li>
+ * <li>{@link Apache5ClientProperties#USE_SYSTEM_PROPERTIES}</li>
  * </ul>
  * </p>
  * <p>

diff --git a/...dk-connector/src/main/java/org/glassfish/jersey/jdk/connector/JdkConnectorProperties.java b/...dk-connector/src/main/java/org/glassfish/jersey/jdk/connector/JdkConnectorProperties.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2022 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -60,7 +60,7 @@ public final class JdkConnectorProperties {
      * Value is expected to be positive {@link Integer}. Default value is {@value #DEFAULT_MAX_REDIRECTS}.
      * <p/>
      * HTTP redirection must be enabled by property {@link org.glassfish.jersey.client.ClientProperties#FOLLOW_REDIRECTS},
-     * otherwise {@code MAX_HEADER_SIZE} is not applied.
+     * otherwise {@code MAX_REDIRECTS} is not applied.
      *
      * @see org.glassfish.jersey.client.ClientProperties#FOLLOW_REDIRECTS
      * @see org.glassfish.jersey.jdk.connector.internal.RedirectException
@@ -70,14 +70,14 @@ public final class JdkConnectorProperties {
     /**
      * To set the cookie policy of this cookie manager.
      * <p/>
-     * The default value is ACCEPT_ORIGINAL_SERVER.
+     * The default value is {@link CookiePolicy#ACCEPT_ORIGINAL_SERVER}.
      *
      * @see java.net.CookieManager
      */
     public static final String COOKIE_POLICY = "jersey.config.client.JdkConnectorProvider.cookiePolicy";
 
     /**
-     * A maximal number of open connection to each destination. A destination is determined by the following triple:
+     * A maximum number of open connections per each destination. A destination is determined by the following triple:
      * <ul>
      * <li>host</li>
      * <li>port</li>

diff --git a/...onnector/src/main/java/org/glassfish/jersey/jdk/connector/internal/RedirectException.java b/...onnector/src/main/java/org/glassfish/jersey/jdk/connector/internal/RedirectException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015, 2019 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2022 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -25,7 +25,7 @@
  * <ul>
  * <li>
  * the chained redirection count exceeds the value of
- * {@link org.glassfish.jersey.client.JdkConnectorProvider#MAX_REDIRECTS}
+ * {@link org.glassfish.jersey.jdk.connector.JdkConnectorProperties#MAX_REDIRECTS}
  * </li>
  * <li>
  * or an infinite redirection loop is detected

diff --git a/...y-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyClientProperties.java b/...y-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyClientProperties.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, 2021 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2022 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -70,7 +70,7 @@ private JettyClientProperties() {
      * that is stored in a truststore.
      * <p/>
      * The value MUST be an instance of {@link java.lang.Boolean}.
-     * If the property is absent the default value is {@code true}
+     * If the property is absent the default value is {@code true}.
      */
     public static final String ENABLE_SSL_HOSTNAME_VERIFICATION =
             "jersey.config.jetty.client.enableSslHostnameVerification";

diff --git a/...rs/jetty-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyConnector.java b/...rs/jetty-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyConnector.java
@@ -92,8 +92,10 @@
  * <li>{@link ClientProperties#PROXY_USERNAME}</li>
  * <li>{@link ClientProperties#PROXY_PASSWORD}</li>
  * <li>{@link ClientProperties#PROXY_PASSWORD}</li>
+ * <li>{@link JettyClientProperties#DISABLE_COOKIES}</li>*
+ * <li>{@link JettyClientProperties#ENABLE_SSL_HOSTNAME_VERIFICATION}</li>
  * <li>{@link JettyClientProperties#PREEMPTIVE_BASIC_AUTHENTICATION}</li>
- * <li>{@link JettyClientProperties#DISABLE_COOKIES}</li>
+ * <li>{@link JettyClientProperties#SYNC_LISTENER_RESPONSE_MAX_SIZE}</li>
  * </ul>
  * <p/>
  * This transport supports both synchronous and asynchronous processing of client requests.

diff --git a/...-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyConnectorProvider.java b/...-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyConnectorProvider.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, 2019 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2022 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -40,8 +40,10 @@
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_USERNAME}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_PASSWORD}</li>
  * <li>{@link org.glassfish.jersey.client.ClientProperties#PROXY_PASSWORD}</li>
+ * <li>{@link JettyClientProperties#DISABLE_COOKIES}</li>*
+ * <li>{@link JettyClientProperties#ENABLE_SSL_HOSTNAME_VERIFICATION}</li>
  * <li>{@link JettyClientProperties#PREEMPTIVE_BASIC_AUTHENTICATION}</li>
- * <li>{@link JettyClientProperties#DISABLE_COOKIES}</li>
+ * <li>{@link JettyClientProperties#SYNC_LISTENER_RESPONSE_MAX_SIZE}</li>
  * </ul>
  * </p>
  * <p>