Management API Reference for subsystem=jaxrs

The configuration of the Jakarta RESTful Web Services subsystem.

Stability Level: default

Attributes (25)

jaxrs-2-0-request-matching - In searching for a matching resource method with which to respond to a request, consider only resource methods with the best match for the request path.

Deprecated Since 6.0.0

This attribute has been deprecated and has no effect. It will be removed in a future release.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "In searching for a matching resource method with which to respond to a request, consider only resource methods with the best match for the request path.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "deprecated" : { "since" : "6.0.0", "reason" : "This attribute has been deprecated and has no effect. It will be removed in a future release." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

resteasy-add-charset - If a resource method returns a text/* or application/xml* media type without an explicit charset, RESTEasy will add "charset=UTF-8" to the returned Content-Type header. Note that the charset defaults to UTF-8 in this case, independent of the setting of this parameter.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If a resource method returns a text/* or application/xml* media type without an explicit charset, RESTEasy will add \"charset=UTF-8\" to the returned Content-Type header. Note that the charset defaults to UTF-8 in this case, independent of the setting of this parameter.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

resteasy-buffer-exception-entity - Upon receiving an exception, the client side buffers any response entity before closing the connection.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Upon receiving an exception, the client side buffers any response entity before closing the connection.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-disable-html-sanitizer - Normally, a response with media type "text/html" and a status of 400 will be processed so that the characters "/", "<", ">", "&", """ (double quote), and "'" (single quote) are escaped to prevent an XSS attack. Setting this parameter to "true", escaping will not occur.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Normally, a response with media type \"text/html\" and a status of 400 will be processed so that the characters \"/\", \"<\", \">\", \"&\", \"\"\" (double quote), and \"'\" (single quote) are escaped to prevent an XSS attack. Setting this parameter to \"true\", escaping will not occur.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

resteasy-disable-providers - A comma delimited list of fully qualified provider class names that will be disabled.

Type	LIST
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A comma delimited list of fully qualified provider class names that will be disabled.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-document-expand-entity-references - Expand external entities in org.w3c.dom.Document documents and Jakarta XML Binding object representations.

Deprecated Since 3.0.0

This JAXP feature does not behave the same in all JAXP implementations and is therefore deprecated.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Expand external entities in org.w3c.dom.Document documents and Jakarta XML Binding object representations.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "deprecated" : { "since" : "3.0.0", "reason" : "This JAXP feature does not behave the same in all JAXP implementations and is therefore deprecated." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

resteasy-document-secure-disableDTDs - Prohibit DTDs in org.w3c.dom.Document documents and Jakarta XML Binding object representations.

Deprecated Since 3.0.0

This JAXP feature does not behave the same in all JAXP implementations and is therefore deprecated.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Prohibit DTDs in org.w3c.dom.Document documents and Jakarta XML Binding object representations.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "deprecated" : { "since" : "3.0.0", "reason" : "This JAXP feature does not behave the same in all JAXP implementations and is therefore deprecated." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

resteasy-document-secure-processing-feature - Impose security constraints in processing org.w3c.dom.Document documents and Jakarta XML Binding object representations.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Impose security constraints in processing org.w3c.dom.Document documents and Jakarta XML Binding object representations.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-gzip-max-input - Imposes maximum size on decompressed gzipped.

Type	INT
Default Value	10000000
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Imposes maximum size on decompressed gzipped.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10000000, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-jndi-resources - A comma delimited list of JNDI names which reference objects to be registered as Jakarta RESTful Web Services resources.

Type	LIST
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A comma delimited list of JNDI names which reference objects to be registered as Jakarta RESTful Web Services resources.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

resteasy-language-mappings - 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).

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "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).", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

resteasy-media-type-mappings - 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).

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "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).", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

resteasy-media-type-param-mapping - Names a query parameter that can be set to an acceptable media type, enabling content negotiation without an Accept header.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Names a query parameter that can be set to an acceptable media type, enabling content negotiation without an Accept header.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-original-webapplicationexception-behavior - When set to true, this parameter will restore the original behavior in which a Client running in a resource method will throw a WebApplicationException instead of a RESTEeasy version with a sanitized Response.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "When set to true, this parameter will restore the original behavior in which a Client running in a resource method will throw a WebApplicationException instead of a RESTEeasy version with a sanitized Response.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

resteasy-patchfilter-disabled - Specifies that JSON Patch and JSON Merge Patch functionalities are all disabled.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies that JSON Patch and JSON Merge Patch functionalities are all disabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-prefer-jackson-over-jsonb - Specifies that the Jackson JSON provider should be preferred over the default Jakarta JSON Processing provider for JSON binding.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies that the Jackson JSON provider should be preferred over the default Jakarta JSON Processing provider for JSON binding.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-providers - A comma delimited list of fully qualified @Provider class names you want to register.

Type	LIST
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A comma delimited list of fully qualified @Provider class names you want to register.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-rfc7232preconditions - Enables RFC7232 compliant HTTP preconditions handling.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enables RFC7232 compliant HTTP preconditions handling.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-role-based-security - Enables role based security.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enables role based security.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-secure-random-max-use - The number of times a SecureRandom can be used before reseeding.

Type	INT
Default Value	100
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of times a SecureRandom can be used before reseeding.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 100, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-use-builtin-providers - Whether or not to register default, built-in @Provider classes.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether or not to register default, built-in @Provider classes.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-use-container-form-params - HttpServletRequest.getParameterMap(). Use this switch if you are calling this method within a servlet filter or consuming the input stream within the filter.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "HttpServletRequest.getParameterMap(). Use this switch if you are calling this method within a servlet filter or consuming the input stream within the filter.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

resteasy-wider-request-matching - Turns off the Jakarta RESTful Web Services spec defined class-level expression filtering and instead tries to match every method's full path.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Turns off the Jakarta RESTful Web Services spec defined class-level expression filtering and instead tries to match every method's full path.", "attribute-group" : "resteasy", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

tracing-threshold - The "SUMMARY" threshold will emit some brief tracing information. The "TRACE" threshold will produce more detailed tracing information, and the "VERBOSE" threshold will generate extremely detailed tracing information.

Type	STRING
Default Value	SUMMARY
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	TRACE SUMMARY VERBOSE
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The \"SUMMARY\" threshold will emit some brief tracing information. The \"TRACE\" threshold will produce more detailed tracing information, and the \"VERBOSE\" threshold will generate extremely detailed tracing information.", "attribute-group" : "tracing", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "SUMMARY", "allowed" : [ "SUMMARY", "TRACE", "VERBOSE" ], "stability" : "default", "access-constraints" : {"sensitive" : {"tracing-management" : {"type" : "jaxrs"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

tracing-type - "ALL" will enable the tracing feature. "ON_DEMAND" mode will give control to the client side: A client can send a tracing request via HTTP header and get the tracing info back from response headers. "OFF" mode will disable the tracing feature, and this is the default mode. Note that it is suggested this is set to "OFF" for production servers.

Type	STRING
Default Value	OFF
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	ALL ON_DEMAND OFF
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "\"ALL\" will enable the tracing feature. \"ON_DEMAND\" mode will give control to the client side: A client can send a tracing request via HTTP header and get the tracing info back from response headers. \"OFF\" mode will disable the tracing feature, and this is the default mode. Note that it is suggested this is set to \"OFF\" for production servers.", "attribute-group" : "tracing", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "OFF", "allowed" : [ "ALL", "OFF", "ON_DEMAND" ], "stability" : "default", "access-constraints" : {"sensitive" : {"tracing-management" : {"type" : "jaxrs"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

add - Operation creating the Jakarta RESTful Web Services subsystem.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
resteasy-original-webapplicationexception-behavior	BOOLEAN	false	true	false	When set to true, this parameter will restore the original behavior in which a Client running in a resource method will throw a WebApplicationException instead of a RESTEeasy version with a sanitized Response.
resteasy-patchfilter-disabled	BOOLEAN	false	true	false	Specifies that JSON Patch and JSON Merge Patch functionalities are all disabled.
jaxrs-2-0-request-matching	BOOLEAN	false	true	false	In searching for a matching resource method with which to respond to a request, consider only resource methods with the best match for the request path.
resteasy-add-charset	BOOLEAN	false	true	true	If a resource method returns a text/* or application/xml* media type without an explicit charset, RESTEasy will add "charset=UTF-8" to the returned Content-Type header. Note that the charset defaults to UTF-8 in this case, independent of the setting of this parameter.
resteasy-buffer-exception-entity	BOOLEAN	false	true	true	Upon receiving an exception, the client side buffers any response entity before closing the connection.
resteasy-disable-html-sanitizer	BOOLEAN	false	true	false	Normally, a response with media type "text/html" and a status of 400 will be processed so that the characters "/", "<", ">", "&", """ (double quote), and "'" (single quote) are escaped to prevent an XSS attack. Setting this parameter to "true", escaping will not occur.
resteasy-disable-providers	LIST	false	true		A comma delimited list of fully qualified provider class names that will be disabled.
resteasy-document-expand-entity-references	BOOLEAN	false	true	false	Expand external entities in org.w3c.dom.Document documents and Jakarta XML Binding object representations.
resteasy-document-secure-disableDTDs	BOOLEAN	false	true	true	Prohibit DTDs in org.w3c.dom.Document documents and Jakarta XML Binding object representations.
resteasy-document-secure-processing-feature	BOOLEAN	false	true	true	Impose security constraints in processing org.w3c.dom.Document documents and Jakarta XML Binding object representations.
resteasy-gzip-max-input	INT	false	true	10000000	Imposes maximum size on decompressed gzipped.
resteasy-jndi-resources	LIST	false	true		A comma delimited list of JNDI names which reference objects to be registered as Jakarta RESTful Web Services resources.
resteasy-language-mappings	OBJECT	false	true		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).
resteasy-media-type-mappings	OBJECT	false	true		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).
resteasy-media-type-param-mapping	STRING	false	true		Names a query parameter that can be set to an acceptable media type, enabling content negotiation without an Accept header.
resteasy-prefer-jackson-over-jsonb	BOOLEAN	false	true	false	Specifies that the Jackson JSON provider should be preferred over the default Jakarta JSON Processing provider for JSON binding.
resteasy-providers	LIST	false	true		A comma delimited list of fully qualified @Provider class names you want to register.
resteasy-rfc7232preconditions	BOOLEAN	false	true	false	Enables RFC7232 compliant HTTP preconditions handling.
resteasy-role-based-security	BOOLEAN	false	true	false	Enables role based security.
resteasy-secure-random-max-use	INT	false	true	100	The number of times a SecureRandom can be used before reseeding.
resteasy-use-builtin-providers	BOOLEAN	false	true	true	Whether or not to register default, built-in @Provider classes.
resteasy-use-container-form-params	BOOLEAN	false	true	false	HttpServletRequest.getParameterMap(). Use this switch if you are calling this method within a servlet filter or consuming the input stream within the filter.
resteasy-wider-request-matching	BOOLEAN	false	true	false	Turns off the Jakarta RESTful Web Services spec defined class-level expression filtering and instead tries to match every method's full path.
tracing-threshold	STRING	false	true	SUMMARY	The "SUMMARY" threshold will emit some brief tracing information. The "TRACE" threshold will produce more detailed tracing information, and the "VERBOSE" threshold will generate extremely detailed tracing information.
tracing-type	STRING	false	true	OFF	"ALL" will enable the tracing feature. "ON_DEMAND" mode will give control to the client side: A client can send a tracing request via HTTP header and get the tracing info back from response headers. "OFF" mode will disable the tracing feature, and this is the default mode. Note that it is suggested this is set to "OFF" for production servers.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Operation creating the Jakarta RESTful Web Services subsystem.",
    "request-properties" : {
        "resteasy-original-webapplicationexception-behavior" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "When set to true, this parameter will restore the original behavior in which a Client running in a resource method will throw a WebApplicationException instead of a RESTEeasy version with a sanitized Response.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "resteasy-patchfilter-disabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Specifies that JSON Patch and JSON Merge Patch functionalities are all disabled.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "jaxrs-2-0-request-matching" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "In searching for a matching resource method with which to respond to a request, consider only resource methods with the best match for the request path.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default",
            "deprecated" : {
                "since" : "6.0.0",
                "reason" : "This attribute has been deprecated and has no effect. It will be removed in a future release."
            }
        },
        "resteasy-add-charset" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If a resource method returns a text/* or application/xml* media type without an explicit charset, RESTEasy will add \"charset=UTF-8\" to the returned Content-Type header. Note that the charset defaults to UTF-8 in this case, independent of the setting of this parameter.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "resteasy-buffer-exception-entity" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Upon receiving an exception, the client side buffers any response entity before closing the connection.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "resteasy-disable-html-sanitizer" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Normally, a response with media type \"text/html\" and a status of 400 will be processed so that the characters \"/\", \"<\", \">\", \"&\", \"\"\" (double quote), and \"'\" (single quote) are escaped to prevent an XSS attack. Setting this parameter to \"true\", escaping will not occur.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "resteasy-disable-providers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "A comma delimited list of fully qualified provider class names that will be disabled.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "resteasy-document-expand-entity-references" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Expand external entities in org.w3c.dom.Document documents and Jakarta XML Binding object representations.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default",
            "deprecated" : {
                "since" : "3.0.0",
                "reason" : "This JAXP feature does not behave the same in all JAXP implementations and is therefore deprecated."
            }
        },
        "resteasy-document-secure-disableDTDs" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Prohibit DTDs in org.w3c.dom.Document documents and Jakarta XML Binding object representations.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default",
            "deprecated" : {
                "since" : "3.0.0",
                "reason" : "This JAXP feature does not behave the same in all JAXP implementations and is therefore deprecated."
            }
        },
        "resteasy-document-secure-processing-feature" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Impose security constraints in processing org.w3c.dom.Document documents and Jakarta XML Binding object representations.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "resteasy-gzip-max-input" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Imposes maximum size on decompressed gzipped.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10000000,
            "stability" : "default"
        },
        "resteasy-jndi-resources" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "A comma delimited list of JNDI names which reference objects to be registered as Jakarta RESTful Web Services resources.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "resteasy-language-mappings" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "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).",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "resteasy-media-type-mappings" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "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).",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "resteasy-media-type-param-mapping" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Names a query parameter that can be set to an acceptable media type, enabling content negotiation without an Accept header.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "resteasy-prefer-jackson-over-jsonb" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Specifies that the Jackson JSON provider should be preferred over the default Jakarta JSON Processing provider for JSON binding.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "resteasy-providers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "A comma delimited list of fully qualified @Provider class names you want to register.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "resteasy-rfc7232preconditions" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enables RFC7232 compliant HTTP preconditions handling.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "resteasy-role-based-security" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enables role based security.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "resteasy-secure-random-max-use" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The number of times a SecureRandom can be used before reseeding.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 100,
            "stability" : "default"
        },
        "resteasy-use-builtin-providers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether or not to register default, built-in @Provider classes.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "resteasy-use-container-form-params" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "HttpServletRequest.getParameterMap(). Use this switch if you are calling this method within a servlet filter or consuming the input stream within the filter.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "resteasy-wider-request-matching" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Turns off the Jakarta RESTful Web Services spec defined class-level expression filtering and instead tries to match every method's full path.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "tracing-threshold" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The \"SUMMARY\" threshold will emit some brief tracing information. The \"TRACE\" threshold will produce more detailed tracing information, and the \"VERBOSE\" threshold will generate extremely detailed tracing information.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "SUMMARY",
            "allowed" : [
                "SUMMARY",
                "TRACE",
                "VERBOSE"
            ],
            "stability" : "default"
        },
        "tracing-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "\"ALL\" will enable the tracing feature. \"ON_DEMAND\" mode will give control to the client side: A client can send a tracing request via HTTP header and get the tracing info back from response headers. \"OFF\" mode will disable the tracing feature, and this is the default mode. Note that it is suggested this is set to \"OFF\" for production servers.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "OFF",
            "allowed" : [
                "ALL",
                "OFF",
                "ON_DEMAND"
            ],
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Operation removing the Jakarta RESTful Web Services subsystem.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Operation removing the Jakarta RESTful Web Services subsystem.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.jaxrs

        
<feature spec="subsystem.jaxrs">
  <param name="jaxrs-2-0-request-matching" value="{value}"/>
  <param name="resteasy-add-charset" value="{value}"/>
  <param name="resteasy-buffer-exception-entity" value="{value}"/>
  <param name="resteasy-disable-html-sanitizer" value="{value}"/>
  <param name="resteasy-disable-providers" value="{value}"/>
  <param name="resteasy-document-expand-entity-references" value="{value}"/>
  <param name="resteasy-document-secure-disableDTDs" value="{value}"/>
  <param name="resteasy-document-secure-processing-feature" value="{value}"/>
  <param name="resteasy-gzip-max-input" value="{value}"/>
  <param name="resteasy-jndi-resources" value="{value}"/>
  <param name="resteasy-language-mappings" value="{value}"/>
  <param name="resteasy-media-type-mappings" value="{value}"/>
  <param name="resteasy-media-type-param-mapping" value="{value}"/>
  <param name="resteasy-original-webapplicationexception-behavior" value="{value}"/>
  <param name="resteasy-patchfilter-disabled" value="{value}"/>
  <param name="resteasy-prefer-jackson-over-jsonb" value="{value}"/>
  <param name="resteasy-providers" value="{value}"/>
  <param name="resteasy-rfc7232preconditions" value="{value}"/>
  <param name="resteasy-role-based-security" value="{value}"/>
  <param name="resteasy-secure-random-max-use" value="{value}"/>
  <param name="resteasy-use-builtin-providers" value="{value}"/>
  <param name="resteasy-use-container-form-params" value="{value}"/>
  <param name="resteasy-wider-request-matching" value="{value}"/>
  <param name="tracing-threshold" value="{value}"/>
  <param name="tracing-type" value="{value}"/>
<feature/>