This project has retired. For details please refer to its Attic page.

org.apache.tiles.context
Interface TilesRequestContext

All Known Implementing Classes:

FreeMarkerTilesRequestContext, JspTilesRequestContext, PortletTilesRequestContext, ServletTilesRequestContext, TilesRequestContextWrapper, VelocityTilesRequestContext

public interface TilesRequestContext

Encapsulation of request information.

Since:

2.0

Version:

$Rev: 769961 $ $Date: 2009-04-30 00:07:34 +0200 (gio, 30 apr 2009) $

Method Summary

void	dispatch(String path) Dispatches the request to a specified path.
TilesApplicationContext	getApplicationContext() Returns the associated application context.
Map<String,String>	getHeader() Return an immutable Map that maps header names to the first (or only) header value (as a String).
Map<String,String[]>	getHeaderValues() Return an immutable Map that maps header names to the set of all values specified in the request (as a String array).
OutputStream	getOutputStream() Returns an output stream to be used to write directly in the response.
Map<String,String>	getParam() Return an immutable Map that maps request parameter names to the first (or only) value (as a String).
Map<String,String[]>	getParamValues() Return an immutable Map that maps request parameter names to the set of all values (as a String array).
PrintWriter	getPrintWriter() Returns a print writer to be used to write directly in the response.
Object	getRequest() Deprecated. Use getRequestObjects().
Locale	getRequestLocale() Return the preferred Locale in which the client will accept content.
Object[]	getRequestObjects() Returns the original request objects used to create this request.
Map<String,Object>	getRequestScope() Return a mutable Map that maps request scope attribute names to their values.
Object	getResponse() Deprecated. Use getRequestObjects().
Map<String,Object>	getSessionScope() Return a mutable Map that maps session scope attribute names to their values.
Writer	getWriter() Returns a writer to be used to write directly in the response.
void	include(String path) Includes the response from the specified URL in the current response output.
boolean	isResponseCommitted() Checks if the response has been committed.
boolean	isUserInRole(String role) Determine whether or not the specified user is in the given role.
void	setContentType(String contentType) Sets the content type when rendering the result.

Method Detail

getHeader

Map<String,String> getHeader()

Return an immutable Map that maps header names to the first (or only) header value (as a String).

Returns:

The header map.

getHeaderValues

Map<String,String[]> getHeaderValues()

Return an immutable Map that maps header names to the set of all values specified in the request (as a String array). Header names must be matched in a case-insensitive manner.

Returns:

The header values map.

getRequestScope

Map<String,Object> getRequestScope()

Return a mutable Map that maps request scope attribute names to their values.

Returns:

The request scope map.

getSessionScope

Map<String,Object> getSessionScope()

Return a mutable Map that maps session scope attribute names to their values.

Returns:

The request scope map.

getApplicationContext

TilesApplicationContext getApplicationContext()

Returns the associated application context.

Returns:

The application context associated to this request.

Since:

2.1.1

dispatch

void dispatch(String path)
              throws IOException

Dispatches the request to a specified path.

Parameters:

path - The path to dispatch to.

Throws:

IOException - If something goes wrong during dispatching.

include

void include(String path)
             throws IOException

Includes the response from the specified URL in the current response output.

Parameters:

path - The path to include.

Throws:

IOException - If something goes wrong during inclusion.

getOutputStream

OutputStream getOutputStream()
                             throws IOException

Returns an output stream to be used to write directly in the response.

Returns:

The output stream that writes in the response.

Throws:

IOException - If something goes wrong when getting the output stream.

Since:

2.1.2

getWriter

Writer getWriter()
                 throws IOException

Returns a writer to be used to write directly in the response.

Returns:

The writer that writes in the response.

Throws:

IOException - If something goes wrong when getting the writer.

Since:

2.1.2

getPrintWriter

PrintWriter getPrintWriter()
                           throws IOException

Returns a print writer to be used to write directly in the response.

Returns:

The print writer that writes in the response.

Throws:

IOException - If something goes wrong when getting the print writer.

Since:

2.1.2

setContentType

void setContentType(String contentType)

Sets the content type when rendering the result.

Parameters:

contentType - The content type. It should follow the specifications from W3C about content types.

Since:

2.2.0

isResponseCommitted

boolean isResponseCommitted()

Checks if the response has been committed.

Returns:

true only if the response has been committed.

Since:

2.2.0

getParam

Map<String,String> getParam()

Return an immutable Map that maps request parameter names to the first (or only) value (as a String).

Returns:

The parameter map.

getParamValues

Map<String,String[]> getParamValues()

Return an immutable Map that maps request parameter names to the set of all values (as a String array).

Returns:

The parameter values map.

getRequestLocale

Locale getRequestLocale()

Return the preferred Locale in which the client will accept content.

Returns:

The current request locale. It is the locale of the request object itself and it is NOT the locale that the user wants to use. See LocaleResolver to implement strategies to resolve locales.

isUserInRole

boolean isUserInRole(String role)

Determine whether or not the specified user is in the given role.

Parameters:

role - the role to check against.

Returns:

true if the user is in the given role.

getRequestObjects

Object[] getRequestObjects()

Returns the original request objects used to create this request.

Returns:

The request objects.

Since:

2.1.2

getRequest

@Deprecated
Object getRequest()

Deprecated. Use getRequestObjects().

Get the underlying request.

Returns:

The current request object.

getResponse

@Deprecated
Object getResponse()

Deprecated. Use getRequestObjects().

Get the underlying response.

Returns:

The current request object.