Table of Contents
List of common configuration properties that can be found in CommonProperties class. All of these properties can be overridden by their server/client counterparts.
Table A.1. List of common configuration properties
Constant | Value | Description | |||||
---|---|---|---|---|---|---|---|
CommonProperties.ALLOW_SYSTEM_PROPERTIES_PROVIDER | jersey.config.allowSystemPropertiesProvider |
Property which allows (if true) default System properties configuration provider.
Default value is | |||||
CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLE / CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLE_CLIENT / CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLE_SERVER | jersey.config.disableAutoDiscovery /
jersey.config.client.disableAutoDiscovery /
jersey.config.server.disableAutoDiscovery |
Disables feature auto discovery globally on client/server. Default value is | |||||
CommonProperties.JSON_BINDING_FEATURE_DISABLE / CommonProperties.JSON_BINDING_FEATURE_DISABLE_CLIENT / CommonProperties.JSON_BINDING_FEATURE_DISABLE_SERVER | jersey.config.disableJsonBinding /
jersey.config.client.disableJsonBinding /
jersey.config.server.disableJsonBinding |
Disables configuration of Json Binding (JSR-367) feature. Default value is Since 2.45. | |||||
CommonProperties.JSON_BINDING_FEATURE_DISABLE_APPLICATION | jersey.config.application.disableJsonBinding |
Disables configuration of Json Binding (JSR-367) feature for By default, Json Binding is automatically enabled. Since 2.45. | |||||
CommonProperties.JSON_PROCESSING_FEATURE_DISABLE / CommonProperties.JSON_PROCESSING_FEATURE_DISABLE_CLIENT / CommonProperties.JSON_PROCESSING_FEATURE_DISABLE_SERVER | jersey.config.disableJsonProcessing /
jersey.config.client.disableJsonProcessing /
jersey.config.server.disableJsonProcessing |
Disables configuration of Json Processing (JSR-353) feature. Default value is | |||||
CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE / CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE_CLIENT / CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE_SERVER | jersey.config.disableMetainfServicesLookup /
jersey.config.client.disableMetainfServicesLookup /
jersey.config.server.disableMetainfServicesLookup |
Disables META-INF/services lookup globally on client/server. Default value is | |||||
CommonProperties.MOXY_JSON_FEATURE_DISABLE / CommonProperties.MOXY_JSON_FEATURE_DISABLE_CLIENT / CommonProperties.MOXY_JSON_FEATURE_DISABLE_SERVER | jersey.config.disableMoxyJson /
jersey.config.client.disableMoxyJson /
jersey.config.server.disableMoxyJson |
Disables configuration of MOXy Json feature. Default value is | |||||
CommonProperties.OUTBOUND_CONTENT_LENGTH_BUFFER / CommonProperties.OUTBOUND_CONTENT_LENGTH_BUFFER_CLIENT / CommonProperties.OUTBOUND_CONTENT_LENGTH_BUFFER_SERVER | jersey.config.contentLength.buffer /
jersey.config.client.contentLength.buffer /
jersey.config.server.contentLength.buffer |
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 | |||||
CommonProperties.PROVIDER_DEFAULT_DISABLE |
jersey.config.disableDefaultProvider
|
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:
NULL
@since 2.30
| |||||
CommonProperties.JSON_JACKSON_ENABLED_MODULES / CommonProperties.JSON_JACKSON_ENABLED_MODULES_CLIENT / CommonProperties.JSON_JACKSON_ENABLED_MODULES_SERVER |
jersey.config.json.jackson.enabled.modules
jersey.config.client.json.jackson.enabled.modules
jersey.config.server.json.jackson.enabled.modules
|
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 NULL
@since 2.36
| |||||
CommonProperties.JSON_JACKSON_DISABLED_MODULES / CommonProperties.JSON_JACKSON_DISABLED_MODULES_CLIENT / CommonProperties.JSON_JACKSON_DISABLED_MODULES_SERVER |
jersey.config.json.jackson.disabled.modules
jersey.config.client.json.jackson.disabled.modules
jersey.config.server.json.jackson.disabled.modules
|
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 NULL
@since 2.36
| |||||
CommonProperties.PARAM_CONVERTERS_THROW_IAE(Jersey 2.40 or later) |
jersey.config.paramconverters.throw.iae
|
Force the ParamConverter<T> to throw
Internally the | |||||
CommonProperties.THREAD_FACTORY(Jersey 3.1.7 or later) |
jersey.config.threads.factory
|
Defines the
The default is | |||||
CommonProperties.USE_VIRTUAL_THREADS(Jersey 3.1.7 or later) |
jersey.config.threads.use.virtual
|
Defines whether the virtual threads should be used by Jersey on JDK 21+ when not using an exact number
of threads by
The default is | |||||
LoggingFeature.LOGGING_FEATURE_LOGGER_NAME |
jersey.config.logging.logger.name
|
Logger name of the logging filter.
See logging chapter for more information.
The default value is org.glassfish.jersey.logging.LoggingFeature
| |||||
LoggingFeature.LOGGING_FEATURE_LOGGER_LEVEL |
jersey.config.logging.logger.level
| Level of logging filter's logger at which the messages will be logged. See logging chapter for more information. | |||||
LoggingFeature.LOGGING_FEATURE_VERBOSITY |
jersey.config.logging.verbosity
|
Verbosity of logging filter describes how verbose the logging filter will be.
There are 3 possible values LoggingFeature.Verbosity.HEADERS_ONLY ,
LoggingFeature.Verbosity.PAYLOAD_TEXT or
LoggingFeature.Verbosity.PAYLOAD_ANY .
See logging chapter for more information.
| |||||
LoggingFeature.LOGGING_FEATURE_MAX_ENTITY_SIZE |
jersey.config.logging.entity.maxSize
| The maximum number of bytes of the entity which will be logged. See logging chapter for more information. | |||||
LoggingFeature.LOGGING_FEATURE_SEPARATOR |
jersey.config.logging.entity.separator
| Custom logging delimiter for new lines separation. See logging chapter for more information. | |||||
LoggingFeature.LOGGING_FEATURE_REDACT_HEADERS |
jersey.config.logging.headers.redact
| The HTTP headers (semicolon separated) to be redacted when logging. See logging chapter for more information. |
List of server configuration properties that can be found in ServerProperties class.
Table A.2. List of server configuration properties
Constant | Value | Description |
---|---|---|
ServerProperties.APPLICATION_NAME | jersey.config.server.application.name |
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. |
ServerProperties.BV_FEATURE_DISABLE | jersey.config.beanValidation.disable.server |
Disables Bean Validation support. Default value is |
ServerProperties .BV_DISABLE_VALIDATE_ON_EXECUTABLE_OVERRIDE_CHECK | jersey.config.beanValidation
.disable.validateOnExecutableCheck.server |
Disables |
ServerProperties.BV_SEND_ERROR_IN_RESPONSE | jersey.config.beanValidation
.enableOutputValidationErrorEntity.server |
Enables sending validation error information to the client. Default value is |
ServerProperties.EMPTY_REQUEST_MEDIA_TYPE_MATCHES_ANY_CONSUMES | jersey.config.server.empty.request.media.matches.any.consumes |
Jakarta RESTful WebServices provides
HTTP/1.1 RFC recommends that missing HTTP
Set this property to |
ServerProperties.FEATURE_AUTO_DISCOVERY_DISABLE | jersey.config.server.disableAutoDiscovery |
Disables feature auto discovery on server. Default value is |
ServerProperties.HTTP_METHOD_OVERRIDE | jersey.config.server.httpMethodOverride |
Defines configuration of HTTP method overriding. This property is used by HttpMethodOverrideFilter to determine where it should look for method override information (e.g. request header or query parameters). |
ServerProperties.JSON_BINDING_FEATURE_DISABLE | jersey.config.server.disableJsonBinding |
Disables configuration of Json Processing (JSR-353) feature. Default value is |
ServerProperties.JSON_PROCESSING_FEATURE_DISABLE | jersey.config.server.disableJsonProcessing |
Disables configuration of Json Processing (JSR-353) feature. Default value is |
ServerProperties.LANGUAGE_MAPPINGS | jersey.config.server.languageMappings |
Defines mapping of URI extensions to languages. The property is used by UriConnegFilter. |
ServerProperties.MEDIA_TYPE_MAPPINGS | jersey.config.server.mediaTypeMappings |
Defines mapping of URI extensions to media types. The property is used by UriConnegFilter. |
ServerProperties.METAINF_SERVICES_LOOKUP_DISABLE | jersey.config.server.disableMetainfServicesLookup |
Disables META-INF/services lookup on server. Default value is |
ServerProperties.MOXY_JSON_FEATURE_DISABLE | jersey.config.server.disableMoxyJson |
Disables configuration of MOXy Json feature. Default value is |
ServerProperties.MONITORING_ENABLED (Jersey 2.12 or later) | jersey.config.server
.monitoring.statistics.enabled |
If |
ServerProperties.MONITORING_STATISTICS_ENABLED | jersey.config.server
.monitoring.enabled |
If |
ServerProperties.MONITORING_STATISTICS_MBEANS_ENABLED | jersey.config.server
.monitoring.statistics.mbeans.enabled |
If |
ServerProperties.MONITORING_STATISTICS_REFRESH_INTERVAL (Jersey 2.10 or later) | jersey.config.server
.monitoring.statistics.refresh.interval |
Interval (in |
ServerProperties.OUTBOUND_CONTENT_LENGTH_BUFFER (Jersey 2.2 or later) | jersey.config.contentLength.server.buffer |
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 |
ServerProperties.PROVIDER_CLASSNAMES | jersey.config.server.provider.classnames |
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. |
ServerProperties.PROVIDER_CLASSPATH | jersey.config.server.provider.classpath |
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. |
ServerProperties.PROVIDER_PACKAGES | jersey.config.server.provider.packages |
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. |
ServerProperties.PROVIDER_SCANNING_RECURSIVE | jersey.config.server
.provider.scanning.recursive |
Sets the recursion strategy for package scanning. Default value is |
ServerProperties.REDUCE_CONTEXT_PATH_SLASHES_ENABLED | jersey.config.server.reduceContextPathSlashes.enabled |
Ignores multiple slashes between a port and a context path and will resolve it
as URI with only one slash. Default value is |
ServerProperties.RESOURCE_VALIDATION_DISABLE | jersey.config.server
.resource.validation.disable |
Disables |
ServerProperties.RESOURCE_VALIDATION_IGNORE_ERRORS | jersey.config.server
.resource.validation.ignoreErrors |
Determines whether validation of application resource models should fail even in case of a fatal
validation errors. Default value is |
ServerProperties.WADL_FEATURE_DISABLE | jersey.config.server.wadl.disableWadl |
Disables WADL generation. Default value is |
ServerProperties.WADL_GENERATOR_CONFIG | jersey.config.server.wadl.generatorConfig |
Defines the wadl generator configuration that provides a WadlGenerator. |
ServerProperties.RESPONSE_SET_STATUS_OVER_SEND_ERROR | jersey.config.server.response.setStatusOverSendError |
Whenever response status is |
ServerProperties.TRACING | jersey.config.server.tracing.type |
Enables/disables tracing support. Possible values are |
ServerProperties.TRACING_THRESHOLD | jersey.config.server.tracing.threshold |
Sets the amount of detail provided by tracing. Possible values are |
ServerProperties.PROCESSING_RESPONSE_ERRORS_ENABLED | jersey.config.server.exception.processResponseErrors |
If property value is |
ServerProperties.SUBRESOURCE_LOCATOR_CACHE_SIZE | jersey.config.server.subresource.cache.size |
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. |
ServerProperties.SUBRESOURCE_LOCATOR_CACHE_AGE | jersey.config.server.subresource.cache.age |
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. |
ServerProperties.SUBRESOURCE_LOCATOR_CACHE_JERSEY_RESOURCE_ENABLED | jersey.config.server.subresource.cache.jersey.resource.enabled |
If |
ServerProperties.LOCATION_HEADER_RELATIVE_URI_RESOLUTION_RFC7231 | jersey.config.server.headers.location.relative.resolution.rfc7231 |
If |
ServerProperties.LOCATION_HEADER_RELATIVE_URI_RESOLUTION_DISABLED | jersey.config.server.headers.location.relative.resolution.disabled |
If |
ServerProperties.UNWRAP_COMPLETION_STAGE_IN_WRITER_ENABLE | jersey.config.server.unwrap.completion.stage.writer.enable |
If |
LoggingFeature.LOGGING_FEATURE_LOGGER_NAME_SERVER |
jersey.config.server.logging.logger.name
|
Logger name of the logging filter.
See logging chapter for more information.
The default value is org.glassfish.jersey.logging.LoggingFeature
|
LoggingFeature.LOGGING_FEATURE_LOGGER_LEVEL_SERVER |
jersey.config.server.logging.logger.level
| Level of logging filter's logger at which the messages will be logged. See logging chapter for more information. |
LoggingFeature.LOGGING_FEATURE_VERBOSITY_SERVER |
jersey.config.server.logging.verbosity
|
Verbosity of logging filter describes how verbose the logging filter will be.
There are 3 possible values LoggingFeature.Verbosity.HEADERS_ONLY ,
LoggingFeature.Verbosity.PAYLOAD_TEXT or
LoggingFeature.Verbosity.PAYLOAD_ANY .
See logging chapter for more information.
|
LoggingFeature.LOGGING_FEATURE_MAX_ENTITY_SIZE_SERVER |
jersey.config.server.logging.entity.maxSize
| The maximum number of bytes of the entity which will be logged. See logging chapter for more information. |
LoggingFeature.LOGGING_FEATURE_SEPARATOR_SERVER |
jersey.config.server.logging.entity.separator
| Custom delimiter for new lines separation. See logging chapter for more information. |
LoggingFeature.LOGGING_FEATURE_REDACT_HEADERS_SERVER |
jersey.config.server.logging.headers.redact
| The HTTP headers (semicolon separated) to be redacted when logging. See logging chapter for more information. |
List of SeBootstrap configuration properties that can be found in ServerProperties class.
Table A.3. List of SeBootstrap and WebServer configuration properties
Constant | Value | Description |
---|---|---|
ServerProperties.WEBSERVER_ALLOW_PRIVILEGED_PORTS | jersey.config.server.bootstrap.webserver.allow.privileged.ports |
Defines whether to allow privileged ports (0-1023) to be used to start the
The default ports are 80 for HTTP and 443 for HTTPS when
If
The default this is |
ServerProperties.WEBSERVER_AUTO_START | jersey.config.server.bootstrap.webserver.autostart |
Whether to automatically startup
By default, servers are immediately listening to connections after bootstrap,
so no explicit invocation of |
ServerProperties.WEBSERVER_CLASS | jersey.config.server.bootstrap.webserver.class |
Defines the implementation of By default auto-selects the first server provider found. |
List of servlet configuration properties that can be found in ServletProperties class.
Table A.4. List of servlet configuration properties
Constant | Value | Description |
---|---|---|
ServletProperties.FILTER_CONTEXT_PATH | jersey.config.servlet.filter.contextPath |
If set, indicates the URL pattern of the Jersey servlet filter context path. |
ServletProperties.FILTER_FORWARD_ON_404 | jersey.config.servlet.filter.forwardOn404 |
If set to |
ServletProperties.FILTER_STATIC_CONTENT_REGEX | jersey.config.servlet.filter.staticContentRegex |
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. |
ServletProperties.JAXRS_APPLICATION_CLASS | jakarta.ws.rs.Application |
Application configuration initialization property whose value is a fully qualified class name of a class that implements JAX-RS Application. |
ServletProperties.PROVIDER_WEB_APP | jersey.config.servlet.provider.webapp |
Indicates that Jersey should scan the whole web app for application-specific resources and providers. |
ServletProperties.QUERY_PARAMS_AS_FORM_PARAMS_DISABLED | jersey.config.servlet.form.queryParams.disabled |
If |
ServletProperties.SERVICE_LOCATOR | jersey.config.servlet.context.serviceLocator |
Identifies the object that will be used as a parent ServiceLocator in the Jersey WebComponent. |
List of client configuration properties that can be found in ClientProperties class.
Table A.5. List of client configuration properties
Constant | Value | Description |
---|---|---|
ClientProperties.ASYNC_THREADPOOL_SIZE | jersey.config.client.async.threadPoolSize |
Asynchronous thread pool size. Default value is not set. Supported with GrizzlyConnectorProvider only.. |
ClientProperties.BACKGROUND_SCHEDULER_THREADPOOL_SIZE | jersey.config.client.backgroundScheduler.threadPoolSize |
Scheduler thread pool size. Default value is not set. Support is undefined. |
ClientProperties.CHUNKED_ENCODING_SIZE | jersey.config.client.chunkedEncodingSize |
Chunked encoding size. Default value is |
ClientProperties.CONNECT_TIMEOUT | jersey.config.client.connectTimeout |
Read timeout interval, in milliseconds. Default value is |
ClientProperties.CONNECTOR_PROVIDER(Jersey 2.40 or later) | jersey.config.client.connector.provider |
Sets the ConnectorProvider class. Overrides the value from META-INF/services.
The value MUST be an instance of
The property is recognized by |
ClientProperties.DIGESTAUTH_URI_CACHE_SIZELIMIT | jersey.config.client.digestAuthUriCacheSizeLimit |
The property defines a URI of a HTTP proxy the client connector should use. |
ClientProperties.EXPECT_100_CONTINUE | jersey.config.client.request.expect.100.continue.processing |
Allows for HTTP Expect:100-Continue being handled by the HttpUrlConnector (default Jersey
connector). |
ClientProperties.EXPECT_100_CONTINUE_THRESHOLD_SIZE | jersey.config.client.request.expect.100.continue.threshold.size |
Property for threshold size for content length after which Expect:100-Continue header would be applied
before the main request.
Default threshold size (64kb) after which Expect:100-Continue header would be applied before
the main request.
|
ClientProperties.FEATURE_AUTO_DISCOVERY_DISABLE | jersey.config.client.disableAutoDiscovery |
Disables feature auto discovery on client. Default value is |
ClientProperties.FOLLOW_REDIRECTS | jersey.config.client.followRedirects |
Declares that the client will automatically redirect to the URI declared in 3xx responses. Default value is |
ClientProperties.JSON_BINDING_FEATURE_DISABLE | jersey.config.client.disableJsonBinding |
Disables configuration of Json Binding (JSR-367) feature. Default value is |
ClientProperties.JSON_PROCESSING_FEATURE_DISABLE | jersey.config.client.disableJsonProcessing |
Disables configuration of Json Processing (JSR-353) feature. Default value is |
ClientProperties.METAINF_SERVICES_LOOKUP_DISABLE | jersey.config.disableMetainfServicesLookup.client |
Disables META-INF/services lookup on client. Default value is |
ClientProperties.MOXY_JSON_FEATURE_DISABLE | jersey.config.client.disableMoxyJson |
Disables configuration of MOXy Json feature. Default value is |
ClientProperties.OUTBOUND_CONTENT_LENGTH_BUFFER (Jersey 2.2 or later) | jersey.config.client.contentLength.buffer |
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 |
ClientProperties.PROXY_URI | jersey.config.client.proxy.uri |
URI of a HTTP proxy the client connector should use. Default value is not set. Currently supported with ApacheConnectorProvider, Apache5ConnectorProvider, GrizzlyConnectorProvider, HelidonConnectorProvider, NettyConnectorProvider, Jetty11ConnectorProvider, and JettyConnectorProvider only. |
ClientProperties.PROXY_USERNAME (Jersey 2.5 or later) | jersey.config.client.proxy.username |
User name which will be used for HTTP proxy authentication. Default value is not set. Currently supported with ApacheConnectorProvider and JettyConnectorProvider only. |
ClientProperties.PROXY_PASSWORD (Jersey 2.5 or later) | jersey.config.client.proxy.password |
Password which will be used for HTTP proxy authentication. Default value is not set. Currently supported with ApacheConnectorProvider and JettyConnectorProvider only. |
ClientProperties.READ_TIMEOUT (Jersey 2.5 or later) | jersey.config.client.readTimeout |
Read timeout interval, in milliseconds. Default value is |
ClientProperties.REQUEST_ENTITY_PROCESSING (Jersey 2.5 or later) | jersey.config.client.request.entity.processing |
Defines whether the request entity should be serialized using internal buffer to
evaluate content length or chunk encoding should be used. Possible values are
|
ClientProperties.SNI_HOST_NAME (Jersey 2.43 or later) | jersey.config.client.sniHostName |
Sets the host name to be used for calculating the
By default, the |
ClientProperties.SUPPRESS_HTTP_COMPLIANCE_VALIDATION (Jersey 2.2 or later) | jersey.config.client.suppressHttpComplianceValidation |
If |
ClientProperties.SSL_CONTEXT_SUPPLIER | jersey.config.client.ssl.context.supplier |
The
Currently supported by the default |
ClientProperties.USE_ENCODING | jersey.config.client.useEncoding |
Indicates the value of |
ClientProperties.SNI_HOST_NAME | jersey.config.client.sniHostName |
Most connectors support HOST header value to be used as an SNIHostName. However, the HOST header is restricted in JDK.
The value MUST be an instance of |
LoggingFeature.LOGGING_FEATURE_LOGGER_NAME_CLIENT |
jersey.config.client.logging.logger.name
|
Logger name of the logging filter.
See logging chapter for more information.
The default value is org.glassfish.jersey.logging.LoggingFeature
|
LoggingFeature.LOGGING_FEATURE_LOGGER_LEVEL_CLIENT |
jersey.config.client.logging.logger.level
| Level of logging filter's logger at which the messages will be logged. See logging chapter for more information. |
LoggingFeature.LOGGING_FEATURE_VERBOSITY_CLIENT |
jersey.config.client.logging.verbosity
|
Verbosity of logging filter describes how verbose the logging filter will be.
There are 3 possible values LoggingFeature.Verbosity.HEADERS_ONLY ,
LoggingFeature.Verbosity.PAYLOAD_TEXT or
LoggingFeature.Verbosity.PAYLOAD_ANY .
See logging chapter for more information.
|
LoggingFeature.LOGGING_FEATURE_MAX_ENTITY_SIZE_CLIENT |
jersey.config.client.logging.entity.maxSize
| The maximum number of bytes of the entity which will be logged. See logging chapter for more information. |
LoggingFeature.LOGGING_FEATURE_SEPARATOR_CLIENT |
jersey.config.client.logging.entity.separator
| New line delimiter property (client side). See logging chapter for more information. |
LoggingFeature.LOGGING_FEATURE_REDACT_HEADERS_CLIENT |
jersey.config.client.logging.headers.redact
| The HTTP headers (semicolon separated) to be redacted when logging. See logging chapter for more information. |
List of client configuration properties that can be found in MessageProperties class.
Table A.6. List of Apache HTTP client configuration properties
Constant | Value | Description |
---|---|---|
MessageProperties.DEFLATE_WITHOUT_ZLIB | jersey.config.deflate.nozlib |
If set to
The default value is |
MessageProperties.IO_BUFFER_SIZE | jersey.config.io.bufferSize |
Value of the property indicates the buffer size to be used for I/O operations on byte and character streams. The property value is expected to be a positive integer otherwise it will be ignored. The default value is value of MessageProperties.IO_DEFAULT_BUFFER_SIZE. |
MessageProperties.JAXB_PROCESS_XML_ROOT_ELEMENT | jersey.config.jaxb.collections.processXmlRootElement |
If set to
The default value is |
MessageProperties.JSON_MAX_STRING_LENGTH | jersey.config.json.string.length |
The default value is not set and the JSON provider default maximum value is used.
If supported by Jackson provider, the default value can differ for each Jackson version. For instance,
Jackson 2.14 does not support this setting and the default value is |
MessageProperties.XML_SECURITY_DISABLE | jersey.config.xml.security.disable |
If set to
The default value is |
MessageProperties.XML_FORMAT_OUTPUT | jersey.config.xml.formatOutput |
If set to A XML message entity written by a MessageBodyWriter<T> may be formatted for the purposes of human readability provided the respective MessageBodyWriter<T> supports XML output formatting. All JAXB-based message body writers support this property.
The default value is |
List of properties defined in HttpUrlConnectorProvider class.
Table A.7. List of the default HttpUrlConnectorProvider properites
Constant | Value | Description |
---|---|---|
HttpUrlConnector.SET_METHOD_WORKAROUND | jersey.config.client.httpUrlConnection.setMethodWorkaround |
A value of NOTE: Enabling this property may cause security related warnings/errors and it may break when other JDK implementation is used. Use only when you know what you are doing.
The value MUST be an instance of Since JDK 16 the JDK internal classes are not opened for reflection and the workaround method
does not work, unless |
HttpUrlConnectorProvider.USE_FIXED_LENGTH_STREAMING | jersey.config.client.httpUrlConnector.useFixedLengthStreaming |
If
When this property is enabled and the request has a valid non-zero content length
value specified in its
Note that the content length value defined in the request header must exactly match
the real size of the entity. If the This property also overrides the behaviour enabled by the ClientProperties.CHUNKED_ENCODING_SIZE property. Chunked encoding will only be used, if the size is not specified in the header of the request.
Note that this property only applies to client run-times that are configured to use the default
The default value is |
List of client configuration properties that can be found in ApacheClientProperties class.
Table A.8. List of Apache HTTP client configuration properties
Constant | Value | Description |
---|---|---|
ApacheClientProperties.CONNECTION_CLOSING_STRATEGY | jersey.config.apache.client.connectionClosingStrategy |
Strategy that closes the Apache Connection. Accepts an instance of ApacheConnectionClosingStrategy. |
ApacheClientProperties.CONNECTION_MANAGER | jersey.config.apache.client.connectionManager |
Connection Manager which will be used to create
The value MUST be an instance of
If the property is absent a default Connection Manager will be used
|
ApacheClientProperties.CONNECTION_MANAGER_SHARED | jersey.config.apache.client.connectionManagerShared |
A value of This property may only be set prior to constructing Apache connector using ApacheConnectorProvider
The value MUST be an instance of
The default value is |
ApacheClientProperties.CREDENTIALS_PROVIDER | jersey.config.apache.client.credentialsProvider |
The credential provider that should be used to retrieve credentials from a user. Credentials needed for proxy authentication are stored here as well.
The value MUST be an instance of If the property is absent a default provider will be used. |
ApacheClientProperties.DISABLE_COOKIES | jersey.config.apache.client.handleCookies |
A value of
The value MUST be an instance of
The default value is |
ApacheClientProperties.KEEPALIVE_STRATEGY | jersey.config.apache.client.keepAliveStrategy |
Apache
The value MUST be an instance of If the property is absent the default keepalive strategy of the Apache HTTP library will be used. |
ApacheClientProperties.PREEMPTIVE_BASIC_AUTHENTICATION | jersey.config.apache.client.preemptiveBasicAuthentication |
A value of This property may only be set prior to constructing Apache connector using ApacheConnectorProvider.
The value MUST be an instance of
The default value is |
ApacheClientProperties.REQUEST_CONFIG | jersey.config.apache.client.requestConfig |
Request configuration for the
The value MUST be an instance of If the property is absent the default request configuration will be used. |
ApacheClientProperties.RETRY_HANDLER | jersey.config.apache.client.retryHandler |
Apache
The value MUST be an instance of
If the property is absent a default retry handler will be used
( |
ApacheClientProperties.REUSE_STRATEGY | jersey.config.apache.client.reuseStrategy |
Apache
The value MUST be an instance of If the property is absent the default reuse strategy of the Apache HTTP library will be used. |
ApacheClientProperties.USE_SYSTEM_PROPERTIES | jersey.config.apache.client.useSystemProperties |
A value of
The value MUST be an instance of
The default value is |
List of client configuration properties that can be found in Apache5ClientProperties class.
Table A.9. List of Apache 5 HTTP client configuration properties
Constant | Value | Description |
---|---|---|
Apache5ClientProperties.CONNECTION_CLOSING_STRATEGY | jersey.config.apache5.client.connectionClosingStrategy |
Strategy that closes the Apache Connection. Accepts an instance of Apache5ConnectionClosingStrategy. |
Apache5ClientProperties.CONNECTION_MANAGER | jersey.config.apache5.client.connectionManager |
Connection Manager which will be used to create
The value MUST be an instance of
If the property is absent a default Connection Manager will be used
|
Apache5ClientProperties.CONNECTION_MANAGER_SHARED | jersey.config.apache5.client.connectionManagerShared |
A value of This property may only be set prior to constructing Apache connector using Apache5ConnectorProvider
The value MUST be an instance of
The default value is |
Apache5ClientProperties.CREDENTIALS_PROVIDER | jersey.config.apache5.client.credentialsProvider |
The credential provider that should be used to retrieve credentials from a user. Credentials needed for proxy authentication are stored here as well.
The value MUST be an instance of If the property is absent a default provider will be used. |
ApacheC5lientProperties.DISABLE_COOKIES | jersey.config.apache5.client.handleCookies |
A value of
The value MUST be an instance of
The default value is |
Apache5ClientProperties.KEEPALIVE_STRATEGY | jersey.config.apache5.client.keepAliveStrategy |
Apache
The value MUST be an instance of If the property is absent the default keepalive strategy of the Apache HTTP library will be used. |
Apache5ClientProperties.PREEMPTIVE_BASIC_AUTHENTICATION | jersey.config.apache5.client.preemptiveBasicAuthentication |
A value of This property may only be set prior to constructing Apache connector using Apache5ConnectorProvider.
The value MUST be an instance of
The default value is |
Apache5ClientProperties.REQUEST_CONFIG | jersey.config.apache5.client.requestConfig |
Request configuration for the
The value MUST be an instance of If the property is absent the default request configuration will be used. |
Apache5ClientProperties.RETRY_STRATEGY | jersey.config.apache5.client.retryStrategy |
Apache
The value MUST be an instance of
If the property is absent a default retry handler will be used
( |
Apache5ClientProperties.REUSE_STRATEGY | jersey.config.apache5.client.reuseStrategy |
Apache
The value MUST be an instance of If the property is absent the default reuse strategy of the Apache HTTP library will be used. |
Apache5ClientProperties.USE_SYSTEM_PROPERTIES | jersey.config.apache5.client.useSystemProperties |
A value of
The value MUST be an instance of
The default value is |
List of client configuration properties that can be found in HelidonClientProperties class.
Table A.10. List of Helidon HTTP client configuration properties
Constant | Value | Description |
---|---|---|
HelidonClientProperties.CONFIG | jersey.connector.helidon.config |
A Helidon |
List of client configuration properties that can be found in JdkConnectorProperties class.
Table A.11. List of Jdk HTTP client configuration properties
Constant | Value | Description |
---|---|---|
JdkConnectorProperties.CONTAINER_IDLE_TIMEOUT | jersey.config.client.JdkConnectorProvider.containerIdleTimeout |
Container idle timeout in milliseconds
The default value is |
JdkConnectorProperties.COOKIE_POLICY | jersey.config.client.JdkConnectorProvider.cookiePolicy |
To set the cookie policy of this cookie manager. When the timeout elapses, the shared thread pool will be destroyed. The default value is JdkConnectorProperties.DEFAULT_CONNECTION_CLOSE_WAIT. |
JdkConnectorProperties.CONNECTION_IDLE_TIMEOUT | jersey.config.client.JdkConnectorProvider.connectionIdleTimeout |
An amount of time in milliseconds ( The default value is JdkConnectorProperties.DEFAULT_CONNECTION_IDLE_TIMEOUT. |
JdkConnectorProperties.MAX_CONNECTIONS_PER_DESTINATION | jersey.config.client.JdkConnectorProvider.maxConnectionsPerDestination |
A maximum number of open connections per each destination. A destination is determined by the
following triple: The default value is JdkConnectorProperties.DEFAULT_MAX_CONNECTIONS_PER_DESTINATION. |
JdkConnectorProperties.MAX_HEADER_SIZE | jersey.config.client.JdkConnectorProvider.maxHeaderSize |
A configurable property of HTTP parser. It defines the maximal acceptable size of HTTP response initial line, each header and chunk header. The default value is JdkConnectorProperties.DEFAULT_MAX_HEADER_SIZE. |
JdkConnectorProperties.MAX_REDIRECTS | jersey.config.client.JdkConnectorProvider.maxRedirects |
The maximal number of redirects during single request.
Value is expected to be positive HTTP redirection must be enabled by property ClientProperties.FOLLOW_REDIRECTS, otherwise JdkConnectorProperties.MAX_REDIRECTS is not applied. |
JdkConnectorProperties.WORKER_THREAD_POOL_CONFIG | jersey.config.client.JdkConnectorProvider.workerThreadPoolConfig |
Configuration of the connector thread pool.
An instance of |
List of client configuration properties that can be found in JettyClientProperties class.
Table A.12. List of Jetty HTTP client configuration properties
Constant | Value | Description |
---|---|---|
JettyClientProperties.DISABLE_COOKIES | jersey.config.jetty.client.disableCookies |
A value of
The value MUST be an instance of |
JettyClientProperties.ENABLE_SSL_HOSTNAME_VERIFICATION | jersey.config.jetty.client.disableCookies |
A value of
The value MUST be an instance of |
JettyClientProperties.PREEMPTIVE_BASIC_AUTHENTICATION | jersey.config.jetty.client.preemptiveBasicAuthentication |
The credential provider that should be used to retrieve credentials from a user.
If an
The value MUST be an instance of |
JettyClientProperties.SYNC_LISTENER_RESPONSE_MAX_SIZE | jersey.config.jetty.client.syncListenerResponseMaxSize |
Overrides the default Jetty synchronous listener response max buffer size. In practise, this allows you to read larger responses. Size in bytes. If the property is absent, the value is such as specified by Jetty (currently 2MiB). |
JettyClientProperties.TOTAL_TIMEOUT | jersey.config.jetty.client.totalTimeout |
Total timeout interval for request/response conversation, in milliseconds. Opposed to ClientProperties.READ_TIMEOUT.
The value MUST be an instance convertible to
The default value is |
List of client configuration properties that can be found in NettyClientProperties class.
Table A.13. List of Netty HTTP client configuration properties
Constant | Value | Description |
---|---|---|
NettyClientProperties.FILTER_HEADERS_FOR_PROXY | jersey.config.client.filter.headers.proxy |
Filter the HTTP headers for requests (CONNECT) towards the proxy except for
The default value is |
NettyClientProperties.IDLE_CONNECTION_PRUNE_TIMEOUT | jersey.config.client.idleConnectionPruneTimeout |
This property determines the number of seconds the idle connections are kept in the pool before pruned. The default is 60. Specify 0 to disable. |
NettyClientProperties.MAX_CONNECTIONS | jersey.config.client.maxConnections |
This property determines the maximum number of idle connections that will be simultaneously kept alive, per destination. The default is 5.
This property is a Jersey alternative to System property |
NettyClientProperties.MAX_CONNECTIONS_TOTAL | jersey.config.client.maxTotalConnections |
This property determines the maximum number of idle connections that will be simultaneously kept alive in total, rather than per destination. The default is 60. Specify 0 to disable. |
NettyClientProperties.MAX_REDIRECTS | jersey.config.client.NettyConnectorProvider.maxRedirect |
This property determines the maximal number of redirects during single request. Value is expected to be positive number. Default value is 5. HTTP redirection must be enabled by property org.glassfish.jersey.client.ClientProperties.FOLLOW_REDIRECTS otherwise NettyClientProperties.MAX_REDIRECTS is not applied. |
NettyClientProperties.PRESERVE_METHOD_ON_REDIRECT | jersey.config.client.redirect.preserve.method |
Sets the HTTP POST method to be preserved on HTTP status 301 (MOVED PERMANENTLY) or status 302 (FOUND)
when
The default value is |
NettyClientProperties.EXPECT_100_CONTINUE_TIMEOUT | jersey.config.client.request.expect.100.continue.timeout |
This timeout is used for waiting for 100-Continue response when 100-Continue
is sent by the client.
Default timeout value is 500 ms after which Expect:100-Continue feature is ignored.
|
NettyClientProperties.MAX_HEADER_SIZE | jersey.config.client.netty.maxHeaderSize |
Parameter which allows extending of the header size for the Netty connector
Default header size is 8192b.
|
NettyClientProperties.MAX_CHUNK_SIZE | jersey.config.client.netty.maxChunkSize |
Parameter which allows extending of the chunk size for the Netty connector
Default chunk size is 8192b.
|
NettyClientProperties.MAX_INITIAL_LINE_LENGTH | jersey.config.client.netty.maxInitialLineLength |
Parameter which allows extending of the initial line length for the Netty connector
Default initial line length is 4096b.
|
List of client configuration properties that can be found in JavaNetHttpClientProperties class.
Table A.14. List of Java Net HTTP client configuration properties
Constant | Value | Description |
---|---|---|
JavaNetHttpClientProperties.COOKIE_HANDLER | jersey.config.jnh.client.cookieHandler |
Configuration of the
A provided value to this option has to be of type |
JavaNetHttpClientProperties.SSL_PARAMETERS | jersey.config.jnh.client.sslParameters |
Configuration of SSL parameters used by the
A provided value to this option has to be of type |
JavaNetHttpClientProperties.PREEMPTIVE_BASIC_AUTHENTICATION | jersey.config.jnh.client.preemptiveBasicAuthentication |
An instance of the Authenticator class which represents an object that knows how to obtain authentication for a network connection should be used.
If an
The value MUST be an instance of |
JavaNetHttpClientProperties.DISABLE_COOKIES | jersey.config.jnh.client.disableCookies |
A value of
The value MUST be an instance of
The default value is |
JavaNetHttpClientProperties.HTTP_VERSION | jersey.config.jnh.client.httpVersion |
HTTP version - if null or instance of HttpClient.Version.HTTP_1_1 the version will be set to HTTP_1_1. If version is HttpClient.Version.HTTP_2 the client will attempt to perform each request using HTTP_2 protocol but if not supported by server, the protocol will be still HTTP_1_1
The value MUST be an instance of
The default value is |
List of multipart configuration properties that can be found in MultiPartProperties class.
Table A.15. List of multipart configuration properties settable in the MultiPartProperties.MULTI_PART_CONFIG_RESOURCE configuration file.
Constant | Value | Description |
---|---|---|
MultiPartProperties.BUFFER_THRESHOLD | jersey.config.multipart.bufferThreshold |
Name of the resource property for the threshold size (in bytes) above which a body part entity will be buffered to disk instead of being held in memory. The default value is MessageProperties.IO_DEFAULT_BUFFER_SIZE |
MultiPartProperties.MAX_PARTS | jersey.config.multipart.maxParts |
Limit the maximum number of parts the multipart entity can have. If the limit is over,
the error response status By default, the number is unlimited. |
MultiPartProperties.MULTI_PART_CONFIG_RESOURCE | jersey-multipart-config.properties |
Name of a properties resource that (if found in the classpath for this application) will be used to configure the settings returned by our getter methods. |
MultiPartProperties.TEMP_DIRECTORY | jersey.config.multipart.tempDir |
Name of the resource property for the directory to store temporary files containing body parts of multipart message that extends allowed memory threshold.
The default value is not set (will be taken from |