-
Notifications
You must be signed in to change notification settings - Fork 357
/
Copy pathappendix-properties.xml
2385 lines (2337 loc) · 136 KB
/
appendix-properties.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<!--
Copyright (c) 2013, 2025 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
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
version 2 with the GNU Classpath Exception, which is available at
https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-->
<!DOCTYPE appendix [<!ENTITY % ents SYSTEM "jersey.ent" > %ents; ]>
<appendix xmlns="http://docbook.org/ns/docbook"
version="5.0"
xml:lang="en"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xlink="http://www.w3.org/1999/xlink"
xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd
http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd"
xml:id="appendix-properties">
<title>Configuration Properties</title>
<section xml:id="appendix-properties-common">
<title>Common (client/server) configuration properties</title>
<para>
List of common configuration properties that can be found in &jersey.common.CommonProperties; class. All of these properties
can be overridden by their server/client counterparts.
</para>
<table>
<title>List of common configuration properties</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&jersey.common.CommonProperties.ALLOW_SYSTEM_PROPERTIES_PROVIDER;</entry>
<entry><literal>jersey.config.allowSystemPropertiesProvider</literal></entry>
<entry>
<para>
Property which allows (if true) default System properties configuration provider.
Default value is <literal>true</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLE; /
&jersey.common.CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLE_CLIENT; /
&jersey.common.CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLE_SERVER;</entry>
<entry><literal>jersey.config.disableAutoDiscovery</literal>/
<literal>jersey.config.client.disableAutoDiscovery</literal>/
<literal>jersey.config.server.disableAutoDiscovery</literal></entry>
<entry>
<para>
Disables feature auto discovery globally on client/server. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.JSON_BINDING_FEATURE_DISABLE; /
&jersey.common.CommonProperties.JSON_BINDING_FEATURE_DISABLE_CLIENT; /
&jersey.common.CommonProperties.JSON_BINDING_FEATURE_DISABLE_SERVER;</entry>
<entry><literal>jersey.config.disableJsonBinding</literal> /
<literal>jersey.config.client.disableJsonBinding</literal> /
<literal>jersey.config.server.disableJsonBinding</literal></entry>
<entry>
<para>
Disables configuration of Json Binding (JSR-367) feature. Default value is <literal>false</literal>.
Can also be set as a system property.
</para>
<para>
Since 2.45.
</para>
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.JSON_BINDING_FEATURE_DISABLE_APPLICATION; </entry>
<entry><literal>jersey.config.application.disableJsonBinding</literal></entry>
<entry>
<para>
Disables configuration of Json Binding (JSR-367) feature for <literal>javax.ws.rs.core.Application</literal>
subclasses whose package names are specified as a value. The value is comma-separated string
defining prefixes of the application package names. Can also be set as a system property.
</para>
<para>
By default, Json Binding is automatically enabled.
</para>
<para>
Since 2.45.
</para>
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.JSON_PROCESSING_FEATURE_DISABLE; /
&jersey.common.CommonProperties.JSON_PROCESSING_FEATURE_DISABLE_CLIENT; /
&jersey.common.CommonProperties.JSON_PROCESSING_FEATURE_DISABLE_SERVER;</entry>
<entry><literal>jersey.config.disableJsonProcessing</literal> /
<literal>jersey.config.client.disableJsonProcessing</literal> /
<literal>jersey.config.server.disableJsonProcessing</literal></entry>
<entry>
<para>
Disables configuration of Json Processing (JSR-353) feature. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE; /
&jersey.common.CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE_CLIENT; /
&jersey.common.CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE_SERVER;</entry>
<entry><literal>jersey.config.disableMetainfServicesLookup</literal> /
<literal>jersey.config.client.disableMetainfServicesLookup</literal> /
<literal>jersey.config.server.disableMetainfServicesLookup</literal></entry>
<entry>
<para>
Disables META-INF/services lookup globally on client/server. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.MOXY_JSON_FEATURE_DISABLE; /
&jersey.common.CommonProperties.MOXY_JSON_FEATURE_DISABLE_CLIENT; /
&jersey.common.CommonProperties.MOXY_JSON_FEATURE_DISABLE_SERVER;</entry>
<entry><literal>jersey.config.disableMoxyJson</literal> /
<literal>jersey.config.client.disableMoxyJson</literal> /
<literal>jersey.config.server.disableMoxyJson</literal></entry>
<entry>
<para>
Disables configuration of MOXy Json feature. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.OUTBOUND_CONTENT_LENGTH_BUFFER; /
&jersey.common.CommonProperties.OUTBOUND_CONTENT_LENGTH_BUFFER_CLIENT; /
&jersey.common.CommonProperties.OUTBOUND_CONTENT_LENGTH_BUFFER_SERVER;</entry>
<entry><literal>jersey.config.contentLength.buffer</literal> /
<literal>jersey.config.client.contentLength.buffer</literal> /
<literal>jersey.config.server.contentLength.buffer</literal></entry>
<entry>
<para>
An integer value that defines the buffer size used to buffer the outbound message entity in order to
determine its size and set the value of HTTP <literal>Content-Length</literal> header. Default
value is <literal>8192</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.PROVIDER_DEFAULT_DISABLE;
</entry>
<entry>
<literal>jersey.config.disableDefaultProvider</literal>
</entry>
<entry>
Disable some of the default providers from being loaded. The following providers extend application footprint
by XML dependencies, which is too heavy for native image, or by AWT which may possibly be not available by JDK 11 desktop:
<simplelist><member>java.awt.image.RenderedImage</member>
<member>javax.xml.transform.Source</member>
<member>javax.xml.transform.dom.DOMSource</member>
<member>javax.xml.transform.sax.SAXSource</member>
<member>javax.xml.transform.stream.StreamSource</member></simplelist>
The following are the options to disable the provides: {@code DOMSOURCE, RENDEREDIMAGE, SAXSOURCE, SOURCE, STREAMSOURCE},
or to disable all: {@code ALL}. Multiple options can be disabled by adding multiple comma separated values.
Default value is <literal>NULL</literal>
@since 2.30
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.JSON_JACKSON_ENABLED_MODULES; /
&jersey.common.CommonProperties.JSON_JACKSON_ENABLED_MODULES_CLIENT; /
&jersey.common.CommonProperties.JSON_JACKSON_ENABLED_MODULES_SERVER;
</entry>
<entry>
<literal>jersey.config.json.jackson.enabled.modules</literal>
<literal>jersey.config.client.json.jackson.enabled.modules</literal>
<literal>jersey.config.server.json.jackson.enabled.modules</literal>
</entry>
<entry>
Comma separated list of jackson modules which shall be used for json-jackson provider.
If set, only those modules will be used for JSON processing.
Default value is <literal>NULL</literal>
@since 2.36
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.JSON_JACKSON_DISABLED_MODULES; /
&jersey.common.CommonProperties.JSON_JACKSON_DISABLED_MODULES_CLIENT; /
&jersey.common.CommonProperties.JSON_JACKSON_DISABLED_MODULES_SERVER;
</entry>
<entry>
<literal>jersey.config.json.jackson.disabled.modules</literal>
<literal>jersey.config.client.json.jackson.disabled.modules</literal>
<literal>jersey.config.server.json.jackson.disabled.modules</literal>
</entry>
<entry>
Comma separated list of jackson modules which shall be excluded from json-jackson provider.
If set, those modules will be excluded from JSON processing.
Default value is <literal>NULL</literal>
@since 2.36
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.PARAM_CONVERTERS_THROW_IAE;(Jersey 2.40 or later)
</entry>
<entry>
<literal>jersey.config.paramconverters.throw.iae</literal>
</entry>
<entry>
<para>
Force the &jaxrs.ext.ParamConverter; to throw <literal>IllegalArgumentException
</literal> as mandated in javadoc.
Must be convertible to &lit.jdk6.Boolean; value.
</para>
<para>
Internally the <literal>Exception</literal> is caught by Jersey and usually converted to
<literal>null</literal>
Therefore, the default value is set to &lit.false; to speed up the conversion.
</para>
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.THREAD_FACTORY;(Jersey 2.44 or later)
</entry>
<entry>
<literal>jersey.config.threads.factory</literal>
</entry>
<entry>
<para>
Defines the <literal>java.util.concurrent.ThreadFactory</literal> to be used by internal default
<literal>ExecutorServices</literal>.
</para>
<para>
The default is <literal>java.util.concurrent.Executors#defaultThreadFactory()</literal> on
platform threads and<literal>Thread.ofVirtual().factory()</literal> on virtual threads.
</para>
</entry>
</row>
<row>
<entry>&jersey.common.CommonProperties.USE_VIRTUAL_THREADS;(Jersey 2.44 or later)
</entry>
<entry>
<literal>jersey.config.threads.use.virtual</literal>
</entry>
<entry>
<para>
Defines whether the virtual threads should be used by Jersey on JDK 21+ when not using an exact number
of threads by <literal>FixedThreadPool</literal>.
</para>
<para>
The default is &lit.false; for this version of Jersey, and &lit.true; for Jersey 3.1+.
</para>
</entry>
</row>
<row>
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_LOGGER_NAME;
</entry>
<entry>
<literal>jersey.config.logging.logger.name</literal>
</entry>
<entry>
Logger name of the logging filter.
See <link linkend="logging.xml">logging</link> chapter for more information.
The default value is <literal>org.glassfish.jersey.logging.LoggingFeature</literal>
</entry>
</row>
<row>
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_LOGGER_LEVEL;
</entry>
<entry>
<literal>jersey.config.logging.logger.level</literal>
</entry>
<entry>
Level of logging filter's logger at which the messages will be logged.
See <link linkend="logging.xml">logging</link> chapter for more information.
</entry>
</row>
<row>
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_VERBOSITY;
</entry>
<entry>
<literal>jersey.config.logging.verbosity</literal>
</entry>
<entry>
Verbosity of logging filter describes how verbose the logging filter will be.
There are 3 possible values &lit.jersey.logging.LoggingFeature.Verbosity.HEADERS_ONLY;,
&lit.jersey.logging.LoggingFeature.Verbosity.PAYLOAD_TEXT; or
&lit.jersey.logging.LoggingFeature.Verbosity.PAYLOAD_ANY;.
See <link linkend="logging.xml">logging</link> chapter for more information.
</entry>
</row>
<row>
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_MAX_ENTITY_SIZE;
</entry>
<entry>
<literal>jersey.config.logging.entity.maxSize</literal>
</entry>
<entry>
The maximum number of bytes of the entity which will be logged.
See <link linkend="logging.xml">logging</link> chapter for more information.
</entry>
</row>
<row>
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_SEPARATOR;
</entry>
<entry>
<literal>jersey.config.logging.entity.separator</literal>
</entry>
<entry>
Custom logging delimiter for new lines separation.
See <link linkend="logging.xml">logging</link> chapter for more information.
</entry>
</row>
<row>
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_REDACT_HEADERS;
</entry>
<entry>
<literal>jersey.config.logging.headers.redact</literal>
</entry>
<entry>
The HTTP headers (semicolon separated) to be redacted when logging.
See <link linkend="logging_chapter">logging</link> chapter for more information.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="appendix-properties-server">
<title>Server configuration properties</title>
<para>
List of server configuration properties that can be found in &jersey.server.ServerProperties; class.
</para>
<table>
<title>List of server configuration properties</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&jersey.server.ServerProperties.APPLICATION_NAME;</entry>
<entry><literal>jersey.config.server.application.name</literal></entry>
<entry>
<para>
Defines the application name. The name is an arbitrary user defined name which is used to
distinguish between Jersey applications in the case that more applications are deployed on
the same runtime (container). The name can be used for example for purposes of monitoring
by JMX when name identifies to which application deployed MBeans belong to. The name should
be unique in the runtime. The property does not have a default value.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.BV_FEATURE_DISABLE;</entry>
<entry><literal>jersey.config.beanValidation.disable.server</literal></entry>
<entry>
<para>
Disables Bean Validation support. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry><link xlink:href='&jersey.javadoc.uri.prefix;/server/ServerProperties.html#BV_DISABLE_VALIDATE_ON_EXECUTABLE_OVERRIDE_CHECK'>ServerProperties
.BV_DISABLE_VALIDATE_ON_EXECUTABLE_OVERRIDE_CHECK</link></entry>
<entry><literal>jersey.config.beanValidation
.disable.validateOnExecutableCheck.server</literal></entry>
<entry>
<para>
Disables &lit.bv.ValidateOnExecution; check. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.BV_SEND_ERROR_IN_RESPONSE;</entry>
<entry><literal>jersey.config.beanValidation
.enableOutputValidationErrorEntity.server</literal></entry>
<entry>
<para>
Enables sending validation error information to the client. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.FEATURE_AUTO_DISCOVERY_DISABLE;</entry>
<entry><literal>jersey.config.server.disableAutoDiscovery</literal></entry>
<entry>
<para>
Disables feature auto discovery on server. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.HTTP_METHOD_OVERRIDE;</entry>
<entry><literal>jersey.config.server.httpMethodOverride</literal></entry>
<entry>
<para>
Defines configuration of HTTP method overriding.
This property is used by &jersey.server.HttpMethodOverrideFilter; to determine
where it should look for method override information (e.g. request header or query parameters).
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.JSON_BINDING_FEATURE_DISABLE;</entry>
<entry><literal>jersey.config.server.disableJsonBinding</literal></entry>
<entry>
<para>
Disables configuration of Json Processing (JSR-353) feature. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.JSON_PROCESSING_FEATURE_DISABLE;</entry>
<entry><literal>jersey.config.server.disableJsonProcessing</literal></entry>
<entry>
<para>
Disables configuration of Json Processing (JSR-353) feature. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.LANGUAGE_MAPPINGS;</entry>
<entry><literal>jersey.config.server.languageMappings</literal></entry>
<entry>
<para>
Defines mapping of URI extensions to languages. The property is used by &jersey.server.UriConnegFilter;.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.MEDIA_TYPE_MAPPINGS;</entry>
<entry><literal>jersey.config.server.mediaTypeMappings</literal></entry>
<entry>
<para>
Defines mapping of URI extensions to media types. The property is used by &jersey.server.UriConnegFilter;.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.METAINF_SERVICES_LOOKUP_DISABLE;</entry>
<entry><literal>jersey.config.server.disableMetainfServicesLookup</literal></entry>
<entry>
<para>
Disables META-INF/services lookup on server. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.MOXY_JSON_FEATURE_DISABLE;</entry>
<entry><literal>jersey.config.server.disableMoxyJson</literal></entry>
<entry>
<para>
Disables configuration of MOXy Json feature. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.MONITORING_ENABLED; (Jersey 2.12 or later)</entry>
<entry><literal>jersey.config.server
.monitoring.statistics.enabled</literal></entry>
<entry>
<para>
If &lit.true;, then application monitoring will be enabled. This will enable the possibility
of injecting &jersey.server.monitoring.ApplicationInfo; into resource and providers.
Default value is &lit.false;.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.MONITORING_STATISTICS_ENABLED;</entry>
<entry><literal>jersey.config.server
.monitoring.enabled</literal></entry>
<entry>
<para>
If &lit.true;, the calculation of monitoring statistics will be enabled. This will enable the
possibility of injecting &jersey.server.monitoring.MonitoringStatistics; into resource and
providers and also the registered listeners implementing
&jersey.server.monitoring.MonitoringStatisticsListener; will be called when statistics are
available for processing.
Monitoring statistics extends basic monitoring feature. Therefore when enabled,
the monitoring gets automatically enabled too (the same result as setting the property
&jersey.server.ServerProperties.MONITORING_ENABLED; to &lit.true;).
Note that enabling statistics may have a negative performance impact
and therefore should be enabled only when needed. Default value is &lit.false;.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.MONITORING_STATISTICS_MBEANS_ENABLED;</entry>
<entry><literal>jersey.config.server
.monitoring.statistics.mbeans.enabled</literal></entry>
<entry>
<para>
If &lit.true; then Jersey will expose MBeans for the collected monitoring statistics. Exposed
JMX MBeans are based on &jersey.server.monitoring.MonitoringStatistics; data and therefore when
enabled, the calculation of monitoring statistics gets automatically enabled too (the same result
as setting the property &jersey.server.ServerProperties.MONITORING_STATISTICS_ENABLED; to
&lit.true;). Note that enabling MBeans for monitoring statistics may have a negative performance
impact and therefore should be enabled only when needed. Default value is &lit.false;.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.MONITORING_STATISTICS_REFRESH_INTERVAL; (Jersey 2.10 or later)</entry>
<entry><literal>jersey.config.server
.monitoring.statistics.refresh.interval</literal></entry>
<entry>
<para>
Interval (in <literal>ms</literal>}) indicating how often will be monitoring statistics refreshed
(<literal>onStatistics</literal> method called). Default value is <literal>500</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.OUTBOUND_CONTENT_LENGTH_BUFFER;
(Jersey 2.2 or later)</entry>
<entry><literal>jersey.config.contentLength.server.buffer</literal></entry>
<entry>
<para>
An integer value that defines the buffer size used to buffer the outbound message entity in order to
determine its size and set the value of HTTP <literal>Content-Length</literal> header. Default
value is <literal>8192</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.PROVIDER_CLASSNAMES;</entry>
<entry><literal>jersey.config.server.provider.classnames</literal></entry>
<entry>
<para>
Defines one or more class names that implement application-specific resources
and providers. If the property is set, the specified classes will be instantiated
and registered as either application JAX-RS root resources or providers.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.PROVIDER_CLASSPATH;</entry>
<entry><literal>jersey.config.server.provider.classpath</literal></entry>
<entry>
<para>
Defines class-path that contains application-specific resources and
providers. If the property is set, the specified packages will be scanned for
JAX-RS root resources and providers.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.PROVIDER_PACKAGES;</entry>
<entry><literal>jersey.config.server.provider.packages</literal></entry>
<entry>
<para>
Defines one or more packages that contain application-specific resources and
providers. If the property is set, the specified packages will be scanned for
JAX-RS root resources and providers.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.PROVIDER_SCANNING_RECURSIVE;</entry>
<entry><literal>jersey.config.server
.provider.scanning.recursive</literal></entry>
<entry>
<para>
Sets the recursion strategy for package scanning. Default value is <literal>true</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.REDUCE_CONTEXT_PATH_SLASHES_ENABLED;</entry>
<entry><literal>jersey.config.server.reduceContextPathSlashes.enabled</literal></entry>
<entry>
<para>
Ignores multiple slashes between a port and a context path and will resolve it
as URI with only one slash. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.RESOURCE_VALIDATION_DISABLE;</entry>
<entry><literal>jersey.config.server
.resource.validation.disable</literal></entry>
<entry>
<para>
Disables <literal>Resource</literal> validation. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.RESOURCE_VALIDATION_IGNORE_ERRORS;</entry>
<entry><literal>jersey.config.server
.resource.validation.ignoreErrors</literal></entry>
<entry>
<para>
Determines whether validation of application resource models should fail even in case of a fatal
validation errors. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.WADL_FEATURE_DISABLE;</entry>
<entry><literal>jersey.config.server.wadl.disableWadl</literal></entry>
<entry>
<para>
Disables WADL generation. Default value is <literal>false</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.WADL_GENERATOR_CONFIG;</entry>
<entry><literal>jersey.config.server.wadl.generatorConfig</literal></entry>
<entry>
<para>
Defines the wadl generator configuration that provides a &jersey.server.WadlGenerator;.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.RESPONSE_SET_STATUS_OVER_SEND_ERROR;</entry>
<entry><literal>jersey.config.server.response.setStatusOverSendError</literal></entry>
<entry>
<para>
Whenever response status is <literal>4xx</literal> or <literal>5xx</literal> it is
possible to choose between <literal>sendError</literal> or <literal>setStatus</literal>
on container specific <literal>Response</literal> implementation. E.g. on servlet
container Jersey can call <literal>HttpServletResponse.setStatus(...)</literal> or
<literal>HttpServletResponse.sendError(...)</literal>.
Calling <literal>sendError(...)</literal> method usually resets entity, response headers
and provide error page for specified status code (e.g. servlet
<literal>error-page</literal> configuration).
However if you want to post-process response (e.g. by servlet filter) the only
way to do it is calling <literal>setStatus(...)</literal> on container Response object.
If property value is &lit.true; the method <literal>Response.setStatus(...)</literal> is
used over default <literal>Response.sendError(...)</literal>.
Type of the property value is <literal>boolean</literal>.
The default value is &lit.false;.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.TRACING;</entry>
<entry><literal>jersey.config.server.tracing.type</literal></entry>
<entry>
<para>
Enables/disables tracing support. Possible values are <literal>OFF</literal> (default),
<literal>ON_DEMAND</literal> and <literal>ALL</literal>.
See <xref linkend="tracing.configuration" /> for more detail.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.TRACING_THRESHOLD;</entry>
<entry><literal>jersey.config.server.tracing.threshold</literal></entry>
<entry>
<para>
Sets the amount of detail provided by tracing. Possible values are <literal>SUMMARY</literal>,
<literal>TRACE</literal> and <literal>VERBOSE</literal>.
See <xref linkend="tracing.configuration" /> to learn more about the levels.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.PROCESSING_RESPONSE_ERRORS_ENABLED;</entry>
<entry><literal>jersey.config.server.exception.processResponseErrors</literal></entry>
<entry>
<para>
If property value is <literal>true</literal> then the errors raised during response processing are
tried to be handled using available response error mappers.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.SUBRESOURCE_LOCATOR_CACHE_SIZE;</entry>
<entry><literal>jersey.config.server.subresource.cache.size</literal></entry>
<entry>
<para>
An integer value that defines the size of cache for sub-resource locator models. The cache is used
to provide better performance for application that uses JAX-RS sub-resource locators.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.SUBRESOURCE_LOCATOR_CACHE_AGE;</entry>
<entry><literal>jersey.config.server.subresource.cache.age</literal></entry>
<entry>
<para>
An integer value that defines the maximum age (in seconds) for cached for sub-resource locator
models. The age of an cache entry is defined as the time since the last access (read) to the entry
in the cache. Entry aging is not enabled by default.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.SUBRESOURCE_LOCATOR_CACHE_JERSEY_RESOURCE_ENABLED;</entry>
<entry><literal>jersey.config.server.subresource.cache.jersey.resource.enabled</literal></entry>
<entry>
<para>
If <literal>true</literal> then Jersey will cache Jersey resources in addition to caching
sub-resource locator classes and instances (which are cached by default). To make sure the caching
is effective in this case you need to return same Jersey Resource instances for same input
parameters from resource method. This means that generating new Jersey Resource instances for same
input parameters would not have any performance effect and it would only fill-up the cache.
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.LOCATION_HEADER_RELATIVE_URI_RESOLUTION_RFC7231;</entry>
<entry><literal>jersey.config.server.headers.location.relative.resolution.rfc7231</literal></entry>
<entry>
<para>
If <literal>true</literal> then Jersey will resolve relative URIs in the
<literal>Location</literal> http header against the request URI according to <literal>RFC7231</literal>
(new HTTP Specification)
</para>
</entry>
</row>
<row>
<entry>&jersey.server.ServerProperties.LOCATION_HEADER_RELATIVE_URI_RESOLUTION_DISABLED;</entry>
<entry><literal>jersey.config.server.headers.location.relative.resolution.disabled</literal></entry>
<entry>
<para>
If <literal>true</literal>, Jersey will not resolve relative URIs in the <literal>Location</literal>
http header.
</para>
</entry>
</row>
<row>
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_LOGGER_NAME_SERVER;
</entry>
<entry>
<literal>jersey.config.server.logging.logger.name</literal>
</entry>
<entry>
Logger name of the logging filter.
See <link linkend="logging.xml">logging</link> chapter for more information.
The default value is <literal>org.glassfish.jersey.logging.LoggingFeature</literal>
</entry>
</row>
<row>
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_LOGGER_LEVEL_SERVER;
</entry>
<entry>
<literal>jersey.config.server.logging.logger.level</literal>
</entry>
<entry>
Level of logging filter's logger at which the messages will be logged.
See <link linkend="logging.xml">logging</link> chapter for more information.
</entry>
</row>
<row>
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_VERBOSITY_SERVER;
</entry>
<entry>
<literal>jersey.config.server.logging.verbosity</literal>
</entry>
<entry>
Verbosity of logging filter describes how verbose the logging filter will be.
There are 3 possible values &lit.jersey.logging.LoggingFeature.Verbosity.HEADERS_ONLY;,
&lit.jersey.logging.LoggingFeature.Verbosity.PAYLOAD_TEXT; or
&lit.jersey.logging.LoggingFeature.Verbosity.PAYLOAD_ANY;.
See <link linkend="logging.xml">logging</link> chapter for more information.
</entry>
</row>
<row>
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_MAX_ENTITY_SIZE_SERVER;
</entry>
<entry>
<literal>jersey.config.server.logging.entity.maxSize</literal>
</entry>
<entry>
The maximum number of bytes of the entity which will be logged.
See <link linkend="logging.xml">logging</link> chapter for more information.
</entry>
</row>
<row>
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_SEPARATOR_SERVER;
</entry>
<entry>
<literal>jersey.config.server.logging.entity.separator</literal>
</entry>
<entry>
Custom delimiter for new lines separation.
See <link linkend="logging.xml">logging</link> chapter for more information.
</entry>
</row>
<row>
<entry>&jersey.logging.LoggingFeature.LOGGING_FEATURE_REDACT_HEADERS_SERVER;
</entry>
<entry>
<literal>jersey.config.server.logging.headers.redact</literal>
</entry>
<entry>
The HTTP headers (semicolon separated) to be redacted when logging.
See <link linkend="logging_chapter">logging</link> chapter for more information.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="appendix-properties-servlet">
<title>Servlet configuration properties</title>
<para>
List of servlet configuration properties that can be found in &jersey.servlet.ServletProperties; class.
</para>
<table>
<title>List of servlet configuration properties</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&jersey.servlet.ServletProperties.FILTER_CONTEXT_PATH;</entry>
<entry><literal>jersey.config.servlet.filter.contextPath</literal></entry>
<entry>
<para>
If set, indicates the URL pattern of the Jersey servlet filter context path.
</para>
</entry>
</row>
<row>
<entry>&jersey.servlet.ServletProperties.FILTER_FORWARD_ON_404;</entry>
<entry><literal>jersey.config.servlet.filter.forwardOn404</literal></entry>
<entry>
<para>
If set to <literal>true</literal> and a 404 response with no entity body is returned from either
the runtime or the application then the runtime forwards the request to the next filter in the
filter chain. This enables another filter or the underlying servlet engine to process the request.
Before the request is forwarded the response status is set to 200.
</para>
</entry>
</row>
<row>
<entry>&jersey.servlet.ServletProperties.FILTER_STATIC_CONTENT_REGEX;</entry>
<entry><literal>jersey.config.servlet.filter.staticContentRegex</literal></entry>
<entry>
<para>
If set the regular expression is used to match an incoming servlet path URI to some web page
content such as static resources or JSPs to be handled by the underlying servlet engine.
</para>
</entry>
</row>
<row>
<entry>&jersey.servlet.ServletProperties.JAXRS_APPLICATION_CLASS;</entry>
<entry><literal>javax.ws.rs.Application</literal></entry>
<entry>
<para>
Application configuration initialization property whose value is a fully qualified class name of a
class that implements JAX-RS Application.
</para>
</entry>
</row>
<row>
<entry>&jersey.servlet.ServletProperties.PROVIDER_WEB_APP;</entry>
<entry><literal>jersey.config.servlet.provider.webapp</literal></entry>
<entry>
<para>
Indicates that Jersey should scan the whole web app for application-specific resources and
providers.
</para>
</entry>
</row>
<row>
<entry>&jersey.servlet.ServletProperties.QUERY_PARAMS_AS_FORM_PARAMS_DISABLED;</entry>
<entry><literal>jersey.config.servlet.form.queryParams.disabled</literal></entry>
<entry>
<para>
If <literal>true</literal> then query parameters will not be treated as form parameters
(e.g. injectable using @FormParam) in case a Form request is processed by server.
</para>
</entry>
</row>
<row>
<entry>&jersey.servlet.ServletProperties.SERVICE_LOCATOR;</entry>
<entry><literal>jersey.config.servlet.context.serviceLocator</literal></entry>
<entry>
<para>
Identifies the object that will be used as a parent ServiceLocator in the Jersey WebComponent.
</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="appendix-properties-client">
<title>Client configuration properties</title>
<para>
List of client configuration properties that can be found in &jersey.client.ClientProperties; class.
</para>
<table>
<title>List of client configuration properties</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&jersey.client.ClientProperties.ASYNC_THREADPOOL_SIZE;</entry>
<entry><literal>jersey.config.client.async.threadPoolSize</literal></entry>
<entry>
<para>
Asynchronous thread pool size. Default value is not set.
<emphasis>Supported with &jersey.grizzly.GrizzlyConnectorProvider; only.</emphasis>.
</para>
</entry>
</row>
<row>
<entry>&jersey.client.ClientProperties.BACKGROUND_SCHEDULER_THREADPOOL_SIZE;</entry>
<entry><literal>jersey.config.client.backgroundScheduler.threadPoolSize</literal></entry>
<entry>
<para>
Scheduler thread pool size. Default value is not set.
<emphasis>Support is undefined</emphasis>.
</para>
</entry>
</row>
<row>
<entry>&jersey.client.ClientProperties.CHUNKED_ENCODING_SIZE;</entry>
<entry><literal>jersey.config.client.chunkedEncodingSize</literal></entry>
<entry>
<para>
Chunked encoding size. Default value is <literal>4096</literal>.
</para>
</entry>
</row>
<row>
<entry>&jersey.client.ClientProperties.CONNECT_TIMEOUT;</entry>
<entry><literal>jersey.config.client.connectTimeout</literal></entry>
<entry>
<para>
Read timeout interval, in milliseconds. Default value is <literal>0</literal> (infinity).
</para>
</entry>
</row>
<row>
<entry>&jersey.client.ClientProperties.CONNECTOR_PROVIDER;(Jersey 2.40 or later)</entry>
<entry><literal>jersey.config.client.connector.provider</literal></entry>
<entry>
<para>
Sets the &jersey.client.ConnectorProvider; class. Overrides the value from META-INF/services.
</para>
<para>
The value MUST be an instance of &lit.jdk6.String;.
</para>
<para>
The property is recognized by &lit.jaxrs.client.ClientBuilder;.
</para>
</entry>
</row>
<row>
<entry>&jersey.client.ClientProperties.DIGESTAUTH_URI_CACHE_SIZELIMIT;</entry>
<entry><literal>jersey.config.client.digestAuthUriCacheSizeLimit</literal></entry>
<entry>
<para>
The property defines a URI of a HTTP proxy the client connector should use.
</para>