org.jahia.utils

Class WebUtils

java.lang.Object

org.jahia.utils.WebUtils

public final class WebUtils
extends Object

Miscellaneous request/response handling methods.

Author:

Sergiy Shyrkov

Method Summary

Modifier and Type	Method and Description
static String	escapePath(String path) Does a URL encoding of the path.
static org.apache.shiro.subject.Subject	getAuthenticatedSubject(javax.servlet.http.HttpServletRequest request) Return authenticated subject, performing login using basic authentication credentials, if provided in the current request.
static String[]	getBasicAuthData(javax.servlet.http.HttpServletRequest request) Returns the username and password pair from provided request if it contains authorization header of type BASIC.
static String	getInternetExplorerCompatibility(javax.servlet.http.HttpServletRequest request) Returns the value for the X-UA-Compatible tag, based on the configuration and current UI theme.
static InputStream	getResourceAsStream(String path) Returns the InputStream for the specified servlet context resource.
static String	getResourceAsString(String path) Loads the content of the specified servlet context resource as text.
static String	getUITheme(javax.servlet.http.HttpServletRequest request) Returns the value of the currently active UI theme, considering the theme request parameter, session scope attribute, user preferred theme property and finally the globally configured theme.
static String	lookupResourceAsString(String... lookupPaths) Loads the content of the servlet context resource as text looking up the specified paths until the first resource is found.
static void	setCacheHeaders(long expiresSeconds, javax.servlet.http.HttpServletResponse response) Sets proper response headers to cache current response for the specified number of seconds.
static void	setFileDownloadHeaders(javax.servlet.http.HttpServletResponse response, String fileName) Sets proper response headers in case of file download using the provided file name.
static void	setNoCacheHeaders(javax.servlet.http.HttpServletResponse response) Sets proper response headers to prevent caching of this response.
static String	urlDecode(String url) Decodes a application/x-www-form-urlencoded string using the character encoding, configured in jahia.properties.

Methods inherited from class java.lang.Object

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

Method Detail

escapePath

public static String escapePath(String path)

Does a URL encoding of the path. The characters that don't need encoding are those defined 'unreserved' in section 2.3 of the 'URI generic syntax' RFC 2396. Not the entire path string is escaped, but every individual part (i.e. the slashes are not escaped).

Parameters:

path - the path to encode

Returns:

the escaped path

Throws:

NullPointerException - if path is null.

See Also:

Text.escapePath(String)

getAuthenticatedSubject

public static org.apache.shiro.subject.Subject getAuthenticatedSubject(javax.servlet.http.HttpServletRequest request)
                                                                throws org.apache.shiro.authc.AuthenticationException

Return authenticated subject, performing login using basic authentication credentials, if provided in the current request.

Parameters:

request - current HTTP request

Returns:

authenticated subject, performing login using basic authentication credentials, if provided in the current request

Throws:

org.apache.shiro.authc.AuthenticationException - in case of errors during login operation

getBasicAuthData

public static String[] getBasicAuthData(javax.servlet.http.HttpServletRequest request)

Returns the username and password pair from provided request if it contains authorization header of type BASIC.

Parameters:

request - current HTTP request

Returns:

the username/password pair from the current request header or null if the request does not contain such information

getInternetExplorerCompatibility

public static String getInternetExplorerCompatibility(javax.servlet.http.HttpServletRequest request)

Returns the value for the X-UA-Compatible tag, based on the configuration and current UI theme.

Parameters:

request - current HTTP request

Returns:

the value for the X-UA-Compatible tag, based on the configuration and current UI theme

getResourceAsStream

public static InputStream getResourceAsStream(String path)
                                       throws IOException

Returns the InputStream for the specified servlet context resource.

Parameters:

path - the resource path (context relative)

Returns:

an InputStream for the specified resource content or null if the corresponding resource does not exist

Throws:

IOException - in case of a problem reading resource content

getResourceAsString

public static String getResourceAsString(String path)
                                  throws IOException

Loads the content of the specified servlet context resource as text.

Parameters:

path - the resource path (context relative)

Returns:

the text of the specified resource content or null if the corresponding resource does not exist

Throws:

IOException - in case of a problem reading resource content

getUITheme

public static String getUITheme(javax.servlet.http.HttpServletRequest request)

Returns the value of the currently active UI theme, considering the theme request parameter, session scope attribute, user preferred theme property and finally the globally configured theme.

Parameters:

request - current HTTP request

Returns:

the value for of the currently active UI theme

lookupResourceAsString

public static String lookupResourceAsString(String... lookupPaths)
                                     throws IOException

Loads the content of the servlet context resource as text looking up the specified paths until the first resource is found.

Parameters:

lookupPaths - the resource paths to lookup (context relative)

Returns:

the text of the specified resource content or null if the corresponding resource does not exist

Throws:

IOException - in case of a problem reading resource content

setCacheHeaders

public static void setCacheHeaders(long expiresSeconds,
                                   javax.servlet.http.HttpServletResponse response)

Sets proper response headers to cache current response for the specified number of seconds.

Parameters:

expiresSeconds - the expiration in seconds

response - current response object

setNoCacheHeaders

public static void setNoCacheHeaders(javax.servlet.http.HttpServletResponse response)

Sets proper response headers to prevent caching of this response.

Parameters:

response - current response object

setFileDownloadHeaders

public static void setFileDownloadHeaders(javax.servlet.http.HttpServletResponse response,
                                          String fileName)

Sets proper response headers in case of file download using the provided file name.

Parameters:

response - current response

fileName - the file name to use in the response header

urlDecode

public static String urlDecode(String url)

Decodes a application/x-www-form-urlencoded string using the character encoding, configured in jahia.properties.

Parameters:

url - the string to be decoded

Returns:

the decoded string