javax.mvc

Interface MvcContext

public interface MvcContext

This class provides contextual information such as context and application paths as well as access to the JAX-RS application configuration object. In addition, it provides access to the security-related beans Csrf and Encoders.

Implementations of this class are injectable, must be RequestScoped and accessible from EL using the name mvc. For example, the CSRF token name and value can be accessed in EL using the expressions mvc.csrf.name and mvc.csrf.token, respectively.

Since:

1.0

Author:

Santiago Pericas-Geertsen

See Also:

Configuration

Method Summary

Modifier and Type	Method and Description
String	getApplicationPath() Get the application's path which was set using the ApplicationPath annotation.
String	getBasePath() Get the application's base path which is defined as the concatenation of context and application paths.
javax.ws.rs.core.Configuration	getConfig() Get the JAX-RS application configuration object.
String	getContextPath() Get the application's context path.
Csrf	getCsrf() Get the CSRF object.
Encoders	getEncoders() Get the built-in encoders.
Locale	getLocale() Returns the locale of the current request.
URI	uri(String identifier) Creates an URI to be matched by a controller method.
URI	uri(String identifier, Map<String,Object> params) Creates an URI to be matched by a controller method.
MvcUriBuilder	uriBuilder(String identifier) Returns a MvcUriBuilder for building URIs to be matched by a controller method.

Method Detail

getConfig

javax.ws.rs.core.Configuration getConfig()

Get the JAX-RS application configuration object. All application-defined properties are accessible via this object.

Returns:

the configuration object.

getContextPath

String getContextPath()

Get the application's context path. The value returned must be normalized to start with a slash ('/') but not end with one. Thus, the path returned by this method can be prepended to that returned by getApplicationPath().

For example, given the URI http://host:port/myapp/resources/hello, this method returns /myapp.

Returns:

the application's context path.

See Also:

ServletContext.getContextPath()

getApplicationPath

String getApplicationPath()

Get the application's path which was set using the ApplicationPath annotation. The value returned must be normalized to start with a slash ('/') but not end with one. Thus, the path returned by this method can be appended to that returned by getContextPath().

If the application path is empty or was set to /*, then an empty string is returned to ensure concatenation with getContextPath() results in a well-formed path. If a JAX-RS application subclass is not found, null may be returned.

For example, given the URI http://host:port/myapp/resources/hello, this method returns /resources.

Returns:

the application's path or null if not found.

getBasePath

String getBasePath()

Get the application's base path which is defined as the concatenation of context and application paths. It follows that the value returned by this method always starts with a slash but never ends with one.

If a JAX-RS application subclass is not found, causing getApplicationPath() to return null, then the value returned is the same as getContextPath().

Returns:

the application's base path.

getCsrf

Csrf getCsrf()

Get the CSRF object.

Returns:

the CSRF object.

getEncoders

Encoders getEncoders()

Get the built-in encoders.

Returns:

instance of encoders.

getLocale

Locale getLocale()

Returns the locale of the current request.

Returns:

The request locale

uri

URI uri(String identifier)

Creates an URI to be matched by a controller method. This is aimed primarily for use in view rendering technologies to avoid duplicating the values of the Path annotations.

The controller method can either be identified by the simple name of the controller class and the method name separated by '#' (MyController#myMethod) or by the value of the UriRef annotation.

The created URI includes context- and application path.

This method assumes that there is no parameter in the URI-template.

For example:

${mvc.uri('MyController#myMethod')}

Parameters:

identifier - for the controller method.

Returns:

the constructed URI including context- and application path.

uri

URI uri(String identifier,
        Map<String,Object> params)

Creates an URI to be matched by a controller method. This is aimed primarily for use in view rendering technologies to avoid duplicating the values of the Path annotations.

The controller method can either be identified by the simple name of the controller class and the method name separated by '#' (MyController#myMethod) or by the value of the UriRef annotation.

The created URI includes context- and application path.

Any PathParam, QueryParam and MatrixParam which could apply for given target method will be replaced if a matching key is found in the supplied Map. Please note that the map must contain values for all path parameters as they are required for building the URI. All other parameters are optional.

For example:

${mvc.uri('MyController#myMethod' {'foo': 'bar', 'id': 42})}

Parameters:

identifier - for the controller method.

params - a map of path-, query- and matrix parameters.

Returns:

the constructed URI including context- and application path.

Throws:

IllegalArgumentException - if there are any URI template parameters without a supplied value, or if a value is null.

uriBuilder

MvcUriBuilder uriBuilder(String identifier)

Returns a MvcUriBuilder for building URIs to be matched by a controller method. This is aimed primarily for use in Java classes.

The controller method can either be identified by the simple name of the controller class and the method name separated by '#' (MyController#myMethod) or by the value of the UriRef annotation.

Parameters:

identifier - for the controller method.

Returns:

a reference to a MvcUriBuilder.