javax.mvc.engine

Interface ViewEngineContext

public interface ViewEngineContext

Contextual data used by a ViewEngine to process a view. This includes the view name, the models instance and the request and response objects from the Servlet container, among other data.

Since:

1.0

Author:

Santiago Pericas-Geertsen

See Also:

ViewEngine, HttpServletRequest, HttpServletResponse

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Configuration	getConfiguration() Returns the application's configuration.
Models	getModels() Returns the models instance needed to process the view.
javax.servlet.http.HttpServletRequest	getRequest() Returns HTTP request object from the Servlet container.
javax.ws.rs.container.ResourceInfo	getResourceInfo() Returns the ResourceInfo instance containing information about the controller method matched in the current request.
javax.servlet.http.HttpServletResponse	getResponse() Returns HTTP response object from the servlet container.
javax.ws.rs.core.UriInfo	getUriInfo() Returns the UriInfo instance containing information about the current request URI.
String	getView() Returns the view.

Method Detail

getView

String getView()

Returns the view.

Returns:

the view.

getModels

Models getModels()

Returns the models instance needed to process the view.

Returns:

the models instance.

getRequest

javax.servlet.http.HttpServletRequest getRequest()

Returns HTTP request object from the Servlet container.

Returns:

HTTP request object.

getResponse

javax.servlet.http.HttpServletResponse getResponse()

Returns HTTP response object from the servlet container. The underlying output stream should be used to write the result of processing a view.

Returns:

HTTP response object.

getUriInfo

javax.ws.rs.core.UriInfo getUriInfo()

Returns the UriInfo instance containing information about the current request URI.

Returns:

the URI info for the current request.

See Also:

UriInfo

getResourceInfo

javax.ws.rs.container.ResourceInfo getResourceInfo()

Returns the ResourceInfo instance containing information about the controller method matched in the current request.

Returns:

the resource info for the current request.

See Also:

ResourceInfo

getConfiguration

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

Returns the application's configuration. The configuration provides access to properties such as ViewEngine.VIEW_FOLDER, which view engines must use to locate views.

Returns:

application's configuration.

See Also:

Configuration