Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


A.1. Common (client/server) configuration properties


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

ConstantValueDescription
CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLEjersey.config.disableAutoDiscovery

Disables feature auto discovery globally on client/server. Default value is false.

CommonProperties.JSON_PROCESSING_FEATURE_DISABLEjersey.config.disableJsonProcessing

Disables configuration of Json Processing (JSR-353) feature. Default value is false.

CommonProperties.METAINF_SERVICES_LOOKUP_DISABLEjersey.config.disableMetainfServicesLookup

Disables META-INF/services lookup globally on client/server. Default value is false.

CommonProperties.MOXY_JSON_FEATURE_DISABLEjersey.config.disableMoxyJson

Disables configuration of MOXy Json feature. Default value is false.

CommonProperties.OUTBOUND_CONTENT_LENGTH_BUFFERjersey.config.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 Content-Length header. Default value is 8192.

LoggingFeature.LOGGING_FEATURE_LOGGER_NAMEjersey.config.logging.logger.nameLogger name of the logging filter. See logging chapter for more information. The default value is org.glassfish.jersey.logging.LoggingFeature
LoggingFeature.LOGGING_FEATURE_LOGGER_LEVELjersey.config.logging.logger.levelLevel of logging filter's logger at which the messages will be logged. See logging chapter for more information.
LoggingFeature.LOGGING_FEATURE_VERBOSITYjersey.config.logging.verbosityVerbosity of logging filter describes how verbose the logging filter will be. There are 3 possible values LoggingFeature.Verbosity.HEADERS_ONLY,LoggingFeature.Verbosity.PAYLOAD_TEXT orLoggingFeature.Verbosity.PAYLOAD_ANY. See loggingchapter for more information.
LoggingFeature.LOGGING_FEATURE_MAX_ENTITY_SIZEjersey.config.logging.entity.maxSizeThe maximum number of bytes of the entity which will be logged. See logging chapter for more information.



A.2. Server configuration properties

List of server configuration properties that can be found in ServerProperties class.

Table A.2. List of server configuration properties

ConstantValueDescription
ServerProperties.APPLICATION_NAMEjersey.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_DISABLEjersey.config.beanValidation.disable.server

Disables Bean Validation support. Default value is false.

ServerProperties .BV_DISABLE_VALIDATE_ON_EXECUTABLE_OVERRIDE_CHECKjersey.config.beanValidation .disable.validateOnExecutableCheck.server

Disables @ValidateOnExecution check. Default value is false.

ServerProperties.BV_SEND_ERROR_IN_RESPONSEjersey.config.beanValidation .enableOutputValidationErrorEntity.server

Enables sending validation error information to the client. Default value is false.

ServerProperties.FEATURE_AUTO_DISCOVERY_DISABLEjersey.config.server.disableAutoDiscovery

Disables feature auto discovery on server. Default value is false.

ServerProperties.HTTP_METHOD_OVERRIDEjersey.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_PROCESSING_FEATURE_DISABLEjersey.config.server.disableJsonProcessing

Disables configuration of Json Processing (JSR-353) feature. Default value is false.

ServerProperties.LANGUAGE_MAPPINGSjersey.config.server.languageMappings

Defines mapping of URI extensions to languages. The property is used by UriConnegFilter.

ServerProperties.MEDIA_TYPE_MAPPINGSjersey.config.server.mediaTypeMappings

Defines mapping of URI extensions to media types. The property is used by UriConnegFilter.

ServerProperties.METAINF_SERVICES_LOOKUP_DISABLEjersey.config.server.disableMetainfServicesLookup

Disables META-INF/services lookup on server. Default value is false.

ServerProperties.MOXY_JSON_FEATURE_DISABLEjersey.config.server.disableMoxyJson

Disables configuration of MOXy Json feature. Default value is false.

ServerProperties.MONITORING_ENABLED (Jersey 2.12 or later)jersey.config.server .monitoring.statistics.enabled

If true, then application monitoring will be enabled. This will enable the possibility of injecting ApplicationInfo into resource and providers. Default value is false.

ServerProperties.MONITORING_STATISTICS_ENABLEDjersey.config.server .monitoring.enabled

If true, the calculation of monitoring statistics will be enabled. This will enable the possibility of injecting MonitoringStatistics into resource and providers and also the registered listeners implementingMonitoringStatisticsListener will be called when statistics are available for processing. Monitoring statistics extends basic monitoring feature. Therefore when enabled, the monitoring gets automatically enabled too (the same result as setting the propertyServerProperties.MONITORING_ENABLED to true). Note that enabling statistics may have a negative performance impact and therefore should be enabled only when needed. Default value is false.

ServerProperties.MONITORING_STATISTICS_MBEANS_ENABLEDjersey.config.server .monitoring.statistics.mbeans.enabled

If true then Jersey will expose MBeans for the collected monitoring statistics. Exposed JMX MBeans are based on MonitoringStatistics data and therefore when enabled, the calculation of monitoring statistics gets automatically enabled too (the same result as setting the property ServerProperties.MONITORING_STATISTICS_ENABLED totrue). Note that enabling MBeans for monitoring statistics may have a negative performance impact and therefore should be enabled only when needed. Default value is false.

ServerProperties.MONITORING_STATISTICS_REFRESH_INTERVAL (Jersey 2.10 or later)jersey.config.server .monitoring.statistics.refresh.interval

Interval (in ms}) indicating how often will be monitoring statistics refreshed (onStatistics method called). Default value is 500.

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 Content-Length header. Default value is 8192.

ServerProperties.PROVIDER_CLASSNAMESjersey.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_CLASSPATHjersey.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_PACKAGESjersey.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_RECURSIVEjersey.config.server .provider.scanning.recursive

Sets the recursion strategy for package scanning. Default value is true.

ServerProperties.REDUCE_CONTEXT_PATH_SLASHES_ENABLEDjersey.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 false.

ServerProperties.RESOURCE_VALIDATION_DISABLEjersey.config.server .resource.validation.disable

Disables Resource validation. Default value is false.

ServerProperties.RESOURCE_VALIDATION_IGNORE_ERRORSjersey.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 false.

ServerProperties.WADL_FEATURE_DISABLEjersey.config.server.wadl.disableWadl

Disables WADL generation. Default value is false.

ServerProperties.WADL_GENERATOR_CONFIGjersey.config.server.wadl.generatorConfig

Defines the wadl generator configuration that provides a WadlGenerator.

ServerProperties.RESPONSE_SET_STATUS_OVER_SEND_ERRORjersey.config.server.response.setStatusOverSendError

Whenever response status is 4xx or 5xx it is possible to choose between sendError or setStatus on container specific Response implementation. E.g. on servlet container Jersey can call HttpServletResponse.setStatus(...) orHttpServletResponse.sendError(...). Calling sendError(...) method usually resets entity, response headers and provide error page for specified status code (e.g. servlet error-page configuration). However if you want to post-process response (e.g. by servlet filter) the only way to do it is calling setStatus(...) on container Response object. If property value is true the method Response.setStatus(...) is used over default Response.sendError(...). Type of the property value is boolean. The default value is false.

ServerProperties.TRACINGjersey.config.server.tracing.type

Enables/disables tracing support. Possible values are OFF(default), ON_DEMAND and ALL. See Section 22.2.1, “Configuration options” for more detail.

ServerProperties.TRACING_THRESHOLDjersey.config.server.tracing.threshold

Sets the amount of detail provided by tracing. Possible values are SUMMARYTRACE and VERBOSE. See Section 22.2.1, “Configuration options” to learn more about the levels.

ServerProperties.PROCESSING_RESPONSE_ERRORS_ENABLEDjersey.config.server.exception.processResponseErrors

If property value is true then the errors raised during response processing are tried to be handled using available response error mappers.

ServerProperties.SUBRESOURCE_LOCATOR_CACHE_SIZEjersey.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_SIZEjersey.config.server.subresource.cache.size

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_ENABLEDjersey.config.server.subresource.cache.jersey.resource.enabled

If true then Jersey will cache Jersey resources in addition to caching sub-resource locator classes and instances (which are cached by default). To make sure the caching is effective in this case you need to return same Jersey Resource instances for same input parameters from resource method. This means that generating new Jersey Resource instances for same input parameters would not have any performance effect and it would only fill-up the cache.

ServerProperties.LOCATION_HEADER_RELATIVE_URI_RESOLUTION_DISABLEDjersey.config.server.headers.location.relative.resolution.disabled

If true, Jersey will not resolve relative URIs in the Location http header.

LoggingFeature.LOGGING_FEATURE_LOGGER_NAME_SERVERjersey.config.server.logging.logger.nameLogger 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_SERVERjersey.config.server.logging.logger.levelLevel of logging filter's logger at which the messages will be logged. See logging chapter for more information.
LoggingFeature.LOGGING_FEATURE_VERBOSITY_SERVERjersey.config.server.logging.verbosityVerbosity of logging filter describes how verbose the logging filter will be. There are 3 possible values LoggingFeature.Verbosity.HEADERS_ONLY,LoggingFeature.Verbosity.PAYLOAD_TEXT orLoggingFeature.Verbosity.PAYLOAD_ANY. See logging chapter for more information.
LoggingFeature.LOGGING_FEATURE_MAX_ENTITY_SIZE_SERVERjersey.config.server.logging.entity.maxSizeThe maximum number of bytes of the entity which will be logged. See logging chapter for more information.



A.3. Servlet configuration properties

List of servlet configuration properties that can be found in ServletProperties class.

Table A.3. List of servlet configuration properties

ConstantValueDescription
ServletProperties.FILTER_CONTEXT_PATHjersey.config.servlet.filter.contextPath

If set, indicates the URL pattern of the Jersey servlet filter context path.

ServletProperties.FILTER_FORWARD_ON_404jersey.config.servlet.filter.forwardOn404

If set to true and a 404 response with no entity body is returned from either the runtime or the application then the runtime forwards the request to the next filter in the filter chain. This enables another filter or the underlying servlet engine to process the request. Before the request is forwarded the response status is set to 200.

ServletProperties.FILTER_STATIC_CONTENT_REGEXjersey.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_CLASSjavax.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_APPjersey.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_DISABLEDjersey.config.servlet.form.queryParams.disabled

If true then query parameters will not be treated as form parameters (e.g. injectable using @FormParam) in case a Form request is processed by server.

ServletProperties.SERVICE_LOCATORjersey.config.servlet.context.serviceLocator

Identifies the object that will be used as a parent ServiceLocator in the Jersey WebComponent.



A.4. Client configuration properties

List of client configuration properties that can be found in ClientProperties class.

Table A.4. List of client configuration properties

ConstantValueDescription
ClientProperties.ASYNC_THREADPOOL_SIZEjersey.config.client.async.threadPoolSize

Asynchronous thread pool size. Default value is not set.Supported with GrizzlyConnectorProvider only..

ClientProperties.CHUNKED_ENCODING_SIZEjersey.config.client.chunkedEncodingSize

Chunked encoding size. Default value is not set.

ClientProperties.CONNECT_TIMEOUTjersey.config.client.connectTimeout

Read timeout interval, in milliseconds. Default value is 0(infinity).

ClientProperties.FEATURE_AUTO_DISCOVERY_DISABLEjersey.config.client.disableAutoDiscovery

Disables feature auto discovery on client. Default value is false.

ClientProperties.FOLLOW_REDIRECTSjersey.config.client.followRedirects

Declares that the client will automatically redirect to the URI declared in 3xx responses. Default value is true.

ClientProperties.JSON_PROCESSING_FEATURE_DISABLEjersey.config.client.disableJsonProcessing

Disables configuration of Json Processing (JSR-353) feature. Default value is false.

ClientProperties.METAINF_SERVICES_LOOKUP_DISABLEjersey.config.disableMetainfServicesLookup.client

Disables META-INF/services lookup on client. Default value is false.

ClientProperties.MOXY_JSON_FEATURE_DISABLEjersey.config.client.disableMoxyJson

Disables configuration of MOXy Json feature. Default value is false.

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 Content-Length header. Default value is 8192.

ClientProperties.PROXY_URIjersey.config.client.proxy.uri

URI of a HTTP proxy the client connector should use. Default value is not set. Currently supported with ApacheConnectorProvider and JettyConnectorProvideronly.

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 andJettyConnectorProvider 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 andJettyConnectorProvider only.

ClientProperties.READ_TIMEOUT (Jersey 2.5 or later)jersey.config.client.readTimeout

Read timeout interval, in milliseconds. Default value is 0(infinity).

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 BUFFEREDor CHUNKED. Default value is BUFFERED.

ClientProperties.SUPPRESS_HTTP_COMPLIANCE_VALIDATION(Jersey 2.2 or later)jersey.config.client.suppressHttpComplianceValidation

If true, the strict validation of HTTP specification compliance for client-side requests will be suppressed. When compliance checks are suppressed, any violations will be merely logged as warnings, rather than causing exceptions being raised in Jersey runtime. Default value is false.

ClientProperties.USE_ENCODINGjersey.config.client.useEncoding

Indicates the value of Content-Encoding property theEncodingFilter should be adding. Default value is not set.

LoggingFeature.LOGGING_FEATURE_LOGGER_NAME_CLIENTjersey.config.client.logging.logger.nameLogger 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_CLIENTjersey.config.client.logging.logger.levelLevel of logging filter's logger at which the messages will be logged. See logging chapter for more information.
LoggingFeature.LOGGING_FEATURE_VERBOSITY_CLIENTjersey.config.client.logging.verbosityVerbosity of logging filter describes how verbose the logging filter will be. There are 3 possible values LoggingFeature.Verbosity.HEADERS_ONLY,LoggingFeature.Verbosity.PAYLOAD_TEXT orLoggingFeature.Verbosity.PAYLOAD_ANY. See logging chapter for more information.
LoggingFeature.LOGGING_FEATURE_MAX_ENTITY_SIZE_CLIENTjersey.config.client.logging.entity.maxSizeThe maximum number of bytes of the entity which will be logged. See logging chapter for more information.