Class CmsRequestUtil
- java.lang.Object
-
- org.opencms.util.CmsRequestUtil
-
public final class CmsRequestUtil extends java.lang.Object
Provides utility functions for dealing with values a
.HttpServletRequest
- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATTRIBUTE_ERRORCODE
Request attribute that contains the original error code.static boolean
backlinkCheckEnabled
Flag to enable / disable backlink checks.static java.lang.String
HEADER_ACCEPT
HTTP Accept Header for the cms:device-tag.static java.lang.String
HEADER_ACCEPT_CHARSET
HTTP Accept-Charset Header for internal requests used during static export.static java.lang.String
HEADER_ACCEPT_LANGUAGE
HTTP Accept-Language Header for internal requests used during static export.static java.lang.String
HEADER_CACHE_CONTROL
HTTP Header "Cache-Control".static java.lang.String
HEADER_CONNECTION
HTTP Header "Connection".static java.lang.String
HEADER_CONTENT_DISPOSITION
The "Content-Disposition" http header.static java.lang.String
HEADER_CONTENT_TYPE
The "Content-Type" http header.static java.lang.String
HEADER_EXPIRES
HTTP Header "Expires".static java.lang.String
HEADER_IF_MODIFIED_SINCE
HTTP Header "If-Modified-Since".static java.lang.String
HEADER_JSESSIONID
The Header that stores the session id (used by OpenCms upload applet).static java.lang.String
HEADER_LAST_MODIFIED
HTTP Header "Last-Modified".static java.lang.String
HEADER_LOCATION
HTTP Header "Location".static java.lang.String
HEADER_OPENCMS_EXPORT
HTTP Header for internal requests used during static export.static java.lang.String
HEADER_PRAGMA
HTTP Header "Pragma".static java.lang.String
HEADER_SERVER
HTTP Header "Server".static java.lang.String
HEADER_USER_AGENT
HTTP Header "user-agent".static java.lang.String
HEADER_VALUE_MAX_AGE
HTTP Header value "max-age=" (for "Cache-Control").static java.lang.String
HEADER_VALUE_MUST_REVALIDATE
HTTP Header value "must-revalidate" (for "Cache-Control").static java.lang.String
HEADER_VALUE_NO_CACHE
HTTP Header value "no-cache" (for "Cache-Control").static java.lang.String
HEADER_VALUE_NO_STORE
HTTP Header value "no-store" (for "Cache-Control").static java.lang.String
HEADER_WWW_AUTHENTICATE
HTTP Header "WWW-Authenticate".static java.lang.String
HEADER_X_FORWARDED_FOR
Identifier for x-forwarded-for (i.e.static java.lang.String
PARAMETER_ASSIGNMENT
Assignment char between parameter name and values.static java.lang.String
PARAMETER_DELIMITER
Delimiter char between parameters.static java.lang.String
URL_DELIMITER
Delimiter char between url and query.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String
appendParameter(java.lang.String url, java.lang.String paramName, java.lang.String paramValue)
Appends a request parameter to the given URL.static java.lang.String
appendParameters(java.lang.String url, java.util.Map<java.lang.String,java.lang.String[]> params, boolean encode)
Appends a map of request parameters to the given URL.static boolean
checkBacklink(java.lang.String backlink, javax.servlet.http.HttpServletRequest optionalRequest)
Checks that the given link is a valid backlink for editors.static java.util.Map<java.lang.String,java.lang.String[]>
createParameterMap(java.lang.String query)
Parses the parameters of the given request query part and creates a parameter map out of them.static java.util.Map<java.lang.String,java.lang.String[]>
createParameterMap(java.lang.String query, boolean decodeParameters, java.lang.String encoding)
Parses the parameters of the given request query part, optionally decodes them, and creates a parameter map out of them.static java.util.Map<java.lang.String,java.lang.String[]>
createParameterMap(java.util.Map<java.lang.String,?> params)
Creates a valid request parameter map from the given map, most notably changing the values formString
toString[]
if required.static void
disableCrossSiteFrameEmbedding(javax.servlet.http.HttpServletResponse response)
Sets HTTP response headers to disable embedding in iframes on different domains.static java.lang.String
encodeParams(javax.servlet.http.HttpServletRequest req)
Returns all parameters of the given request as a request parameter URL String, that is in the formkey1=value1&key2=value2
etc.static java.lang.String
encodeParamsWithUri(java.lang.String uri, javax.servlet.http.HttpServletRequest req)
Encodes the given URI, with all parameters from the given request appended.static void
forwardRequest(java.lang.String target, java.util.Map<java.lang.String,java.lang.String[]> params, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Forwards the response to the given target, with the provided parameter map.static void
forwardRequest(java.lang.String target, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Forwards the response to the given target, which may contain parameters appended like for example?a=b&c=d
.static java.util.Map<java.lang.String,java.lang.Object>
getAtrributeMap(javax.servlet.ServletRequest req)
Exactly like getAttributeMap, but incorrectly spelled.static java.util.Map<java.lang.String,java.lang.Object>
getAttributeMap(javax.servlet.ServletRequest req)
Returns a map with all request attributes.static java.lang.String
getCookieValue(javax.servlet.http.Cookie[] cookies, java.lang.String name)
Gets the value of a specific cookie from an array of cookies.static java.lang.String
getCookieValue(CmsJspActionElement jsp, java.lang.String name)
Returns the value of the cookie with the given name.static JSONObject
getJsonParameterMap(java.util.Map<java.lang.String,java.lang.String[]> params)
Converts the given parameter map into an JSON object.static java.lang.String
getNotEmptyDecodedParameter(javax.servlet.http.HttpServletRequest request, java.lang.String paramName)
Reads value from the request parameters, will returnnull
if the value is not available or only white space.static java.lang.String
getNotEmptyParameter(javax.servlet.http.HttpServletRequest request, java.lang.String paramName)
Reads value from the request parameters, will returnnull
if the value is not available or only white space.static java.util.Map<java.lang.String,java.lang.String[]>
getParameterMapFromJSON(JSONObject params)
Converts the given JSON object into a valid parameter map.static com.google.common.collect.Multimap<java.lang.String,java.lang.String>
getParameters(java.net.URI uri)
Parses parameter map from the given URI.static com.google.common.collect.Multimap<java.lang.String,java.lang.String>
getParametersFromRawQuery(java.lang.String rawQuery)
Parses the parameter map from a raw query string.static java.lang.String
getRequestLink(java.lang.String url)
Returns the link without parameters from a String that is formatted for a GET request.static java.lang.Object
getSessionValue(javax.servlet.http.HttpServletRequest request, java.lang.String key)
Reads an object from the session of the given HTTP request.static java.util.List<org.apache.commons.fileupload.FileItem>
readMultipartFileItems(javax.servlet.http.HttpServletRequest request)
Parses a request of the formmultipart/form-data
.static java.util.List<org.apache.commons.fileupload.FileItem>
readMultipartFileItems(javax.servlet.http.HttpServletRequest request, java.lang.String tempFolderPath)
Parses a request of the formmultipart/form-data
.static java.util.Map<java.lang.String,java.lang.String[]>
readParameterMapFromMultiPart(java.lang.String encoding, java.util.List<org.apache.commons.fileupload.FileItem> multiPartFileItems)
Creates a "standard" request parameter map from the values of amultipart/form-data
request.static void
redirectPermanently(CmsJspActionElement jsp, java.lang.String target)
Redirects the response to the target link using a "301 - Moved Permanently" header.static void
redirectRequestSecure(CmsJspActionElement jsp, java.lang.String target)
Redirects the response to the target link.static void
removeSessionValue(javax.servlet.http.HttpServletRequest request, java.lang.String key)
Removes an object from the session of the given http request.static void
setCookieValue(CmsJspActionElement jsp, java.lang.String name, java.lang.String value)
Sets the value of a specific cookie.static void
setNoCacheHeaders(javax.servlet.http.HttpServletResponse res)
Sets headers to the given response to prevent client side caching.static void
setSessionValue(javax.servlet.http.HttpServletRequest request, java.lang.String key, java.lang.Object value)
Adds an object to the session of the given HTTP request.
-
-
-
Field Detail
-
ATTRIBUTE_ERRORCODE
public static final java.lang.String ATTRIBUTE_ERRORCODE
Request attribute that contains the original error code.- See Also:
- Constant Field Values
-
HEADER_ACCEPT
public static final java.lang.String HEADER_ACCEPT
HTTP Accept Header for the cms:device-tag.- See Also:
- Constant Field Values
-
HEADER_ACCEPT_CHARSET
public static final java.lang.String HEADER_ACCEPT_CHARSET
HTTP Accept-Charset Header for internal requests used during static export.- See Also:
- Constant Field Values
-
HEADER_ACCEPT_LANGUAGE
public static final java.lang.String HEADER_ACCEPT_LANGUAGE
HTTP Accept-Language Header for internal requests used during static export.- See Also:
- Constant Field Values
-
HEADER_CACHE_CONTROL
public static final java.lang.String HEADER_CACHE_CONTROL
HTTP Header "Cache-Control".- See Also:
- Constant Field Values
-
HEADER_CONNECTION
public static final java.lang.String HEADER_CONNECTION
HTTP Header "Connection".- See Also:
- Constant Field Values
-
HEADER_CONTENT_DISPOSITION
public static final java.lang.String HEADER_CONTENT_DISPOSITION
The "Content-Disposition" http header.- See Also:
- Constant Field Values
-
HEADER_CONTENT_TYPE
public static final java.lang.String HEADER_CONTENT_TYPE
The "Content-Type" http header.- See Also:
- Constant Field Values
-
HEADER_EXPIRES
public static final java.lang.String HEADER_EXPIRES
HTTP Header "Expires".- See Also:
- Constant Field Values
-
HEADER_IF_MODIFIED_SINCE
public static final java.lang.String HEADER_IF_MODIFIED_SINCE
HTTP Header "If-Modified-Since".- See Also:
- Constant Field Values
-
HEADER_JSESSIONID
public static final java.lang.String HEADER_JSESSIONID
The Header that stores the session id (used by OpenCms upload applet).- See Also:
- Constant Field Values
-
HEADER_LAST_MODIFIED
public static final java.lang.String HEADER_LAST_MODIFIED
HTTP Header "Last-Modified".- See Also:
- Constant Field Values
-
HEADER_LOCATION
public static final java.lang.String HEADER_LOCATION
HTTP Header "Location".- See Also:
- Constant Field Values
-
HEADER_OPENCMS_EXPORT
public static final java.lang.String HEADER_OPENCMS_EXPORT
HTTP Header for internal requests used during static export.- See Also:
- Constant Field Values
-
HEADER_PRAGMA
public static final java.lang.String HEADER_PRAGMA
HTTP Header "Pragma".- See Also:
- Constant Field Values
-
HEADER_SERVER
public static final java.lang.String HEADER_SERVER
HTTP Header "Server".- See Also:
- Constant Field Values
-
HEADER_USER_AGENT
public static final java.lang.String HEADER_USER_AGENT
HTTP Header "user-agent".- See Also:
- Constant Field Values
-
HEADER_VALUE_MAX_AGE
public static final java.lang.String HEADER_VALUE_MAX_AGE
HTTP Header value "max-age=" (for "Cache-Control").- See Also:
- Constant Field Values
-
HEADER_VALUE_MUST_REVALIDATE
public static final java.lang.String HEADER_VALUE_MUST_REVALIDATE
HTTP Header value "must-revalidate" (for "Cache-Control").- See Also:
- Constant Field Values
-
HEADER_VALUE_NO_CACHE
public static final java.lang.String HEADER_VALUE_NO_CACHE
HTTP Header value "no-cache" (for "Cache-Control").- See Also:
- Constant Field Values
-
HEADER_VALUE_NO_STORE
public static final java.lang.String HEADER_VALUE_NO_STORE
HTTP Header value "no-store" (for "Cache-Control").- See Also:
- Constant Field Values
-
HEADER_WWW_AUTHENTICATE
public static final java.lang.String HEADER_WWW_AUTHENTICATE
HTTP Header "WWW-Authenticate".- See Also:
- Constant Field Values
-
HEADER_X_FORWARDED_FOR
public static final java.lang.String HEADER_X_FORWARDED_FOR
Identifier for x-forwarded-for (i.e. proxied) request headers.- See Also:
- Constant Field Values
-
PARAMETER_ASSIGNMENT
public static final java.lang.String PARAMETER_ASSIGNMENT
Assignment char between parameter name and values.- See Also:
- Constant Field Values
-
PARAMETER_DELIMITER
public static final java.lang.String PARAMETER_DELIMITER
Delimiter char between parameters.- See Also:
- Constant Field Values
-
URL_DELIMITER
public static final java.lang.String URL_DELIMITER
Delimiter char between url and query.- See Also:
- Constant Field Values
-
backlinkCheckEnabled
public static boolean backlinkCheckEnabled
Flag to enable / disable backlink checks.
-
-
Method Detail
-
appendParameter
public static java.lang.String appendParameter(java.lang.String url, java.lang.String paramName, java.lang.String paramValue)
Appends a request parameter to the given URL.This method takes care about the adding the parameter as an additional parameter (appending
¶m=value
) or as the first parameter (appending?param=value
).- Parameters:
url
- the URL where to append the parameter toparamName
- the paramter name to appendparamValue
- the parameter value to append- Returns:
- the URL with the given parameter appended
-
appendParameters
public static java.lang.String appendParameters(java.lang.String url, java.util.Map<java.lang.String,java.lang.String[]> params, boolean encode)
Appends a map of request parameters to the given URL.The map can contains values of
String[]
or simpleString
values.This method takes care about the adding the parameter as an additional parameter (appending
¶m=value
) or as the first parameter (appending?param=value
).- Parameters:
url
- the URL where to append the parameter toparams
- the parameters to appendencode
- iftrue
, the parameter values are encoded before they are appended- Returns:
- the URL with the given parameter appended
-
checkBacklink
public static boolean checkBacklink(java.lang.String backlink, javax.servlet.http.HttpServletRequest optionalRequest)
Checks that the given link is a valid backlink for editors.This means that the link is either just a path, or starts with a scheme/domain/port that is either registered in the site configuration, or is the same as that of the current request.
- Parameters:
backlink
- the link to checkoptionalRequest
- the current request - may be null if no check against the current request is desired- Returns:
- true if the link is a valid backlink
-
createParameterMap
public static java.util.Map<java.lang.String,java.lang.String[]> createParameterMap(java.util.Map<java.lang.String,?> params)
Creates a valid request parameter map from the given map, most notably changing the values formString
toString[]
if required.If the given parameter map is
null
, thennull
is returned.- Parameters:
params
- the map of parameters to create a parameter map from- Returns:
- the created parameter map, all values will be instances of
String[]
-
createParameterMap
public static java.util.Map<java.lang.String,java.lang.String[]> createParameterMap(java.lang.String query)
Parses the parameters of the given request query part and creates a parameter map out of them.Please note: This does not parse a full request URI/URL, only the query part that starts after the "?". For example, in the URI
/system/index.html?a=b&c=d
, the query part isa=b&c=d
.If the given String is empty, an empty map is returned.
- Parameters:
query
- the query to parse- Returns:
- the parameter map created from the query
-
createParameterMap
public static java.util.Map<java.lang.String,java.lang.String[]> createParameterMap(java.lang.String query, boolean decodeParameters, java.lang.String encoding)
Parses the parameters of the given request query part, optionally decodes them, and creates a parameter map out of them.Please note: This does not parse a full request URI/URL, only the query part that starts after the "?". For example, in the URI
/system/index.html?a=b&c=d
, the query part isa=b&c=d
.If the given String is empty, an empty map is returned.
- Parameters:
query
- the query to parsedecodeParameters
- a flag, indicating if the parameters should be decoded.encoding
- the character encoding used while decoding. Ifnull
, the default character encoding is used.- Returns:
- the parameter map created from the query
-
disableCrossSiteFrameEmbedding
public static void disableCrossSiteFrameEmbedding(javax.servlet.http.HttpServletResponse response)
Sets HTTP response headers to disable embedding in iframes on different domains.- Parameters:
response
- the response on which to set the HTTP headers
-
encodeParams
public static java.lang.String encodeParams(javax.servlet.http.HttpServletRequest req)
Returns all parameters of the given request as a request parameter URL String, that is in the formkey1=value1&key2=value2
etc. The result will be encoded using the
function.CmsEncoder.encode(String)
- Parameters:
req
- the request to read the parameters from- Returns:
- all initialized parameters of the given request as request parameter URL String
-
encodeParamsWithUri
public static java.lang.String encodeParamsWithUri(java.lang.String uri, javax.servlet.http.HttpServletRequest req)
Encodes the given URI, with all parameters from the given request appended.The result will be encoded using the
function.CmsEncoder.encode(String)
- Parameters:
req
- the request where to read the parameters fromuri
- the URI to encode- Returns:
- the encoded URI, with all parameters from the given request appended
-
forwardRequest
public static void forwardRequest(java.lang.String target, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) throws java.io.IOException, javax.servlet.ServletException
Forwards the response to the given target, which may contain parameters appended like for example?a=b&c=d
.Please note: If possible, use
where the parameters are passed as a map, since the parsing of the parameters may introduce issues with encoding and is in general much less effective.forwardRequest(String, Map, HttpServletRequest, HttpServletResponse)
The parsing of parameters will likely fail for "large values" (e.g. full blown web forms with <textarea> elements etc. Use this method only if you know that the target will just contain up to 3 parameters which are relatively short and have no encoding or line break issues.
- Parameters:
target
- the target to forward to (may contain parameters like?a=b&c=d
)req
- the request to forwardres
- the response to forward- Throws:
java.io.IOException
- in case the forwarding failsjavax.servlet.ServletException
- in case the forwarding fails
-
forwardRequest
public static void forwardRequest(java.lang.String target, java.util.Map<java.lang.String,java.lang.String[]> params, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) throws java.io.IOException, javax.servlet.ServletException
Forwards the response to the given target, with the provided parameter map.The target URI must NOT have parameters appended like for example
?a=b&c=d
. The values in the provided map must be of typeString[]
. If required, use
before calling this method to make sure all values are actually of the required array type.createParameterMap(Map)
- Parameters:
target
- the target to forward to (may NOT contain parameters like?a=b&c=d
)params
- the parameter map (the values must be of typeString[]
req
- the request to forwardres
- the response to forward- Throws:
java.io.IOException
- in case the forwarding failsjavax.servlet.ServletException
- in case the forwarding fails
-
getAtrributeMap
public static java.util.Map<java.lang.String,java.lang.Object> getAtrributeMap(javax.servlet.ServletRequest req)
Exactly like getAttributeMap, but incorrectly spelled.Kept for backward compatibility.
- Parameters:
req
- the request- Returns:
- the attribute map
-
getAttributeMap
public static java.util.Map<java.lang.String,java.lang.Object> getAttributeMap(javax.servlet.ServletRequest req)
Returns a map with all request attributes.- Parameters:
req
- the request- Returns:
- the attribute map
-
getCookieValue
public static java.lang.String getCookieValue(CmsJspActionElement jsp, java.lang.String name)
Returns the value of the cookie with the given name.- Parameters:
jsp
- the CmsJspActionElement to usename
- the name of the cookie- Returns:
- the value of the cookie with the given name or null, if no cookie exists with the name
-
getCookieValue
public static java.lang.String getCookieValue(javax.servlet.http.Cookie[] cookies, java.lang.String name)
Gets the value of a specific cookie from an array of cookies.- Parameters:
cookies
- the cookie arrayname
- the name of the cookie we want- Returns:
- the cookie value, or null if cookie with the given name wasn't found
-
getJsonParameterMap
public static JSONObject getJsonParameterMap(java.util.Map<java.lang.String,java.lang.String[]> params)
Converts the given parameter map into an JSON object.- Parameters:
params
- the parameters map to convert- Returns:
- the JSON representation of the given parameter map
-
getNotEmptyDecodedParameter
public static java.lang.String getNotEmptyDecodedParameter(javax.servlet.http.HttpServletRequest request, java.lang.String paramName)
Reads value from the request parameters, will returnnull
if the value is not available or only white space.The value of the request will also be decoded using
and also trimmed usingCmsEncoder.decode(String)
.String.trim()
- Parameters:
request
- the request to read the parameter fromparamName
- the parameter name to read- Returns:
- the request parameter value for the given parameter
-
getNotEmptyParameter
public static java.lang.String getNotEmptyParameter(javax.servlet.http.HttpServletRequest request, java.lang.String paramName)
Reads value from the request parameters, will returnnull
if the value is not available or only white space.- Parameters:
request
- the request to read the parameter fromparamName
- the parameter name to read- Returns:
- the request parameter value for the given parameter
-
getParameterMapFromJSON
public static java.util.Map<java.lang.String,java.lang.String[]> getParameterMapFromJSON(JSONObject params)
Converts the given JSON object into a valid parameter map.- Parameters:
params
- the JSON object to convert- Returns:
- the parameter map from the given JSON object
-
getParameters
public static com.google.common.collect.Multimap<java.lang.String,java.lang.String> getParameters(java.net.URI uri)
Parses parameter map from the given URI.- Parameters:
uri
- the URI- Returns:
- the parameter map
-
getParametersFromRawQuery
public static com.google.common.collect.Multimap<java.lang.String,java.lang.String> getParametersFromRawQuery(java.lang.String rawQuery)
Parses the parameter map from a raw query string.- Parameters:
rawQuery
- the raw query string- Returns:
- the parameter map
-
getRequestLink
public static java.lang.String getRequestLink(java.lang.String url)
Returns the link without parameters from a String that is formatted for a GET request.- Parameters:
url
- the URL to remove the parameters from- Returns:
- the URL without any parameters
-
getSessionValue
public static java.lang.Object getSessionValue(javax.servlet.http.HttpServletRequest request, java.lang.String key)
Reads an object from the session of the given HTTP request.A session will be initialized if the request does not currently have a session. As a result, the request will always have a session after this method has been called.
Will return
null
if no corresponding object is found in the session.- Parameters:
request
- the request to get the session fromkey
- the key of the object to read from the session- Returns:
- the object received form the session, or
null
-
readMultipartFileItems
public static java.util.List<org.apache.commons.fileupload.FileItem> readMultipartFileItems(javax.servlet.http.HttpServletRequest request)
Parses a request of the formmultipart/form-data
. The result list will contain items of type
. If the request is not of typeFileItem
multipart/form-data
, thennull
is returned.- Parameters:
request
- the HTTP servlet request to parse- Returns:
- the list of
extracted from the multipart request, orFileItem
null
if the request was not of typemultipart/form-data
-
readMultipartFileItems
public static java.util.List<org.apache.commons.fileupload.FileItem> readMultipartFileItems(javax.servlet.http.HttpServletRequest request, java.lang.String tempFolderPath)
Parses a request of the formmultipart/form-data
. The result list will contain items of type
. If the request is not of typeFileItem
multipart/form-data
, thennull
is returned.- Parameters:
request
- the HTTP servlet request to parsetempFolderPath
- the real file system path to the temp file folder- Returns:
- the list of
extracted from the multipart request, orFileItem
null
if the request was not of typemultipart/form-data
-
readParameterMapFromMultiPart
public static java.util.Map<java.lang.String,java.lang.String[]> readParameterMapFromMultiPart(java.lang.String encoding, java.util.List<org.apache.commons.fileupload.FileItem> multiPartFileItems)
Creates a "standard" request parameter map from the values of amultipart/form-data
request.- Parameters:
encoding
- the encoding to use when creating the valuesmultiPartFileItems
- the list of parsed multi part file items- Returns:
- a map containing all non-file request parameters
- See Also:
readMultipartFileItems(HttpServletRequest)
-
redirectPermanently
public static void redirectPermanently(CmsJspActionElement jsp, java.lang.String target)
Redirects the response to the target link using a "301 - Moved Permanently" header.This implementation will work only on JSP pages in OpenCms that use the default JSP loader implementation.
- Parameters:
jsp
- the OpenCms JSP contexttarget
- the target link
-
redirectRequestSecure
public static void redirectRequestSecure(CmsJspActionElement jsp, java.lang.String target) throws java.io.IOException
Redirects the response to the target link.Use this method instead of
HttpServletResponse.sendRedirect(java.lang.String)
to avoid relative links with secure sites (and issues with apache).- Parameters:
jsp
- the OpenCms JSP contexttarget
- the target link- Throws:
java.io.IOException
- if something goes wrong during redirection
-
removeSessionValue
public static void removeSessionValue(javax.servlet.http.HttpServletRequest request, java.lang.String key)
Removes an object from the session of the given http request.A session will be initialized if the request does not currently have a session. As a result, the request will always have a session after this method has been called.
- Parameters:
request
- the request to get the session fromkey
- the key of the object to be removed from the session
-
setCookieValue
public static void setCookieValue(CmsJspActionElement jsp, java.lang.String name, java.lang.String value)
Sets the value of a specific cookie.If no cookie exists with the value, a new cookie will be created.
- Parameters:
jsp
- the CmsJspActionElement to usename
- the name of the cookievalue
- the value of the cookie
-
setNoCacheHeaders
public static void setNoCacheHeaders(javax.servlet.http.HttpServletResponse res)
Sets headers to the given response to prevent client side caching.The following headers are set:
Cache-Control: max-age=0
Cache-Control: must-revalidate
Pragma: no-cache- Parameters:
res
- the request where to set the no-cache headers
-
setSessionValue
public static void setSessionValue(javax.servlet.http.HttpServletRequest request, java.lang.String key, java.lang.Object value)
Adds an object to the session of the given HTTP request.A session will be initialized if the request does not currently have a session. As a result, the request will always have a session after this method has been called.
- Parameters:
request
- the request to get the session fromkey
- the key of the object to be stored in the sessionvalue
- the object to be stored in the session
-
-