Updated JettyClientProperties#TOTAL_TIMEOUT related documentation. Signed-off-by: jansupol <jan.supol@oracle.com>
diff --git a/connectors/jetty-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyClientProperties.java b/connectors/jetty-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyClientProperties.java index aa7a77b..b6817dc 100644 --- a/connectors/jetty-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyClientProperties.java +++ b/connectors/jetty-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyClientProperties.java
@@ -86,17 +86,20 @@ "jersey.config.jetty.client.syncListenerResponseMaxSize"; /** - * Total timeout interval, in milliseconds. + * Total timeout interval for request/response conversation, in milliseconds. + * Opposed to {@link org.glassfish.jersey.client.ClientProperties#READ_TIMEOUT}. * <p> - * The value MUST be an instance convertible to {@link java.lang.Integer}. A + * The value MUST be an instance convertible to {@link java.lang.Integer}. The * value of zero (0) is equivalent to an interval of infinity. * </p> * <p> - * The default value is infinity (0). + * The default value is zero (infinity). * </p> * <p> * The name of the configuration property is <tt>{@value}</tt>. * </p> + * + * @since 2.37 */ public static final String TOTAL_TIMEOUT = "jersey.config.jetty.client.totalTimeout";
diff --git a/docs/src/main/docbook/appendix-properties.xml b/docs/src/main/docbook/appendix-properties.xml index 6bd970a..56fd939 100644 --- a/docs/src/main/docbook/appendix-properties.xml +++ b/docs/src/main/docbook/appendix-properties.xml
@@ -1790,6 +1790,23 @@ </para> </entry> </row> + <row> + <entry>&jersey.jetty.JettyClientProperties.TOTAL_TIMEOUT;</entry> + <entry><literal>jersey.config.jetty.client.totalTimeout</literal></entry> + <entry> + <para> + Total timeout interval for request/response conversation, in milliseconds. + Opposed to &jersey.client.ClientProperties.READ_TIMEOUT;. + </para> + <para> + The value MUST be an instance convertible to <literal>Integer</literal>. + The value of zero <literal>0</literal> is equivalent to an interval of infinity. + </para> + <para> + The default value is <literal>0</literal> (infinity). + </para> + </entry> + </row> </tbody> </tgroup> </table>
diff --git a/docs/src/main/docbook/jersey.ent b/docs/src/main/docbook/jersey.ent index e463997..a729162 100644 --- a/docs/src/main/docbook/jersey.ent +++ b/docs/src/main/docbook/jersey.ent
@@ -470,6 +470,7 @@ <!ENTITY jersey.jetty.JettyClientProperties.DISABLE_COOKIES "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/connector/JettyClientProperties.html#DISABLE_COOKIES'>JettyClientProperties.DISABLE_COOKIES</link>" > <!ENTITY jersey.jetty.JettyClientProperties.PREEMPTIVE_BASIC_AUTHENTICATION "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/connector/JettyClientProperties.html#PREEMPTIVE_BASIC_AUTHENTICATION'>JettyClientProperties.PREEMPTIVE_BASIC_AUTHENTICATION</link>" > <!ENTITY jersey.jetty.JettyClientProperties.SYNC_LISTENER_RESPONSE_MAX_SIZE "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/connector/JettyClientProperties.html#SYNC_LISTENER_RESPONSE_MAX_SIZE'>JettyClientProperties.SYNC_LISTENER_RESPONSE_MAX_SIZE</link>" > +<!ENTITY jersey.jetty.JettyClientProperties.TOTAL_TIMEOUT "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/connector/JettyClientProperties.html#TOTAL_TIMEOUT'>JettyClientProperties.TOTAL_TIMEOUT</link>" > <!ENTITY jersey.jetty.JettyConnectorProvider "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/connector/JettyConnectorProvider.html'>JettyConnectorProvider</link>"> <!ENTITY jersey.jetty.JettyHttpContainer "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/JettyHttpContainer.html'>JettyHttpContainer</link>"> <!ENTITY jersey.jetty.JettyHttpContainerFactory "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/JettyHttpContainerFactory.html'>JettyHttpContainerFactory</link>">