Skip to content

Commit 274cf15

Browse files
senivamsenivam
authored
19 chapters of User Guide reviewed (#4711)
Signed-off-by: Maxim Nesen <maxim.nesen@oracle.com>
1 parent ab9622b commit 274cf15

26 files changed

+443
-239
lines changed

‎docs/pom.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<!--
33
4-
Copyright (c) 2010, 2019 Oracle and/or its affiliates. All rights reserved.
4+
Copyright (c) 2010, 2021 Oracle and/or its affiliates. All rights reserved.
55
66
This program and the accompanying materials are made available under the
77
terms of the Eclipse Public License v. 2.0, which is available at
@@ -45,7 +45,7 @@
4545
<executions>
4646
<execution>
4747
<configuration>
48-
<tasks>
48+
<target>
4949
<echo message="Preparing char entities" />
5050
<mkdir dir="${src.dir}" />
5151
<copy todir="${src.dir}">
@@ -63,7 +63,7 @@
6363
<replace file="${src.dir}/jersey.ent" token="$repository" value="${javanet.repository.id}" />
6464
<replace file="${src.dir}/jersey.ent" token="$src.branch" value="${jersey.src.branch}" />
6565
<replace file="${src.dir}/jersey.ent" token="$version" value="${jersey.version}" />
66-
</tasks>
66+
</target>
6767
</configuration>
6868
<id>process-entities</id>
6969
<phase>package</phase>

‎docs/src/main/docbook/appendix-properties.xml‎

Lines changed: 120 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0"?>
22
<!--
33
4-
Copyright (c) 2013, 2018 Oracle and/or its affiliates. All rights reserved.
4+
Copyright (c) 2013, 2021 Oracle and/or its affiliates. All rights reserved.
55
66
This program and the accompanying materials are made available under the
77
terms of the Eclipse Public License v. 2.0, which is available at
@@ -49,44 +49,74 @@
4949
</thead>
5050
<tbody>
5151
<row>
52-
<entry>&jersey.common.CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLE;</entry>
53-
<entry><literal>jersey.config.disableAutoDiscovery</literal></entry>
52+
<entry>&jersey.common.CommonProperties.ALLOW_SYSTEM_PROPERTIES_PROVIDER;</entry>
53+
<entry><literal>jersey.config.allowSystemPropertiesProvider</literal></entry>
54+
<entry>
55+
<para>
56+
Property which allows (if true) default System properties configuration provider.
57+
Default value is <literal>true</literal>.
58+
</para>
59+
</entry>
60+
</row>
61+
<row>
62+
<entry>&jersey.common.CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLE; /
63+
&jersey.common.CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLE_CLIENT; /
64+
&jersey.common.CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLE_SERVER;</entry>
65+
<entry><literal>jersey.config.disableAutoDiscovery</literal>/
66+
<literal>jersey.config.client.disableAutoDiscovery</literal>/
67+
<literal>jersey.config.server.disableAutoDiscovery</literal></entry>
5468
<entry>
5569
<para>
5670
Disables feature auto discovery globally on client/server. Default value is <literal>false</literal>.
5771
</para>
5872
</entry>
5973
</row>
6074
<row>
61-
<entry>&jersey.common.CommonProperties.JSON_PROCESSING_FEATURE_DISABLE;</entry>
62-
<entry><literal>jersey.config.disableJsonProcessing</literal></entry>
75+
<entry>&jersey.common.CommonProperties.JSON_PROCESSING_FEATURE_DISABLE; /
76+
&jersey.common.CommonProperties.JSON_PROCESSING_FEATURE_DISABLE_CLIENT; /
77+
&jersey.common.CommonProperties.JSON_PROCESSING_FEATURE_DISABLE_SERVER;</entry>
78+
<entry><literal>jersey.config.disableJsonProcessing</literal> /
79+
<literal>jersey.config.client.disableJsonProcessing</literal> /
80+
<literal>jersey.config.server.disableJsonProcessing</literal></entry>
6381
<entry>
6482
<para>
6583
Disables configuration of Json Processing (JSR-353) feature. Default value is <literal>false</literal>.
6684
</para>
6785
</entry>
6886
</row>
6987
<row>
70-
<entry>&jersey.common.CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE;</entry>
71-
<entry><literal>jersey.config.disableMetainfServicesLookup</literal></entry>
88+
<entry>&jersey.common.CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE; /
89+
&jersey.common.CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE_CLIENT; /
90+
&jersey.common.CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE_SERVER;</entry>
91+
<entry><literal>jersey.config.disableMetainfServicesLookup</literal> /
92+
<literal>jersey.config.client.disableMetainfServicesLookup</literal> /
93+
<literal>jersey.config.server.disableMetainfServicesLookup</literal></entry>
7294
<entry>
7395
<para>
7496
Disables META-INF/services lookup globally on client/server. Default value is <literal>false</literal>.
7597
</para>
7698
</entry>
7799
</row>
78100
<row>
79-
<entry>&jersey.common.CommonProperties.MOXY_JSON_FEATURE_DISABLE;</entry>
80-
<entry><literal>jersey.config.disableMoxyJson</literal></entry>
101+
<entry>&jersey.common.CommonProperties.MOXY_JSON_FEATURE_DISABLE; /
102+
&jersey.common.CommonProperties.MOXY_JSON_FEATURE_DISABLE_CLIENT; /
103+
&jersey.common.CommonProperties.MOXY_JSON_FEATURE_DISABLE_SERVER;</entry>
104+
<entry><literal>jersey.config.disableMoxyJson</literal> /
105+
<literal>jersey.config.client.disableMoxyJson</literal> /
106+
<literal>jersey.config.server.disableMoxyJson</literal></entry>
81107
<entry>
82108
<para>
83109
Disables configuration of MOXy Json feature. Default value is <literal>false</literal>.
84110
</para>
85111
</entry>
86112
</row>
87113
<row>
88-
<entry>&jersey.common.CommonProperties.OUTBOUND_CONTENT_LENGTH_BUFFER;</entry>
89-
<entry><literal>jersey.config.contentLength.buffer</literal></entry>
114+
<entry>&jersey.common.CommonProperties.OUTBOUND_CONTENT_LENGTH_BUFFER; /
115+
&jersey.common.CommonProperties.OUTBOUND_CONTENT_LENGTH_BUFFER_CLIENT; /
116+
&jersey.common.CommonProperties.OUTBOUND_CONTENT_LENGTH_BUFFER_SERVER;</entry>
117+
<entry><literal>jersey.config.contentLength.buffer</literal> /
118+
<literal>jersey.config.client.contentLength.buffer</literal> /
119+
<literal>jersey.config.server.contentLength.buffer</literal></entry>
90120
<entry>
91121
<para>
92122
An integer value that defines the buffer size used to buffer the outbound message entity in order to
@@ -95,6 +125,28 @@
95125
</para>
96126
</entry>
97127
</row>
128+
<row>
129+
<entry>&jersey.common.CommonProperties.PROVIDER_DEFAULT_DISABLE;
130+
</entry>
131+
<entry>
132+
<literal>jersey.config.disableDefaultProvider</literal>
133+
</entry>
134+
<entry>
135+
Disable some of the default providers from being loaded. The following providers extend application footprint
136+
by XML dependencies, which is too heavy for native image, or by AWT which may possibly be not available by JDK 11 desktop:
137+
138+
<simplelist><member>java.awt.image.RenderedImage</member>
139+
<member>javax.xml.transform.Source</member>
140+
<member>javax.xml.transform.dom.DOMSource</member>
141+
<member>javax.xml.transform.sax.SAXSource</member>
142+
<member>javax.xml.transform.stream.StreamSource</member></simplelist>
143+
144+
The following are the options to disable the provides: {@code DOMSOURCE, RENDEREDIMAGE, SAXSOURCE, SOURCE, STREAMSOURCE},
145+
or to disable all: {@code ALL}. Multiple options can be disabled by adding multiple comma separated values.
146+
Default value is <literal>NULL</literal>
147+
@since 2.30
148+
</entry>
149+
</row>
98150
<row>
99151
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_LOGGER_NAME;
100152
</entry>
@@ -514,8 +566,8 @@
514566
</entry>
515567
</row>
516568
<row>
517-
<entry>&jersey.server.ServerProperties.SUBRESOURCE_LOCATOR_CACHE_SIZE;</entry>
518-
<entry><literal>jersey.config.server.subresource.cache.size</literal></entry>
569+
<entry>&jersey.server.ServerProperties.SUBRESOURCE_LOCATOR_CACHE_AGE;</entry>
570+
<entry><literal>jersey.config.server.subresource.cache.age</literal></entry>
519571
<entry>
520572
<para>
521573
An integer value that defines the maximum age (in seconds) for cached for sub-resource locator
@@ -537,6 +589,17 @@
537589
</para>
538590
</entry>
539591
</row>
592+
<row>
593+
<entry>&jersey.server.ServerProperties.LOCATION_HEADER_RELATIVE_URI_RESOLUTION_RFC7231;</entry>
594+
<entry><literal>jersey.config.server.headers.location.relative.resolution.rfc7231</literal></entry>
595+
<entry>
596+
<para>
597+
If <literal>true</literal> then Jersey will resolve relative URIs in the
598+
<literal>Location</literal> http header against the request URI according to <literal>RFC7231</literal>
599+
(new HTTP Specification)
600+
</para>
601+
</entry>
602+
</row>
540603
<row>
541604
<entry>&jersey.server.ServerProperties.LOCATION_HEADER_RELATIVE_URI_RESOLUTION_DISABLED;</entry>
542605
<entry><literal>jersey.config.server.headers.location.relative.resolution.disabled</literal></entry>
@@ -732,12 +795,22 @@
732795
</para>
733796
</entry>
734797
</row>
798+
<row>
799+
<entry>&jersey.client.ClientProperties.BACKGROUND_SCHEDULER_THREADPOOL_SIZE;</entry>
800+
<entry><literal>jersey.config.client.backgroundScheduler.threadPoolSize</literal></entry>
801+
<entry>
802+
<para>
803+
Scheduler thread pool size. Default value is not set.
804+
<emphasis>Support is undefined</emphasis>.
805+
</para>
806+
</entry>
807+
</row>
735808
<row>
736809
<entry>&jersey.client.ClientProperties.CHUNKED_ENCODING_SIZE;</entry>
737810
<entry><literal>jersey.config.client.chunkedEncodingSize</literal></entry>
738811
<entry>
739812
<para>
740-
Chunked encoding size. Default value is not set.
813+
Chunked encoding size. Default value is <literal>4096</literal>.
741814
</para>
742815
</entry>
743816
</row>
@@ -885,6 +958,38 @@
885958
</para>
886959
</entry>
887960
</row>
961+
<row>
962+
<entry>&jersey.client.ClientProperties.DIGESTAUTH_URI_CACHE_SIZELIMIT;</entry>
963+
<entry><literal>jersey.config.client.digestAuthUriCacheSizeLimit</literal></entry>
964+
<entry>
965+
<para>
966+
The property defines a URI of a HTTP proxy the client connector should use.
967+
</para>
968+
</entry>
969+
</row>
970+
<row>
971+
<entry>&jersey.client.ClientProperties.EXPECT_100_CONTINUE;</entry>
972+
<entry><literal>jersey.config.client.request.expect.100.continue.processing</literal></entry>
973+
<entry>
974+
<para>
975+
Allows for HTTP Expect:100-Continue being handled by the HttpUrlConnector (default Jersey
976+
connector). <literal>Since 2.32</literal>
977+
</para>
978+
</entry>
979+
</row>
980+
<row>
981+
<entry>&jersey.client.ClientProperties.EXPECT_100_CONTINUE_THRESHOLD_SIZE;</entry>
982+
<entry><literal>jersey.config.client.request.expect.100.continue.threshold.size</literal></entry>
983+
<entry>
984+
<para>
985+
Property for threshold size for content length after which Expect:100-Continue header would be applied
986+
before the main request.
987+
Default threshold size (64kb) after which which Expect:100-Continue header would be applied before
988+
the main request.
989+
<literal>Since 2.32</literal>
990+
</para>
991+
</entry>
992+
</row>
888993
<row>
889994
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_LOGGER_NAME_CLIENT;
890995
</entry>
@@ -948,4 +1053,4 @@
9481053
</tgroup>
9491054
</table>
9501055
</section>
951-
</appendix>
1056+
</appendix>

‎docs/src/main/docbook/async.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0"?>
22
<!--
33
4-
Copyright (c) 2012, 2020 Oracle and/or its affiliates. All rights reserved.
4+
Copyright (c) 2012, 2021 Oracle and/or its affiliates. All rights reserved.
55
66
This program and the accompanying materials are made available under the
77
terms of the Eclipse Public License v. 2.0, which is available at
@@ -85,7 +85,7 @@ public class AsyncResource {
8585
when the method returns. Instead, the injected &lit.jaxrs.container.AsyncResponse; instance (that represents the
8686
suspended client request connection) will be used to explicitly send the response back to the client using some other
8787
thread. In other words, Jersey runtime knows that when the <literal>asyncGet</literal> method completes, the response
88-
to the client may not be ready yet and the processing must be suspended and wait to be explictly resumed with a
88+
to the client may not be ready yet and the processing must be suspended and wait to be explicitly resumed with a
8989
response once it becomes available. Note that the method <literal>asyncGet</literal> returns <literal>void</literal>
9090
in our example. This is perfectly valid in case of an asynchronous JAX-RS resource method, even for a &jaxrs.GET;
9191
method, as the response is never returned directly from the resource method as its return value. Instead, the response
@@ -250,7 +250,7 @@ public class AsyncResource {
250250
In Jersey you can use &jersey.server.ChunkedOutput; to send response to a client in chunks. Chunks are strictly
251251
defined pieces of a response body can be marshalled as a separate entities using Jersey/JAX-RS
252252
&jaxrs.ext.MessageBodyWriter; providers. A chunk can be String, Long or JAXB bean serialized to XML or JSON or
253-
any other dacustom type for which a &lit.jaxrs.ext.MessageBodyWriter; is available.
253+
any other defined custom type for which a &lit.jaxrs.ext.MessageBodyWriter; is available.
254254
</para>
255255
<para>
256256
The resource method
@@ -484,7 +484,7 @@ while ((chunk = chunkedInput.read()) != null) {
484484
&lit.jersey.client.ChunkedInput; does not know how to distinguish chunks in the byte stream unless being told by
485485
the developer. In order to define custom chunks boundaries,
486486
the &lit.jersey.client.ChunkedInput; offers possibility to register a &jersey.client.ChunkParser; which
487-
reads chunks from the input stream and separates them. Jersey provides several chunk parser implementation and
487+
reads chunks from the input stream and separates them. Jersey provides several chunk parser implementations and
488488
you can implement your own parser to separate your chunks if you need. In our example above the default parser
489489
provided by Jersey is used that separates chunks based on presence of a <literal>\r\n</literal> delimiting
490490
character sequence.

0 commit comments

Comments
 (0)