com.helger.web.scope.impl

Class RequestWebScope

java.lang.Object

com.helger.scope.AbstractScope

com.helger.web.scope.impl.RequestWebScope

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.scope.IRequestScope, com.helger.scope.IScope, IRequestWebScope, IRequestWebScopeWithoutResponse, IWebScope, Serializable

Direct Known Subclasses:

RequestWebScopeMultipart

public class RequestWebScope
extends com.helger.scope.AbstractScope
implements IRequestWebScope

A request web scopes that does not parse multipart requests.

Author:

Philip Helger

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RequestWebScope.IParamValueCleanser The param value cleanser interface to be used globally.
static class	RequestWebScope.ParamContainer Special implementation if IRequestParamContainer based on AttributeContainerAny.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.http.HttpServletRequest	m_aHttpRequest
protected javax.servlet.http.HttpServletResponse	m_aHttpResponse

Fields inherited from class com.helger.scope.AbstractScope

m_aRWLock

Constructor Summary

Constructors

Constructor and Description
RequestWebScope(javax.servlet.http.HttpServletRequest aHttpRequest, javax.servlet.http.HttpServletResponse aHttpResponse)

Method Summary

Modifier and Type	Method and Description
protected com.helger.commons.state.EChange	addSpecialRequestParams() Callback method to add special parameters.
String	encodeRedirectURL(String sURL) Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged.
String	encodeURL(String sURL) Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
boolean	equals(Object o)
String	getContextAndServletPath()
String	getContextPath()
String	getFullContextAndServletPath()
static RequestWebScope.IParamValueCleanser	getParamValueCleanser()
javax.servlet.http.HttpServletRequest	getRequest()
com.helger.servlet.request.IRequestParamMap	getRequestParamMap()
javax.servlet.http.HttpServletResponse	getResponse()
static String	getWithoutForbiddenChars(String s) Remove all chars from the input that cannot be serialized as XML.
static String	getWithoutForbiddenCharsAndNormalized(String s) First normalize the input according to Unicode rules, so that "O 0xcc 0x88" (O with COMBINING DIAERESIS) becomes "Ö" (Capital O with umlaut).
int	hashCode()
com.helger.commons.http.HttpHeaderMap	headers()
void	initScope()
static boolean	isFileBasedRequest(String sServletPath) This is a heuristic method to determine whether a request is for a file (e.g.
static boolean	isForbiddenParamValueChar(char c) Check if the provided char is forbidden in a request value or not.
IRequestParamContainer	params()
protected void	postDestroy()
static void	setParamValueCleanser(RequestWebScope.IParamValueCleanser aParamValueCleanser) Set the param value cleanser function that is applied on all parameter values.
String	toString()

Methods inherited from class com.helger.scope.AbstractScope

attrs, destroyScope, getID, isDestroyed, isInDestruction, isInPreDestruction, isValid, preDestroy, runAtomic, runAtomic

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.web.scope.IRequestWebScope

getOutputStream

Methods inherited from interface com.helger.web.scope.IRequestWebScopeWithoutResponse

areCookiesEnabled, encodeRedirectURL, encodeURL, getAuthType, getBrowserInfo, getCharacterEncoding, getCharset, getContentLength, getContentType, getCookies, getFullContextPath, getFullServerPath, getHttpMethod, getHttpVersion, getLocalAddr, getLocalName, getLocalPort, getMethod, getPathInfo, getPathTranslated, getPathWithinServlet, getPathWithinServletContext, getProtocol, getQueryString, getRemoteAddr, getRemoteHost, getRemotePort, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getScheme, getServerName, getServerPort, getServletPath, getSession, getSessionID, getURL, getUserAgent, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isSecure, isUserInRole

Methods inherited from interface com.helger.scope.IRequestScope

getSessionID

Methods inherited from interface com.helger.scope.IScope

attrs, destroyScope, getAllScopeRenewalAwareAttributes, getID, isDestroyed, isInDestruction, isValid, runAtomic, runAtomic

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Field Detail

m_aHttpRequest

protected final transient javax.servlet.http.HttpServletRequest m_aHttpRequest

m_aHttpResponse

protected final transient javax.servlet.http.HttpServletResponse m_aHttpResponse

Constructor Detail

RequestWebScope

public RequestWebScope(@Nonnull
                       javax.servlet.http.HttpServletRequest aHttpRequest,
                       @Nonnull
                       javax.servlet.http.HttpServletResponse aHttpResponse)

Method Detail

getParamValueCleanser

@Nullable
public static RequestWebScope.IParamValueCleanser getParamValueCleanser()

Returns:

The current value cleanser function. May be null. By default getWithoutForbiddenCharsAndNormalized(String) is invoked.

Since:

9.0.6

See Also:

setParamValueCleanser(IParamValueCleanser)

setParamValueCleanser

public static void setParamValueCleanser(@Nullable
                                         RequestWebScope.IParamValueCleanser aParamValueCleanser)

Set the param value cleanser function that is applied on all parameter values. By default only getWithoutForbiddenCharsAndNormalized(String) is invoked.

Parameters:

aParamValueCleanser - The function to be applied. May be null. The function itself must be able to handle null values.

Since:

9.0.6

See Also:

getParamValueCleanser()

addSpecialRequestParams

@OverrideOnDemand
 @Nonnull
protected com.helger.commons.state.EChange addSpecialRequestParams()

Callback method to add special parameters.

Returns:

EChange.CHANGED if some attributes were added, false if not. If special attributes were added, existing attributes are kept and will not be overwritten with HTTP servlet request parameters!

isForbiddenParamValueChar

public static boolean isForbiddenParamValueChar(char c)

Check if the provided char is forbidden in a request value or not.

Parameters:

c - Char to check

Returns:

true if it is forbidden, false if not.

Since:

9.0.6

See Also:

getWithoutForbiddenChars(String)

getWithoutForbiddenChars

@Nullable
public static String getWithoutForbiddenChars(@Nullable
                                                         String s)

Remove all chars from the input that cannot be serialized as XML.

Parameters:

s - The source value. May be null.

Returns:

null if the source value is null.

Since:

9.0.4

See Also:

isForbiddenParamValueChar(char)

getWithoutForbiddenCharsAndNormalized

@Nullable
public static String getWithoutForbiddenCharsAndNormalized(@Nullable
                                                                      String s)

First normalize the input according to Unicode rules, so that "O 0xcc 0x88" (O with COMBINING DIAERESIS) becomes "Ö" (Capital O with umlaut).

Parameters:

s - Source string. May be null.

Returns:

null if the source string is null.

Since:

9.0.6

See Also:

Normalizer.normalize(CharSequence, java.text.Normalizer.Form), getWithoutForbiddenChars(String)

initScope

public final void initScope()

Specified by:

initScope in interface com.helger.scope.IScope

postDestroy

protected void postDestroy()

Overrides:

postDestroy in class com.helger.scope.AbstractScope

headers

@Nonnull
public final com.helger.commons.http.HttpHeaderMap headers()

Specified by:

headers in interface IRequestWebScopeWithoutResponse

Returns:

A cached header map for this request. Never null. Alterations to this map are visible everywhere. Clone the object if you need to modify it.

params

@Nonnull
 @ReturnsMutableObject
public final IRequestParamContainer params()

Specified by:

params in interface IRequestWebScopeWithoutResponse

Returns:

The external URL parameters. Never null.

getRequestParamMap

@Nonnull
public final com.helger.servlet.request.IRequestParamMap getRequestParamMap()

Specified by:

getRequestParamMap in interface IRequestWebScopeWithoutResponse

Returns:

A cached request param map for this request. Never null.

isFileBasedRequest

public static boolean isFileBasedRequest(@Nonnull
                                         String sServletPath)

This is a heuristic method to determine whether a request is for a file (e.g. x.jsp) or for a servlet. This method return true if the last dot is after the last slash

Parameters:

sServletPath - The non-null servlet path to check

Returns:

true if it is assumed that the request is file based, false if it can be assumed to be a regular servlet.

getContextPath

@Nonnull
public String getContextPath()

Specified by:

getContextPath in interface IRequestWebScopeWithoutResponse

Returns:

Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string. E.g. /context or an empty string for the root context. Never with a trailing slash.

See Also:

IRequestWebScopeWithoutResponse.getFullContextPath()

getContextAndServletPath

@Nonnull
public String getContextAndServletPath()

Specified by:

getContextAndServletPath in interface IRequestWebScopeWithoutResponse

Returns:

Return the absolute servlet path. E.g. /context/config.jsp or /context/action/

getFullContextAndServletPath

@Nonnull
public String getFullContextAndServletPath()

Specified by:

getFullContextAndServletPath in interface IRequestWebScopeWithoutResponse

Returns:

Return the absolute servlet path. E.g. http://localhost:8080/context/config.jsp or http://localhost:8080/context/action/

getRequest

@Nonnull
public final javax.servlet.http.HttpServletRequest getRequest()

Specified by:

getRequest in interface IRequestWebScopeWithoutResponse

Returns:

The underlying HTTP servlet request object. Never null .

getResponse

@Nonnull
public final javax.servlet.http.HttpServletResponse getResponse()

Specified by:

getResponse in interface IRequestWebScope

Returns:

The underlying HTTP servlet response object

encodeURL

@Nonnull
public String encodeURL(@Nonnull
                                  String sURL)

Description copied from interface: IRequestWebScopeWithoutResponse

Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary.

For robust session tracking, all URLs emitted by a servlet should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

Specified by:

encodeURL in interface IRequestWebScopeWithoutResponse

Parameters:

sURL - the url to be encoded. May not be null.

Returns:

the encoded URL if encoding is needed; the unchanged URL otherwise.

encodeRedirectURL

@Nonnull
public String encodeRedirectURL(@Nonnull
                                          String sURL)

Description copied from interface: IRequestWebScopeWithoutResponse

Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. Because the rules for making this determination can differ from those used to decide whether to encode a normal link, this method is separated from the encodeURL method.

All URLs sent to the HttpServletResponse.sendRedirect method should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

Specified by:

encodeRedirectURL in interface IRequestWebScopeWithoutResponse

Parameters:

sURL - the url to be encoded.

Returns:

the encoded URL if encoding is needed; the unchanged URL otherwise.

See Also:

IRequestWebScopeWithoutResponse.encodeURL(String)

equals

public boolean equals(Object o)

Overrides:

equals in class com.helger.scope.AbstractScope

hashCode

public int hashCode()

Overrides:

hashCode in class com.helger.scope.AbstractScope

toString

public String toString()

Overrides:

toString in class com.helger.scope.AbstractScope