Module com.aoapps.web.framework

Package com.aoapps.web.framework

Class WebSiteRequest

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

com.aoapps.web.framework.WebSiteRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest

public class WebSiteRequest
extends HttpServletRequestWrapper

A WebSiteSettings contains all the values that a user may customize while they view the web site.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebSiteRequest.Initializer	Shuts-down background clean-up thread on application stop.

Field Summary

Fields

Modifier and Type	Field	Description
static final ScopeEE.Session.Attribute<String>	LAYOUT	Parameter that selects the WebPageLayout.
static final String	LOGIN_PASSWORD	Parameter that contains the login password during authentication.
static final String	LOGIN_REQUESTED	Parameter name used for login requests.
static final String	LOGIN_USERNAME	Parameter that contains the login username during authentication.
static final String	LOGOUT_REQUESTED	Parameter name used for logout requests.
static final String	SEARCH_ENTIRE_SITE	Parameter value for SEARCH_TARGET to search the entire site.
static final String	SEARCH_QUERY	Parameter the contains the search query for in-site search on the current page.
static final String	SEARCH_TARGET	Parameter that contains the search target (current SEARCH_ENTIRE_SITE or SEARCH_THIS_AREA).
static final String	SEARCH_THIS_AREA	Parameter value for SEARCH_TARGET to search the current area of the site.
protected final WebPage	sourcePage

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor	Description
WebSiteRequest(WebPage sourcePage, HttpServletRequest req)	Creates a new website request wrapper.

Method Summary

Modifier and Type	Method	Description
protected static boolean	appendEncodedParam(StringBuilder url, String encodedName, String encodedValue, boolean hasQuery)	Appends an already-encoded parameter to a URL.
protected static boolean	appendParam(StringBuilder url, String name, String value, boolean hasQuery)	Appends a parameter to a URL.
protected static boolean	appendParam(StringBuilder url, String name, String value, Set<String> finishedParams, boolean hasQuery)	Appends a parameter to a URL.
protected static boolean	appendParams(StringBuilder url, URIParameters params, Set<String> finishedParams, boolean hasQuery)	Appends the parameters to a URL.
protected boolean	appendSettings(Set<String> finishedParams, boolean hasQuery, StringBuilder url)
String	getEncodedUrl(WebPage page, URIParameters params, HttpServletResponse resp)	Gets the URL.
String	getEncodedUrl(WebPage page, HttpServletResponse resp)	Gets the URL.
String	getEncodedUrl(Class<? extends WebPage> clazz, URIParameters params, HttpServletResponse resp)	Gets the URL.
String	getEncodedUrl(Class<? extends WebPage> clazz, HttpServletResponse resp)	Gets the URL.
String	getEncodedUrlForClass(String classname, URIParameters params, String fragment, HttpServletResponse resp)	Gets the URL.
String	getEncodedUrlForClass(String classname, URIParameters params, HttpServletResponse resp)	Gets the URL.
String	getEncodedUrlForClass(String classAndParamsFragment, HttpServletResponse resp)	Gets the URL.
String	getEncodedUrlForPath(String path, URIParameters params, boolean keepSettings, HttpServletResponse resp)	Gets the URL.
String	getEncodedUrlForPath(String path, URIParameters params, HttpServletResponse resp)	Gets the URL.
String	getEncodedUrlForPath(String path, HttpServletResponse resp)	Gets the URL.
Random	getFastRandom()	A fast pseudo-random number generator for non-cryptographic purposes.
String	getParameter(String name)
Enumeration<String>	getParameterNames()
String[]	getParameterValues(String name)
SecureRandom	getSecureRandom()	Gets the random number generator used for this request.
static UploadedFile	getUploadedFile(WebSiteUser owner, Identifier id, ServletContext context)	Gets a file that was uploaded given its ID.
List<UploadedFile>	getUploadedFiles()	Gets the set of files uploaded during this request.
String	getUrl(WebPage page)	Gets the context-relative URL to a web page.
String	getUrl(WebPage page, URIParameters params)	Gets the context-relative URL to a web page.
String	getUrl(Class<? extends WebPage> clazz)
String	getUrl(Class<? extends WebPage> clazz, URIParameters params)	Gets the context-relative URL to a web page.
String	getUrlForClass(String classAndParamsFragment)	Gets a context-relative URL from a String containing a classname and optional parameters/fragment.
String	getUrlForClass(String classname, URIParameters params)	Gets a context-relative URL given its classname and optional parameters.
String	getUrlForClass(String classname, URIParameters params, String fragment)	Gets a context-relative URL given its classname and optional parameters/fragment.
String	getUrlForPath(String path)	Gets the URL String, keeping the current settings.
String	getUrlForPath(String path, URIParameters params)	Gets the URL String with the given parameters embedded, keeping the current settings.
String	getUrlForPath(String path, URIParameters params, boolean keepSettings)	Gets the context-relative URL, optionally with the settings embedded.
WebSiteUser	getWebSiteUser(HttpServletResponse resp)	Gets the person who is logged in or null if no login is performed for this request.
boolean	isBlackBerry()	Determines if the request is for a BlackBerry browser.
boolean	isLinux()	Determines if the request is for a Linux browser.
boolean	isLoggedIn()	Determines if the user is currently logged in.
boolean	isLynx()	Determines if the request is for a Lynx browser.
void	logout(HttpServletResponse resp)	Logs out the current user or does nothing if not logged in.
<__ extends FlowContent<__>> void	printFormFields(__ form)	Prints the hidden variables that contain all of the current settings.

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logout, upgrade

Methods inherited from class javax.servlet.ServletRequestWrapper

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameterMap, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameterMap, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Field Details

SEARCH_QUERY

public static final String SEARCH_QUERY

Parameter the contains the search query for in-site search on the current page.

See Also:

• Constant Field Values

SEARCH_TARGET

public static final String SEARCH_TARGET

Parameter that contains the search target (current SEARCH_ENTIRE_SITE or SEARCH_THIS_AREA).

See Also:

• Constant Field Values

SEARCH_ENTIRE_SITE

public static final String SEARCH_ENTIRE_SITE

Parameter value for SEARCH_TARGET to search the entire site.

See Also:

• Constant Field Values

SEARCH_THIS_AREA

public static final String SEARCH_THIS_AREA

Parameter value for SEARCH_TARGET to search the current area of the site.

See Also:

• Constant Field Values

LAYOUT

public static final ScopeEE.Session.Attribute<String> LAYOUT

Parameter that selects the WebPageLayout.

LOGOUT_REQUESTED

public static final String LOGOUT_REQUESTED

Parameter name used for logout requests. Will perform logout when has a value that parses to Boolean.TRUE.

See Also:

• Boolean.parseBoolean(java.lang.String)
• Constant Field Values

LOGIN_REQUESTED

public static final String LOGIN_REQUESTED

Parameter name used for login requests. Will perform login when has a value that parses to Boolean.TRUE.

See Also:

• Boolean.parseBoolean(java.lang.String)
• Constant Field Values

LOGIN_USERNAME

public static final String LOGIN_USERNAME

Parameter that contains the login username during authentication.

See Also:

• Constant Field Values

LOGIN_PASSWORD

public static final String LOGIN_PASSWORD

Parameter that contains the login password during authentication.

See Also:

• Constant Field Values

sourcePage

protected final WebPage sourcePage

Constructor Details

WebSiteRequest

public WebSiteRequest(WebPage sourcePage,
 HttpServletRequest req)
               throws ServletException

Creates a new website request wrapper.

Throws:

ServletException

Method Details

getSecureRandom

public SecureRandom getSecureRandom()

Gets the random number generator used for this request.

Note: This is not a strong instance to avoid blocking.

getFastRandom

public Random getFastRandom()

A fast pseudo-random number generator for non-cryptographic purposes.

appendEncodedParam

protected static boolean appendEncodedParam(StringBuilder url,
 String encodedName,
 String encodedValue,
 boolean hasQuery)

Appends an already-encoded parameter to a URL.

Parameters:

encodedName - the encoded name

encodedValue - the encoded value

appendParam

protected static boolean appendParam(StringBuilder url,
 String name,
 String value,
 boolean hasQuery)

Appends a parameter to a URL.

Parameters:

name - the raw, unencoded name

value - the raw, unencoded value

appendParam

protected static boolean appendParam(StringBuilder url,
 String name,
 String value,
 Set<String> finishedParams,
 boolean hasQuery)

Appends a parameter to a URL.

Parameters:

name - the raw, unencoded name

value - the raw, unencoded value

finishedParams - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

appendParams

protected static boolean appendParams(StringBuilder url,
 URIParameters params,
 Set<String> finishedParams,
 boolean hasQuery)

Appends the parameters to a URL.

Parameters:

finishedParams - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

getUrlForClass

public String getUrlForClass(String classname,
 URIParameters params,
 String fragment)
                      throws ServletException

Gets a context-relative URL given its classname and optional parameters/fragment.

Parameters:

params - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

Throws:

ServletException

getEncodedUrlForClass

public String getEncodedUrlForClass(String classname,
 URIParameters params,
 String fragment,
 HttpServletResponse resp)
                             throws ServletException

Gets the URL. Including:

1. Prefixing context path
2. Encoded to ASCII-only RFC 3986 format
3. Then response encoding

Parameters:

params - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

Throws:

ServletException

getUrlForClass

public String getUrlForClass(String classname,
 URIParameters params)
                      throws ServletException

Gets a context-relative URL given its classname and optional parameters.

Parameters:

params - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

Throws:

ServletException

getEncodedUrlForClass

public String getEncodedUrlForClass(String classname,
 URIParameters params,
 HttpServletResponse resp)
                             throws ServletException

Gets the URL. Including:

1. Prefixing context path
2. Encoded to ASCII-only RFC 3986 format
3. Then response encoding

Parameters:

params - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

Throws:

ServletException

getUrlForClass

public String getUrlForClass(String classAndParamsFragment)
                      throws ServletException

Gets a context-relative URL from a String containing a classname and optional parameters/fragment. Parameters and fragment should already be URL encoded but not XML encoded.

Throws:

ServletException

getEncodedUrlForClass

public String getEncodedUrlForClass(String classAndParamsFragment,
 HttpServletResponse resp)
                             throws ServletException

Gets the URL. Including:

1. Prefixing context path
2. Encoded to ASCII-only RFC 3986 format
3. Then response encoding

Throws:

ServletException

getUrlForPath

public String getUrlForPath(String path,
 URIParameters params,
 boolean keepSettings)
                     throws ServletException

Gets the context-relative URL, optionally with the settings embedded.

Parameters:

path - the context-relative path, with a beginning slash

params - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

Throws:

ServletException

getEncodedUrlForPath

public String getEncodedUrlForPath(String path,
 URIParameters params,
 boolean keepSettings,
 HttpServletResponse resp)
                            throws ServletException

Gets the URL. Including:

1. Prefixing context path
2. Encoded to ASCII-only RFC 3986 format
3. Then response encoding

Parameters:

path - the context-relative path, with a beginning slash

params - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

Throws:

ServletException

appendSettings

protected boolean appendSettings(Set<String> finishedParams,
 boolean hasQuery,
 StringBuilder url)

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface ServletRequest

Overrides:

getParameter in class ServletRequestWrapper

getParameterNames

public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface ServletRequest

Overrides:

getParameterNames in class ServletRequestWrapper

getParameterValues

public String[] getParameterValues(String name)

Specified by:

getParameterValues in interface ServletRequest

Overrides:

getParameterValues in class ServletRequestWrapper

getUrl

public String getUrl(WebPage page)
              throws ServletException

Gets the context-relative URL to a web page.

Throws:

ServletException

getEncodedUrl

public String getEncodedUrl(WebPage page,
 HttpServletResponse resp)
                     throws ServletException

Gets the URL. Including:

1. Prefixing context path
2. Encoded to ASCII-only RFC 3986 format
3. Then response encoding

Throws:

ServletException

getUrl

public String getUrl(WebPage page,
 URIParameters params)
              throws ServletException

Gets the context-relative URL to a web page.

Parameters:

params - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

Throws:

ServletException

getEncodedUrl

public String getEncodedUrl(WebPage page,
 URIParameters params,
 HttpServletResponse resp)
                     throws ServletException

Gets the URL. Including:

1. Prefixing context path
2. Encoded to ASCII-only RFC 3986 format
3. Then response encoding

Parameters:

params - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

Throws:

ServletException

getUrl

public String getUrl(Class<? extends WebPage> clazz,
 URIParameters params)
              throws ServletException

Gets the context-relative URL to a web page.

Parameters:

params - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

Throws:

ServletException

getEncodedUrl

public String getEncodedUrl(Class<? extends WebPage> clazz,
 URIParameters params,
 HttpServletResponse resp)
                     throws ServletException

Gets the URL. Including:

1. Prefixing context path
2. Encoded to ASCII-only RFC 3986 format
3. Then response encoding

Parameters:

params - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

Throws:

ServletException

getUrl

public String getUrl(Class<? extends WebPage> clazz)
              throws ServletException

Throws:

ServletException

getEncodedUrl

public String getEncodedUrl(Class<? extends WebPage> clazz,
 HttpServletResponse resp)
                     throws ServletException

Gets the URL. Including:

1. Prefixing context path
2. Encoded to ASCII-only RFC 3986 format
3. Then response encoding

Throws:

ServletException

getUrlForPath

public String getUrlForPath(String path,
 URIParameters params)
                     throws ServletException

Gets the URL String with the given parameters embedded, keeping the current settings.

Parameters:

path - the context-relative path, with a beginning slash

params - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

Throws:

ServletException

getUrlForPath

public String getUrlForPath(String path)
                     throws ServletException

Gets the URL String, keeping the current settings.

Parameters:

path - the context-relative path, with a beginning slash

Throws:

ServletException

getEncodedUrlForPath

public String getEncodedUrlForPath(String path,
 URIParameters params,
 HttpServletResponse resp)
                            throws ServletException

Gets the URL. Including:

1. Prefixing context path
2. Encoded to ASCII-only RFC 3986 format
3. Then response encoding

Parameters:

path - the context-relative path, with a beginning slash

params - Only adds a value when the name has not already been added to the URL. This does not support multiple values, only the first is used.

Throws:

ServletException

getEncodedUrlForPath

public String getEncodedUrlForPath(String path,
 HttpServletResponse resp)
                            throws ServletException

Gets the URL. Including:

1. Prefixing context path
2. Encoded to ASCII-only RFC 3986 format
3. Then response encoding

Parameters:

path - the context-relative path, with a beginning slash

Throws:

ServletException

isLynx

public boolean isLynx()

Determines if the request is for a Lynx browser.

isBlackBerry

public boolean isBlackBerry()

Determines if the request is for a BlackBerry browser.

isLinux

public boolean isLinux()

Determines if the request is for a Linux browser.

printFormFields

public <__ extends FlowContent<__>> void printFormFields(__ form)
                                                  throws ServletException,
IOException

Prints the hidden variables that contain all of the current settings.

Throws:

ServletException

IOException

getUploadedFiles

public List<UploadedFile> getUploadedFiles()

Gets the set of files uploaded during this request.

getUploadedFile

public static UploadedFile getUploadedFile(WebSiteUser owner,
 Identifier id,
 ServletContext context)
                                    throws SecurityException

Gets a file that was uploaded given its ID. The authentication credentials for this request must match those of the provided ID.

Parameters:

owner - the owner of the object

Returns:

the UploadedFile or null if not found

Throws:

SecurityException - if the ID is not assigned to the person logged in

getWebSiteUser

public WebSiteUser getWebSiteUser(HttpServletResponse resp)
                           throws ServletException,
LoginException

Gets the person who is logged in or null if no login is performed for this request.

Parameters:

resp - The current response or null when invoked from WebPage.getLastModified(javax.servlet.http.HttpServletRequest)

Throws:

LoginException - if an invalid login attempt is made or the user credentials are not found

ServletException

isLoggedIn

public boolean isLoggedIn()
                   throws ServletException

Determines if the user is currently logged in.

Throws:

ServletException

logout

public void logout(HttpServletResponse resp)

Logs out the current user or does nothing if not logged in.