WildFly 33 Model Reference

The configuration of the Jakarta RESTful Web Services subsystem.

Attributes (23)

  • 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.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • 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.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • resteasy-buffer-exception-entity Upon receiving an exception, the client side buffers any response entity before closing the connection.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • 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.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • resteasy-disable-providers A comma delimited list of fully qualified provider class names that will be disabled.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • 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.
    Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • 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.
    Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • resteasy-document-secure-processing-feature Impose security constraints in processing org.w3c.dom.Document documents and Jakarta XML Binding object representations.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • resteasy-gzip-max-input Imposes maximum size on decompressed gzipped.
    • Attribute Value
    Default Value 10000000
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • resteasy-jndi-resources A comma delimited list of JNDI names which reference objects to be registered as Jakarta RESTful Web Services resources.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • 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).
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • 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).
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • 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.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • resteasy-prefer-jackson-over-jsonb Specifies that the Jackson JSON provider should be preferred over the default Jakarta JSON Processing provider for JSON binding.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • resteasy-providers A comma delimited list of fully qualified @Provider class names you want to register.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • resteasy-rfc7232preconditions Enables RFC7232 compliant HTTP preconditions handling.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • resteasy-role-based-security Enables role based security.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • resteasy-secure-random-max-use The number of times a SecureRandom can be used before reseeding.
    • Attribute Value
    Default Value 100
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • resteasy-use-builtin-providers Whether or not to register default, built-in @Provider classes.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • 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.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • 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.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • 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.
    • Attribute Value
    Default Value SUMMARY
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values SUMMARY
    TRACE
    VERBOSE
    Stability default
  • 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.
    • Attribute Value
    Default Value OFF
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values OFF
    ON_DEMAND
    ALL
    Stability default

Operations (2)

  • add Operation creating the Jakarta RESTful Web Services subsystem.
    Request Parameter Type Required Expressions Allowed Default value Description
    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.
  • remove Operation removing the Jakarta RESTful Web Services subsystem.