/
Installation_Configuration.xml
executable file
·1292 lines (1197 loc) · 57.4 KB
/
Installation_Configuration.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
<chapter id="Installation_Configuration">
<title>Installation/Configuration</title>
<para>
RESTEasy is installed and configured in different ways depending on which environment you are running in.
If you are running in WildFly, RESTEasy is already bundled and integrated completely
so there is very little you have to do. If you are running in a different environment, there is some manual
installation and configuration you will have to do.
</para>
<section id="resteasy_modules_in_wildfly">
<title>RESTEasy modules in WildFly</title>
<para>
In WildFly, RESTEasy and the JAX-RS API are automatically loaded into your deployment's classpath
if and only if you are deploying a JAX-RS application (as determined by the presence
of JAX-RS annotations). However, only some RESTEasy features are automatically loaded. See Table 3.1.
If you need any of those libraries which are not loaded automatically, you'll have to bring them in
with a jboss-deployment-structure.xml file in the WEB-INF directory of your WAR file. Here's an example:
</para>
<programlisting><![CDATA[
<jboss-deployment-structure>
<deployment>
<dependencies>
<module name="org.jboss.resteasy.resteasy-jackson-provider" services="import"/>
</dependencies>
</deployment>
</jboss-deployment-structure>]]></programlisting>
<para>The <literal>services</literal> attribute must be set to "import" for modules that have default providers
in a META-INF/services/javax.ws.rs.ext.Providers file.
</para>
<para>
To get an idea of which RESTEasy modules are loaded by default when JAX-RS services are deployed, please
see the table below, which refers to a recent WildFly ditribution patched with the current RESTEasy
distribution. Clearly, future and unpatched WildFly distributions might differ a bit in terms of modules
enabled by default, as the container actually controls this too.
</para>
<para>
<table>
<tgroup cols="3" rowsep="1" colsep="1">
<thead>
<row>
<entry>
Module Name
</entry>
<entry>
Loaded by Default
</entry>
<entry>
Description
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
org.jboss.resteasy.resteasy-atom-provider
</entry>
<entry>
yes
</entry>
<entry>
RESTEasy's atom library
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-cdi
</entry>
<entry>
yes
</entry>
<entry>
RESTEasy CDI integration
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-crypto
</entry>
<entry>
yes
</entry>
<entry>
S/MIME, DKIM, and support for other security formats.
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-jackson-provider
</entry>
<entry>
no
</entry>
<entry>
Integration with the JSON parser and object mapper Jackson (deprecated)
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-jackson2-provider
</entry>
<entry>
yes
</entry>
<entry>
Integration with the JSON parser and object mapper Jackson 2
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-jaxb-provider
</entry>
<entry>
yes
</entry>
<entry>
XML JAXB integration.
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-jaxrs
</entry>
<entry>
yes
</entry>
<entry>
Core RESTEasy libraries for server and client. You will need to include this in your deployment
if you are only using JAX-RS client.
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-jettison-provider
</entry>
<entry>
no
</entry>
<entry>
Alternative JAXB-like parser for JSON (deprecated)
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.jose-jwt
</entry>
<entry>
no
</entry>
<entry>
JSON Web Token support.
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-jsapi
</entry>
<entry>
yes
</entry>
<entry>
RESTEasy's Javascript API
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-json-p-provider
</entry>
<entry>
yes
</entry>
<entry>
JSON parsing API
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-json-binding-provider
</entry>
<entry>
yes
</entry>
<entry>
JSON binding API
</entry>
</row>
<row>
<entry>
javax.json.bind-api
</entry>
<entry>
yes
</entry>
<entry>
JSON binding API
</entry>
</row>
<row>
<entry>
org.eclipse.yasson
</entry>
<entry>
yes
</entry>
<entry>
RI implementation of JSON binding API
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-multipart-provider
</entry>
<entry>
yes
</entry>
<entry>
Support for multipart formats
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.skeleton-key
</entry>
<entry>
no
</entry>
<entry>
OAuth2 support.
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-spring
</entry>
<entry>
no
</entry>
<entry>
Spring provider
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-validator-provider
</entry>
<entry>
yes
</entry>
<entry>
RESTEasy's interface to Hibernate Bean Validation
</entry>
</row>
<row>
<entry>
org.jboss.resteasy.resteasy-yaml-provider
</entry>
<entry>
yes
</entry>
<entry>
YAML marshalling
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<section id="other_resteasy_modules">
<title>Other RESTEasy modules</title>
<para>
Not all RESTEasy modules are bundled with WildFly. For example,
<code>resteasy-fastinfoset-provider</code> and <code>resteasy-wadl</code> are not included among the
modules listed in <xref linkend="resteasy_modules_in_wildfly"/>. If you want
to use them in your application, you can include them in your WAR as you would if you were
deploying outside of WildFly. See <xref linkend="standalone_resteasy"/> for more information.
</para>
</section>
<section id="upgrading-wildfly">
<title>Upgrading RESTEasy within WildFly</title>
<para>
RESTEasy is bundled with WildFly, but you may want to upgrade RESTEasy in WildFly to the latest version. The RESTEasy
distribution comes with a zip file called <code><![CDATA[resteasy-jboss-modules-3.13.2.Final.zip]]></code>. Unzip this file
within the <![CDATA[modules/system/layers/base/]]> directory of the WildFly distribution. This will configure WildFly
to use new versions of the modules listed in <xref linkend="resteasy_modules_in_wildfly"/>.
</para>
<para>
To build the <code><![CDATA[resteasy-jboss-modules-3.13.2.Final.zip]]></code>, enter the <code>jboss-modules</code>
directory of the project, and run the following Maven command:
<programlisting><![CDATA[$ mvn install]]></programlisting>
It will start to build the modules and finally it will produce the zip file inside "target" directory:
<programlisting><![CDATA[$ pwd
resteasy/jboss-modules
$ ls target/*.zip
target/resteasy-jboss-modules-3.13.2.Final-mavenized.zip
target/resteasy-jboss-modules-3.13.2.Final.zip
]]></programlisting>
</para>
<para>
To use the zip file, you need to copy it into Wildfly's "modules" directory:
<programlisting><![CDATA[$ pwd
wildfly
$ ls
LICENSE.txt bin domain standalone
README.txt copyright.txt jboss-modules.jar welcome-content
appclient docs modules
]]></programlisting>
</para>
<para>
Use the following step to copy and extract the modules zip into Wildfly modules directory:
<programlisting><![CDATA[
$ cp ~/works/resteasy/jboss-modules/target/resteasy-jboss-modules-3.13.2.Final.zip \
modules/system/layers/base/
$ cd modules/system/layers/base
$ unzip resteasy-jboss-modules-3.13.2.Final.zip
...]]></programlisting>
With the above process, the RESTEasy modules are upgraded inside Wildfly.
</para>
</section>
</section>
<section>
<title>Deploying a RESTEasy application to WildFly</title>
<para>
RESTEasy is bundled with WildFly and completely integrated as per the requirements of Java EE.
You can use it with EJB and CDI and you can rely completely on WildFly to scan for and deploy your JAX-RS services and providers.
All you have to provide is your JAX-RS service and provider classes packaged
within a WAR either as POJOs, CDI beans, or EJBs.
A simple way to configure an application is by simply providing an empty web.xml file.
You can of course deploy any custom servlet, filter
or security constraint you want to within your web.xml, but none of them are required:
</para>
<para>
<programlisting><![CDATA[
<web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
</web-app>]]></programlisting>
</para>
<para>
Also, web.xml can supply to RESTEasy init-params and context-params (see <xref linkend="configuration_switches"/>)
if you want to tweak or turn on/off any specific RESTEasy feature.
</para>
<para>
Since we're not using a <servlet-mapping> element, we must define a
<classname>javax.ws.rs.core.Application</classname> class (see <xref linkend="javax.ws.rs.core.Application"/>) that is annotated with
the <classname>javax.ws.rs.ApplicationPath</classname> annotation. If you return any empty set for classes and singletons,
which is the behavior inherited from <classname>Application</classname>, your WAR will
be scanned for resource and provider classes as indicated by the presence of JAX-RS annotations.
</para>
<programlisting>
import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;
@ApplicationPath("/root-path")
public class MyApplication extends Application
{
} </programlisting>
<para>
<emphasis role="bold">Note.</emphasis> Actually, if the application jar contains an
<classname>Application</classname> class (or a subclass thereof)
which is annotated with an <classname>ApplicationPath</classname> annotation, a web.xml file isn't even needed.
Of course, even in this case it can be used to specify additional information such as context parameters.
If there is an <classname>Application</classname> class but it doesn't have an
<classname>@ApplicationPath</classname> annotation, then a web.xml file with at least a
<servlet-mapping> element is required.
</para>
<para>
<emphasis role="bold">Note.</emphasis> As mentioned in <xref linkend="other_resteasy_modules"/>,
not all RESTEasy modules are bundled with WildFly. For example,
resteasy-fastinfoset-provider and resteasy-wadl are not included among the
modules listed in <xref linkend="resteasy_modules_in_wildfly"/>. If you want
to use them in your application, you can include them in your WAR as you would if you were
deploying outside of WildFly. See <xref linkend="standalone_resteasy"/> for more information.
</para>
</section>
<section id="standalone_resteasy">
<title>Deploying to other servlet containers</title>
<para>
If you are using RESTEasy outside of WildFly, in a standalone servlet container like Tomcat or Jetty, for example,
you will need to include the appropriate RESTEasy jars in your WAR file. You will need the core classes
in the resteasy-jaxrs module, and you may need additional facilities like the resteasy-jaxb-provider module.
We strongly suggest that you use Maven to build your WAR files as RESTEasy is split into
a bunch of different modules:
</para>
<programlisting><![CDATA[
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-jaxrs</artifactId>
<version>${resteasy.version}</version>
</dependency>
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-jaxb-provider</artifactId>
<version>${resteasy.version}</version>
</dependency>
]]></programlisting>
<para>
You can see sample Maven projects in
<ulink url="https://github.com/resteasy/resteasy-examples">https://github.com/resteasy/resteasy-examples</ulink>.
</para>
<para>
If you are not using Maven, you can include the necessary jars by hand. If you download
RESTEasy (from <ulink url="http://resteasy.jboss.org/downloads.html">http://resteasy.jboss.org/downloads.html</ulink>,
for example) you will get a file like resteasy-jaxrs-<version>-all.zip.
If you unzip it you will see a lib/ directory that contains the libraries needed by RESTEasy.
Copy these, as needed, into your /WEB-INF/lib directory. Place your JAX-RS annotated class resources and providers
within one or more jars within /WEB-INF/lib or your raw class files within /WEB-INF/classes.
</para>
<section>
<title>Servlet 3.0 containers</title>
<para>
RESTEasy provides an implementation of the Servlet 3.0 <literal>ServletContainerInitializer</literal>
integration interface for containers to use in initializing an application.
The container calls this interface during the application's startup phase.
The RESTEasy implementation performs automatic scanning for resources and providers,
and programmatic registration of a servlet.
RESTEasy's implementation is provided in maven artifact, <literal>resteasy-servlet-initializer</literal>.
Add this artifact dependency to your project's pom.xml file so the JAR file will be included
in your WAR file.
</para>
<programlisting><![CDATA[
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-servlet-initializer</artifactId>
<version>${resteasy.version}</version>
</dependency>
]]></programlisting>
</section>
<section>
<title>Older servlet containers</title>
<para>
The <literal>resteasy-servlet-initializer</literal> artifact will not work in Servlet versions older than
3.0. You'll then have to manually declare the RESTEasy servlet in your WEB-INF/web.xml file of your WAR project,
and you'll have to use an <classname>Application</classname> class (see <xref linkend="javax.ws.rs.core.Application"/>)
which explicitly lists resources and providers. For example:
</para>
<para>
<programlisting><![CDATA[
<web-app>
<display-name>Archetype Created Web Application</display-name>
<servlet>
<servlet-name>Resteasy</servlet-name>
<servlet-class>
org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher
</servlet-class>
<init-param>
<param-name>javax.ws.rs.Application</param-name>
<param-value>com.restfully.shop.services.ShoppingApplication</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>Resteasy</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>]]></programlisting>
</para>
<para>
The RESTEasy servlet is responsible for initializing some basic components of RESTEasy.
</para>
<para>
<emphasis role="bold">Note.</emphasis> It is likely that support for pre-3.0 Servlet specifications
will be deprecated and eliminated eventually.
</para>
</section>
</section>
<section id="config_mechanisms">
<title>Configuring RESTEasy</title>
<para>
RESTEasy has two mutually exclusive mechanisms for retrieving configuration parameters
(see <xref linkend="configuration_switches"/>).
The classic mechanism depends predominantly on context-params and init-params. Alternatively,
the Eclipse MicroProfile Config project
(<ulink url="https://github.com/eclipse/microprofile-config">https://github.com/eclipse/microprofile-config</ulink>)
provides a flexible parameter retrieval mechanism that RESTEasy will use if the necessary
dependencies are available. See <xref linkend="configuring_mp_config"/> for more about that. If
they are not available, it will fall back to the classic mechanism.
</para>
<section id="microprofile_config">
<title>RESTEasy with MicroProfile Config</title>
<para>
In the presence of the Eclipse MicroProfile Config API jar and an implementation
of the API (see <xref linkend="configuring_mp_config"/>), RESTEasy will use the facilities
of MicroProfile Config for accessing configuration properties (see <xref linkend="configuration_switches"/>).
MicroProfile Config offers to both RESTEasy users and RESTEasy developers a great deal of
flexibility in controlling runtime configuration.
</para>
<para>
In MicroProfile Config, a <classname>ConfigSource</classname> represents a <classname>Map<String, String></classname>
of property names to values, and a <classname>Config</classname> represents a sequence of <classname>ConfigSource</classname>s,
ordered by priority. The priority of a <classname>ConfigSource</classname> is given by an ordinal (represented by an
<classname>int</classname>), with a higher value indicating a higher priority. For a given property name, the
<classname>ConfigSource</classname>s are searched in order until a value is found.
</para>
<para>
MicroProfile Config mandates the presence of the following <classname>ConfigSource</classname>s:
</para>
<orderedlist>
<listitem>a <classname>ConfigSource</classname> based on System.getProperties() (ordinal = 400)</listitem>
<listitem>a <classname>ConfigSource</classname> based on System.getenv() (ordinal = 300)</listitem>
<listitem>a <classname>ConfigSource</classname> for each META-INF/microprofile-config.properties file on the ClassPath,
separately configurable via a config_ordinal property inside each file (default ordinal = 100)</listitem>
</orderedlist>
<para>
Note that a property which is found among the System properties and which is also in the System environment will be assigned
the System property value because of the relative priorities of the <classname>ConfigSource</classname>s.
</para>
<para>
The set of <classname>ConfigSources</classname> is extensible. For example, smallrye-config
(<ulink url="https://github.com/smallrye/smallrye-config">https://github.com/smallrye/smallrye-config</ulink>),
the implementation of the MicroProfile Config specification currently used by RESTEasy, adds, among others,
the following kinds of <classname>ConfigSource</classname>s:
</para>
<orderedlist>
<listitem><classname>PropertiesConfigSource</classname> creates a <classname>ConfigSource</classname> from a
Java <classname>Properties</classname> object or a Map<String, String> object or a properties file
(referenced by its URL) (default ordinal = 100).</listitem>
<listitem><classname>DirConfigSource</classname> creates a <classname>ConfigSource</classname> that will look into a directory
where each file corresponds to a property (the file name is the property key and its textual content is the property value).
This <classname>ConfigSource</classname> can be used to read configuration from Kubernetes ConfigMap (default ordinal = 100).</listitem>
</orderedlist>
<para>
These can be registered programmatically by using an instance of <classname>ConfigProviderResolver</classname>:
</para>
<programlisting>
Config config = new PropertiesConfigSource("file:/// ...");
ConfigProviderResolver.instance().registerConfig(config, getClass().getClassLoader());
</programlisting>
<para>where <classname>ConfigProviderResolver</classname> is part of the Eclipse MicroProfile Config API.</para>
<para>
If the application is running in WildFly, then WildFly provides another set of <classname>ConfigSource</classname>s,
as described in the "MicroProfile Config Subsystem Configuration" section of the WildFly Admin guide.
You can find the most recent WildFly documentation at <ulink url="https://docs.wildfly.org/">https://docs.wildfly.org/</ulink>.
</para>
<para>
Finally, RESTEasy automatically provides three more <classname>ConfigSource</classname>s:
</para>
<itemizedlist>
<listitem><classname>org.jboss.resteasy.microprofile.config.ServletConfigSource</classname> represents
a servlet's <init-param>s from web.xml (ordinal = 60).</listitem>
<listitem><classname>org.jboss.resteasy.microprofile.config.FilterConfigSource</classname> represents
a filter's <init-param>s from web.xml (ordinal = 50). (See <xref linkend="filter"/> for more information.)
</listitem>
<listitem><classname>org.jboss.resteasy.microprofile.config.ServletContextConfigSource</classname> represents
<context-param>s from web.xml (ordinal = 40).</listitem>
</itemizedlist>
<section>
<title>Using MicroProfileConfig</title>
<para>
The MicroProfile Config API is very simple. A <classname>Config</classname> may be obtained either
programatically:
</para>
<programlisting>
Config config = ConfigProvider.getConfig();
</programlisting>
<para>
or, in the presence of CDI, by way of injection:
</para>
<programlisting>
@Inject Config config;
</programlisting>
<para>
Once a <classname>Config</classname> has been obtained, a property can be queried. For example,
</para>
<programlisting>
String s = config.getValue("prop_name", String.class);
</programlisting>
<para>
or
</para>
<programlisting>
String s = config.getOptionalValue("prop_name", String.class).orElse("d'oh");
</programlisting>
<para>
Now, consider a situation in which "prop_name" has been set by <code>System.setProperty("prop_name", "system")</code>
and also by
</para>
<programlisting>
<context-param>
<param-name>prop_name</param-name>
<param-value>context</param-value>
</context-param>
</programlisting>
<para>
Then, since the system parameter <classname>ConfigSource</classname> has precedence over (has a higher ordinal than)
<classname>ServletContextConfigSource</classname>, <code>config.getValue("prop_name", String.class)</code> will
return "system" rather than "context".
</para>
</section>
<section id="configuring_mp_config">
<title>Configuring MicroProfile Config</title>
<para>
In order for RESTEasy to take advantage of MicroProfile Config, it
will need the Eclipse MicroProfile Config API and also an implementation like SmallRye Config
(see <ulink url="https://github.com/smallrye/smallrye-config">https://github.com/smallrye/smallrye-config</ulink>).
WildFly 19, for example, has the necessary jars. If they are not provided by the environment,
then an application must be configured appropriately. In maven, for example, use
</para>
<programlisting>
<dependency>
<groupId>org.eclipse.microprofile.config</groupId>
<artifactId>microprofile-config-api</artifactId>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.smallrye.config</groupId>
<artifactId>smallrye-config</artifactId>
<scope>runtime</scope>
</dependency>
</programlisting>
</section>
</section>
<section id="classic_config">
<title>RESTEasy's classic configuration mechanism</title>
<para>
In the absence of the relevant MicroProfile Config jars, RESTEasy falls back to its
original behavior to access configuration parameters (see <xref linkend="configuration_switches"/>).
In the original mechanism, nearly all of RESTEasy's parameters are servlet init-params and
context-params, and which ones are available depends on how a web application invokes RESTEasy.
</para>
<para>
If RESTEasy is invoked as a servlet, as in
</para>
<programlisting>
<web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
<context-param>
<param-name>system</param-name>
<param-value>system-context</param-value>
</context-param>
<servlet>
<servlet-name>Resteasy</servlet-name>
<servlet-class>org.jboss.resteasy.plugins.server.servlet.HttpServlet30Dispatcher</servlet-class>
<init-param>
<param-name>system</param-name>
<param-value>system-init</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>Resteasy</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
</programlisting>
<para>
then the servlet specific init-params and the general context-params are available,
with the former taking precedence over the latter. For example, the property "system" would
have the value "system-init".
</para>
<para>
If RESTEasy is invoked by way of a filter (see <xref linkend="filter"/>), as in
</para>
<programlisting>
<web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
<context-param>
<param-name>system</param-name>
<param-value>system-context</param-value>
</context-param>
<filter>
<filter-name>Resteasy</filter-name>
<filter-class>org.jboss.resteasy.plugins.server.servlet.FilterDispatcher</filter-class>
<init-param>
<param-name>system</param-name>
<param-value>system-filter</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>Resteasy</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
</programlisting>
<para>
then the filter specific init-params and the general context-params are available,
with the former taking precedence over the latter. For example, the property "system" would
have the value "system-filter".
</para>
<para>
Finally, if RESTEasy is invoked by way of a ServletContextListener (see <xref linkend="listener"/>), as in
</para>
<programlisting>
<web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
<listener>
<listener-class>
org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap
</listener-class>
</listener>
<context-param>
<param-name>system</param-name>
<param-value>system-context</param-value>
</context-param>
</web-app>
</programlisting>
<para>
where <classname>ResteasyBootstrap</classname> is a <classname>ServletContextListener</classname>,
then the context-params are available.
</para>
</section>
</section>
<section id="configuration_switches">
<title>Configuration switches</title>
<para>RESTEasy can receive the following configuration options as described in
<xref linkend="config_mechanisms"/>.
</para>
<para>
<table frame="topbot">
<tgroup cols="3" rowsep="1" colsep="1">
<thead>
<row>
<entry>
Option Name
</entry>
<entry>
Default Value
</entry>
<entry>
Description
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
resteasy.servlet.mapping.prefix
</entry>
<entry>
no default
</entry>
<entry>
If the url-pattern for the RESTEasy servlet-mapping is not /*
</entry>
</row>
<row>
<entry>
resteasy.providers
</entry>
<entry>
no default
</entry>
<entry>
A comma delimited list of fully qualified @Provider class names you want to register
</entry>
</row>
<row>
<entry>
resteasy.disable.providers
</entry>
<entry>
no default
</entry>
<entry>
A comma delimited list of fully qualified JAX-RS @Provider class names that will be disabled.
</entry>
</row>
<row>
<entry>
resteasy.use.builtin.providers
</entry>
<entry>
true
</entry>
<entry>
Whether or not to register default, built-in @Provider classes
</entry>
</row>
<row>
<entry>
resteasy.resources
</entry>
<entry>
no default
</entry>
<entry>
A comma delimited list of fully qualified JAX-RS resource class names you want to
register
</entry>
</row>
<row>
<entry>
resteasy.jndi.resources
</entry>
<entry>
no default
</entry>
<entry>
A comma delimited list of JNDI names which reference objects you want to register as
JAX-RS resources
</entry>
</row>
<row>
<entry>
javax.ws.rs.Application
</entry>
<entry>
no default
</entry>
<entry>
Fully qualified name of Application class to bootstrap in a spec portable way
</entry>
</row>
<row>
<entry>
resteasy.media.type.mappings
</entry>
<entry>
no default
</entry>
<entry>
Replaces the need for an Accept header by mapping file name extensions (like .xml or
.txt) to a media type. Used when the client
is unable to use an Accept header to choose a representation (i.e. a browser). See
<xref linkend="JAX-RS_Content_Negotiation"/> for more details.
</entry>
</row>
<row>
<entry>
resteasy.language.mappings
</entry>
<entry>
no default
</entry>
<entry>
Replaces the need for an Accept-Language header by mapping file name extensions (like
.en or .fr) to a language. Used when the client
is unable to use an Accept-Language header to choose a language (i.e. a browser). See
<xref linkend="JAX-RS_Content_Negotiation"/> for more details.
</entry>
</row>
<row>
<entry>
resteasy.media.type.param.mapping
</entry>
<entry>
no default
</entry>
<entry>
Names a query parameter that can be set to an acceptable media type,
enabling content negotiation without an Accept header. See
<xref linkend="JAX-RS_Content_Negotiation"/> for more details.
</entry>
</row>
<row>
<entry>
resteasy.role.based.security
</entry>
<entry>
false
</entry>
<entry>
Enables role based security. See <xref linkend="Securing_JAX-RS_and_RESTeasy"/>
for more details.
</entry>
</row>
<row>
<entry>
resteasy.document.expand.entity.references
</entry>
<entry>
false
</entry>
<entry>
Expand external entities in org.w3c.dom.Document documents
and JAXB object representations
</entry>
</row>
<row>
<entry>
resteasy.document.secure.processing.feature
</entry>
<entry>
true
</entry>
<entry>
Impose security constraints in processing org.w3c.dom.Document documents
and JAXB object representations
</entry>
</row>
<row>
<entry>
resteasy.document.secure.disableDTDs
</entry>
<entry>
true
</entry>
<entry>
Prohibit DTDs in org.w3c.dom.Document documents
and JAXB object representations
</entry>
</row>
<row>
<entry>
resteasy.wider.request.matching
</entry>
<entry>
false
</entry>
<entry>
Turns off the JAX-RS spec defined class-level expression filtering and instead
tries to match version every method's full path.
</entry>
</row>
<row>
<entry>
resteasy.use.container.form.params
</entry>
<entry>
false
</entry>
<entry>
Obtain form parameters by using HttpServletRequest.getParameterMap().
Use this switch if you are calling this method within a servlet filter or eating
the input stream within the filter.
</entry>
</row>
<row>
<entry>
resteasy.rfc7232preconditions
</entry>
<entry>
false
</entry>
<entry>
Enables <link linkend='Http_Precondition'>RFC7232 compliant HTTP preconditions handling</link>.
</entry>
</row>
<row>
<entry>
resteasy.gzip.max.input
</entry>
<entry>
10000000
</entry>
<entry>
Imposes maximum size on decompressed gzipped .
</entry>
</row>
<row>