org.glassfish.jersey.server

Class ServerProperties

java.lang.Object

org.glassfish.jersey.server.ServerProperties

public final class ServerProperties
extends Object

Jersey server-side configuration properties.

Author:

Marek Potociar (marek.potociar at oracle.com), Martin Matula (martin.matula at oracle.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	FEATURE_DISABLE_WADL If true then disable WADL generation.
static String	FEATURE_OUTPUT_VALIDATION_ERROR_ENTITY If true then enable sending of validation error entity in Response (validation has to be enabled by registering ValidationFeature in the application).
static String	HTTP_METHOD_OVERRIDE Defines configuration of HTTP method overriding.
static String	LANGUAGE_MAPPINGS Defines mapping of URI extensions to languages.
static String	MEDIA_TYPE_MAPPINGS Defines mapping of URI extensions to media types.
static String	PROPERTY_WADL_GENERATOR_CONFIG If set the wadl generator configuration that provides a WadlGenerator.
static String	PROVIDER_CLASSNAMES Defines one or more class names that implement application-specific resources and providers.
static String	PROVIDER_CLASSPATH Defines class-path that contains application-specific resources and providers.
static String	PROVIDER_PACKAGES Defines one or more packages that contain application-specific resources and providers.
static String	PROVIDER_SCANNING_RECURSIVE Sets the recursion strategy for package scanning.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROVIDER_PACKAGES

public static final String 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 (annotated with @Path) and providers (annotated with @Provider).

The property value MUST be an instance of String or String[] array. Each String instance represents one or more package names that MUST be separated only by characters declared in common delimiters: " ,;\n".

A default value is not set.

The name of the configuration property is "jersey.config.server.provider.packages".

See Also:

Constant Field Values

PROVIDER_SCANNING_RECURSIVE

public static final String PROVIDER_SCANNING_RECURSIVE

Sets the recursion strategy for package scanning. The value of true indicates that the list of provided package names should be scanned recursively including any nested packages. Value of false indicates that only packages in the list should be scanned. In such case any nested packages will be ignored.

The property value MUST be an instance of Boolean type or a String convertible to Boolean type.

A default value is true.

The name of the configuration property is "jersey.config.server.provider.scanning.recursive".

See Also:

PROVIDER_PACKAGES, Constant Field Values

PROVIDER_CLASSPATH

public static final String PROVIDER_CLASSPATH

Defines class-path that contains application-specific resources and providers. If the property is set, the specified class-path will be scanned for JAX-RS root resources (annotated with @Path) and providers (annotated with @Provider). Each path element MUST be an absolute or relative directory, or a Jar file. The contents of a directory, including Java class files, jars files and sub-directories are scanned (recursively).

The property value MUST be an instance of String or String[] array. Each String instance represents one or more paths that MUST be separated only by characters declared in common delimiters: " ,;\n".

A default value is not set.

The name of the configuration property is "jersey.config.server.provider.classpath".

See Also:

Constant Field Values

PROVIDER_CLASSNAMES

public static final String 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 (annotated with @Path) or providers (annotated with @Provider).

The property value MUST be an instance of String or String[] array. Each String instance represents one or more class names that MUST be separated only by characters declared in common delimiters: " ,;\n".

A default value is not set.

The name of the configuration property is "jersey.config.server.provider.classnames".

See Also:

Constant Field Values

MEDIA_TYPE_MAPPINGS

public static final String MEDIA_TYPE_MAPPINGS

Defines mapping of URI extensions to media types. The property is used by UriConnegFilter. See it's javadoc for more information on media type mappings.

The property value MUST be an instance of String, String[] or Map<String, MediaType>. Each String instance represents one or more uri-extension-to-media-type map entries separated by a comma (","). Each map entry is a key-value pair separated by a colon (":"). Here is an example of an acceptable String value mapping txt extension to text/plain and xml extension to application/xml:

txt : text/plain, xml : application/xml

A default value is not set.

The name of the configuration property is "jersey.config.server.mediaTypeMappings".

See Also:

Constant Field Values

LANGUAGE_MAPPINGS

public static final String LANGUAGE_MAPPINGS

Defines mapping of URI extensions to languages. The property is used by UriConnegFilter. See it's javadoc for more information on language mappings.

The property value MUST be an instance of String, String[] or Map<String, String>. Each String instance represents one or more uri-extension-to-language map entries separated by a comma (","). Each map entry is a key-value pair separated by a colon (":"). Here is an example of an acceptable String value mapping english extension to "en" value of Content-Language header and french extension to "fr" Content-Language header value:

english : en, french : fr

A default value is not set.

The name of the configuration property is "jersey.config.server.languageMappings".

See Also:

Constant Field Values

HTTP_METHOD_OVERRIDE

public static final String HTTP_METHOD_OVERRIDE

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). HttpMethodOverrideFilter.Source enum lists the allowed property values.

The property value must be an instance of String, String[], Source or Source[]. Each String instance represents one or more class names separated by characters declared in common delimiters: " ,;\n".

The default value is "HEADER, QUERY".

The name of the configuration property is "jersey.config.server.httpMethodOverride".

See Also:

Constant Field Values

PROPERTY_WADL_GENERATOR_CONFIG

public static final String PROPERTY_WADL_GENERATOR_CONFIG

If set the wadl generator configuration that provides a WadlGenerator.

The type of this property must be a subclass or an instance of a subclass of WadlGeneratorConfig.

If this property is not set the default wadl generator will be used for generating wadl.

The name of the configuration property is "jersey.config.server.wadl.generatorConfig".

See Also:

Constant Field Values

FEATURE_DISABLE_WADL

public static final String FEATURE_DISABLE_WADL

If true then disable WADL generation.

By default WADL generation is automatically enabled, if JAXB is present in the classpath.

The default value is false.

The name of the configuration property is "jersey.config.server.wadl.disableWadl".

See Also:

Constant Field Values

FEATURE_OUTPUT_VALIDATION_ERROR_ENTITY

public static final String FEATURE_OUTPUT_VALIDATION_ERROR_ENTITY

If true then enable sending of validation error entity in Response (validation has to be enabled by registering ValidationFeature in the application).

The default value is false and only status code is sent in the Response.

The name of the configuration property is "jersey.config.server.validation.enableOutputValidationErrorEntity".

See Also:

Constant Field Values