Package org.apache.tiles.request.jakarta.servlet

Class ServletRequest

java.lang.Object

org.apache.tiles.request.AbstractRequest

org.apache.tiles.request.AbstractClientRequest

org.apache.tiles.request.jakarta.servlet.ServletRequest

All Implemented Interfaces:

DispatchRequest, Request

public class ServletRequest
extends AbstractClientRequest

Servlet-based implementation of the TilesApplicationContext interface.

Copied from Apache tiles-request-servlet 1.0.7 and adapted for Jakarta EE 9.

Field Summary

Fields inherited from class org.apache.tiles.request.AbstractRequest

FORCE_INCLUDE_ATTRIBUTE_NAME

Fields inherited from interface org.apache.tiles.request.Request

APPLICATION_SCOPE, REQUEST_SCOPE

Constructor Summary

Constructors

Constructor	Description
ServletRequest(ApplicationContext applicationContext, HttpServletRequest request, HttpServletResponse response)	Creates a new instance of ServletTilesRequestContext.

Method Summary

Modifier and Type	Method	Description
void	doForward(String path)	Forwards to a path.
void	doInclude(String path)	Includes the content of a resource (servlet, JSP page, HTML file) in the response.
List<String>	getAvailableScopes()	Returns all available scopes.
Map<String,Object>	getContext(String scope)	Returns a context map, given the scope name.
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 a ServletOutputStream suitable for writing binary data 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 PrintWriter object that can send character text to the client.
HttpServletRequest	getRequest()	Returns the request object to use.
Locale	getRequestLocale()	Returns the preferred Locale that the client will accept content in, based on the Accept-Language header.
Map<String,Object>	getRequestScope()	Returns the context map from request scope.
HttpServletResponse	getResponse()	Returns the response object to use.
Addable<String>	getResponseHeaders()	Return an add-able object that can be used to write headers to the response.
Map<String,Object>	getSessionScope()	Returns the context map from session scope.
Writer	getWriter()	Returns a Writer object that can send character text to the client.
boolean	isResponseCommitted()	Returns a boolean indicating if the response has been committed.
boolean	isUserInRole(String role)	Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
void	setContentType(String contentType)	Sets the content type of the response being sent to the client, if the response has not been committed yet.

Methods inherited from class org.apache.tiles.request.AbstractClientRequest

dispatch, getApplicationContext, getApplicationScope, include

Methods inherited from class org.apache.tiles.request.AbstractRequest

isForceInclude, setForceInclude

Methods inherited from class java.lang.Object

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

Constructor Details

ServletRequest

public ServletRequest(ApplicationContext applicationContext,
 HttpServletRequest request,
 HttpServletResponse response)

Creates a new instance of ServletTilesRequestContext.

Parameters:

applicationContext - The application context.

request - The request object.

response - The response object.

Method Details

getHeader

public 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.

getResponseHeaders

public Addable<String> getResponseHeaders()

Return an add-able object that can be used to write headers to the response.

Returns:

An add-able object.

getHeaderValues

public 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.

getParam

public 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

public 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.

getContext

public Map<String,Object> getContext(String scope)

Returns a context map, given the scope name.

This method always return a map for all the scope names returned by getAvailableScopes(). That map may be writable, or immutable, depending on the implementation.

Parameters:

scope - The name of the scope.

Returns:

The context.

getRequestScope

public Map<String,Object> getRequestScope()

Returns the context map from request scope.

Returns:

the context map from request scope

getSessionScope

public Map<String,Object> getSessionScope()

Returns the context map from session scope.

Returns:

the context map from session scope

getAvailableScopes

public List<String> getAvailableScopes()

Returns all available scopes.

The scopes are ordered according to their lifetime, the innermost, shorter lived scope appears first, and the outermost, longer lived scope appears last. Besides, the scopes "request" and "application" always included in the list.

Returns:

All the available scopes.

doForward

public void doForward(String path)
               throws IOException

Forwards to a path.

Specified by:

doForward in class AbstractClientRequest

Parameters:

path - The path to forward to.

Throws:

IOException - If something goes wrong when forwarding.

doInclude

public void doInclude(String path)
               throws IOException

Includes the content of a resource (servlet, JSP page, HTML file) in the response. In essence, this method enables programmatic server-side includes.

Specified by:

doInclude in class AbstractClientRequest

Parameters:

path - a String specifying the pathname to the resource. If it is relative, it must be relative against the current servlet.

Throws:

IOException - if the included resource throws this exception

See Also:

• RequestDispatcher.include(jakarta.servlet.ServletRequest, ServletResponse)

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Returns a ServletOutputStream suitable for writing binary data in the response. The servlet container does not encode the binary data.

Returns:

a ServletOutputStream for writing binary data

Throws:

IllegalStateException - if the getWriter method has been called on this response

IOException - if an input or output exception occurred

See Also:

• ServletResponse.getOutputStream()

getWriter

public Writer getWriter()
                 throws IOException

Returns a Writer object that can send character text to the client. The Writer uses the character encoding returned by ServletResponse.getCharacterEncoding(). If the response's character encoding has not been specified as described in getCharacterEncoding (i.e., the method just returns the default value ISO-8859-1), getWriter updates it to ISO-8859-1.

Returns:

a Writer object that can return character data to the client

Throws:

UnsupportedEncodingException - if the character encoding returned by getCharacterEncoding cannot be used

IllegalStateException - if the getOutputStream method has already been called for this response object

IOException - if an input or output exception occurred

See Also:

• getPrintWriter()
• ServletResponse.getWriter()

getPrintWriter

public PrintWriter getPrintWriter()
                           throws IOException

Returns a PrintWriter object that can send character text to the client. The PrintWriter uses the character encoding returned by ServletResponse.getCharacterEncoding(). If the response's character encoding has not been specified as described in getCharacterEncoding (i.e., the method just returns the default value ISO-8859-1), getWriter updates it to ISO-8859-1.

Returns:

a PrintWriter object that can return character data to the client

Throws:

UnsupportedEncodingException - if the character encoding returned by getCharacterEncoding cannot be used

IllegalStateException - if the getOutputStream method has already been called for this response object

IOException - if an input or output exception occurred

See Also:

• ServletResponse.getWriter()

isResponseCommitted

public boolean isResponseCommitted()

Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.

Returns:

a boolean indicating if the response has been committed

See Also:

• ServletResponse.isCommitted()

setContentType

public void setContentType(String contentType)

Sets the content type of the response being sent to the client, if the response has not been committed yet. The given content type may include a character encoding specification, for example, >text/html;charset=UTF-8. The response's character encoding is only set from the given content type if this method is called before getWriter is called.

Parameters:

contentType - a String specifying the MIME type of the content

See Also:

• ServletResponse.setContentType(String)

getRequestLocale

public Locale getRequestLocale()

Returns the preferred Locale that the client will accept content in, based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server.

Returns:

the preferred Locale for the client

See Also:

• ServletRequest.getLocale()

getRequest

public HttpServletRequest getRequest()

Returns the request object to use.

Returns:

the request object to use

getResponse

public HttpServletResponse getResponse()

Returns the response object to use.

Returns:

the response object to use

isUserInRole

public boolean isUserInRole(String role)

Returns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returns false.

Parameters:

role - a String specifying the name of the role

Returns:

a boolean indicating whether the user making this request belongs to a given role; false if the user has not been authenticated

See Also:

• HttpServletRequest.isUserInRole(String)