Package org.glassfish.jersey.server.mvc

Class MvcFeature

java.lang.Object

org.glassfish.jersey.server.mvc.MvcFeature

All Implemented Interfaces:

jakarta.ws.rs.core.Feature

@ConstrainedTo(SERVER)
public final class MvcFeature
extends Object
implements jakarta.ws.rs.core.Feature

MvcFeature used to add MVC support to the server.

Author:

Michal Gajdos

Field Summary

Fields

Modifier and Type	Field	Description
static String	CACHE_TEMPLATES	If true then enable caching of template objects, i.e.
static String	ENCODING	Property defines output encoding produced by TemplateProcessor.
static String	TEMPLATE_BASE_PATH	String property defining the base path to MVC templates.
static String	TEMPLATE_OBJECT_FACTORY	Property used to pass user-configured factory able to create template objects.

Constructor Summary

Constructors

Constructor	Description
MvcFeature()

Method Summary

Modifier and Type	Method	Description
boolean	configure(jakarta.ws.rs.core.FeatureContext context)

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE_BASE_PATH

public static final String TEMPLATE_BASE_PATH

String property defining the base path to MVC templates. If set, the value of the property is added in front of the template name defined in:

• Viewable
• Template, or
• ErrorTemplate

Value can be absolute providing a full path to a system directory with templates or relative to current servlet context.

There is no default value.

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

See Also:

Constant Field Values

CACHE_TEMPLATES

public static final String CACHE_TEMPLATES

If true then enable caching of template objects, i.e. to avoid multiple compilations of a template.

The default value is false.

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

Note: This property is used as common prefix for specific template processors properties and might not be supported by all template processors.

Since:

2.5

See Also:

Constant Field Values

TEMPLATE_OBJECT_FACTORY

public static final String TEMPLATE_OBJECT_FACTORY

Property used to pass user-configured factory able to create template objects. Value of the property is supposed to be an instance of "templating engine"-specific factory, a class of the factory or class-name of the factory.

The default value is not set.

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

Note: This property is used as common prefix for specific template processors properties and might not be supported by all template processors.

Since:

2.5

See Also:

Constant Field Values

ENCODING

public static final String ENCODING

Property defines output encoding produced by TemplateProcessor. The value must be a valid encoding defined that can be passed to the Charset.forName(String) method.

The default value is UTF-8.

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

Note: This property is used as common prefix for specific template processors properties and might not be supported by all template processors.

Since:

2.7

See Also:

Constant Field Values

Constructor Detail

MvcFeature

public MvcFeature()

Method Detail

configure

public boolean configure(jakarta.ws.rs.core.FeatureContext context)

Specified by:

configure in interface jakarta.ws.rs.core.Feature