Module com.aoapps.web.framework

Package com.aoapps.web.framework

Class WebPage

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

com.aoapps.web.resources.servlet.PageServlet

com.aoapps.web.framework.WebPage

All Implemented Interfaces:

Servlet, ServletConfig, Serializable

Direct Known Subclasses:

AutoListPage, DumpURLs, FilePage, InputStreamPage, RedirectWebPage, TreePage

public abstract class WebPage
extends PageServlet

The main web page provides the overall layout of the site. The rest of the site overrides methods of this class, but cannot override the doGet(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse), doPost(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse), or getLastModified(jakarta.servlet.http.HttpServletRequest) methods.

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static final WebPage[]	emptyWebPageArray	An empty array of WebPage objects to be used in returning no web pages.
static final Pattern	reHTMLPattern
static final String	SEARCH_TWO	The name of the search form during per-page searches.

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
WebPage()

Method Summary

Modifier and Type	Method	Description
boolean	canAccess(WebSiteUser user)	Determines if the provided user can access the page.
void	configureResources(ServletContext servletContext, WebSiteRequest req, HttpServletResponse resp, WebPageLayout layout, Registry pageRegistry)	Configures the page-scope web resources that this page uses.
void	doGet(WebSiteRequest req, HttpServletResponse resp)	Prepares the request then invokes doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE).
void	doGet(WebSiteRequest req, HttpServletResponse resp, DocumentEE document)	The layout is automatically applied to the page, then doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.FlowContent) is called.
<__ extends FlowContent<__>> void	doGet(WebSiteRequest req, HttpServletResponse resp, WebPageLayout layout, __ flow)	By default, GET provides no content.
protected final void	doGet(HttpServletRequest httpReq, HttpServletResponse resp)	The main entry point for GET requests.
void	doPost(WebSiteRequest req, HttpServletResponse resp)	Prepares the request then invokes doPost(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE).
void	doPost(WebSiteRequest req, HttpServletResponse resp, DocumentEE document)	The layout is automatically applied to the page, then doPost(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.FlowContent) is called.
<__ extends FlowContent<__>> void	doPost(WebSiteRequest req, HttpServletResponse resp, WebPageLayout layout, __ flow)	By default, a POST request just calls doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.FlowContent).
protected final void	doPost(HttpServletRequest httpReq, HttpServletResponse resp)	The main entry point for GET requests.
protected void	doPostWithSearch(WebSiteRequest req, HttpServletResponse resp)	Handles any search posts, sends everything else on to doPost(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse).
boolean	equals(WebPage other)	Determines if this page equals another page.
final boolean	equals(Object obj)	Determines if this page equals another page.
String	generateUrlPath(WebPage page)	Generates a URL path for this or another page, please call getUrlPath() instead.
String	getAuthor(WebSiteRequest req)	Gets the author of this page.
String	getAuthorHref(WebSiteRequest req, HttpServletResponse resp)	Gets the URL for the author of this page.
protected boolean	getAutonli(WebSiteRequest req)	Gets the automatic newline and indentation setting to use for this page.
WebPage[]	getCachedChildren(WebSiteRequest req, HttpServletResponse resp)	Gets all of the pages that are children of this one in the page hierarchy.
protected WebPage[]	getChildren(WebSiteRequest req, HttpServletResponse resp)	Gets all of the children pages of this one in the page hierarchy.
protected final long	getClassLastModified()	Gets the last modified time of the java class file.
String	getContentValign(WebSiteRequest req)	Gets the vertical alignment of the content area.
String	getCopyright(WebSiteRequest req, HttpServletResponse resp, WebPage requestPage)	Gets the copyright information for this page.
String	getDescription(WebSiteRequest req)	Gets the description of this page.
protected Doctype	getDoctype(WebSiteRequest req)	Gets the Doctype to use for this page.
protected DocumentEE	getDocument(WebSiteRequest req, HttpServletResponse resp)	Prepares for output and returns the DocumentEE.
protected OutputStream	getHtmlOutputStream(WebSiteRequest req, HttpServletResponse resp)	Prepares for output and returns the OutputStream.
protected boolean	getIndent(WebSiteRequest req)	Gets the indentation setting to use for this page.
Object	getJavascriptSrc(WebSiteRequest req)	Gets the JavaScript's that should have script src= tags generated, urls relative to top of context path/to/javascript.js.
String	getKeywords(WebSiteRequest req)	Gets the keywords for this page.
long	getLastModified(WebSiteRequest req, HttpServletResponse resp)	The getLastModified defaults to -1.
protected final long	getLastModified(HttpServletRequest httpReq)	The main entry point for getLastModified() requests.
final long	getLastModifiedRecursive(WebSiteRequest req, HttpServletResponse resp)	Recursively gets the most recent modification time.
static long	getLastModifiedRecursive(File file)	Recursively gets the most recent modification time of a file or directory.
String	getNavImageAlt(WebSiteRequest req)	Gets the text for the navigation image to use to represent this page.
String	getNavImageSuffix(WebSiteRequest req)	Gets the text that will be placed in to the right of the navigation image.
String	getNavImageUrl(WebSiteRequest req, HttpServletResponse resp, URIParameters params)	Gets the URL associated with a nav image, fully encoded.
final WebPage	getNextPage(WebSiteRequest req, HttpServletResponse resp)	Gets the WebPage that follows this one in the parents list of pages.
String	getOnloadScript(WebSiteRequest req)	Gets the JavaScript that should be executed with the onload event of the body tag.
final int	getPageIndexInParent(WebSiteRequest req, HttpServletResponse resp)	Gets the index of this page in the parents list of children pages.
abstract WebPage	getParent()	Gets the parent of this page or null for none.
String	getPreferredContentWidth(WebSiteRequest req)	Gets the preferred width of this content or null for no preference.
final WebPage	getPreviousPage(WebSiteRequest req, HttpServletResponse resp)	Gets the WebPage that proceeds this one in the parents list of pages.
int	getRedirectType()	Gets the redirect type, defaults to 302 (temporary).
String	getRedirectUrl(WebSiteRequest req)	Gets the absolute or context-relative URL to direct to.
final WebPage	getRootPage()	Gets the root page in the web page hierarchy.
long	getSearchLastModified()	Gets the last modified time for search indexing.
protected Serialization	getSerialization(WebSiteRequest req)	Gets the Serialization to use for this page.
String	getShortTitle(WebSiteRequest req)	A short title is used showing a path to the current location in the site.
String	getTitle(WebSiteRequest req)	Gets the title of the web page in order to generate the HTML.
static long	getUptime()	Gets the time the servlet environment was loaded.
URIParameters	getUrlParams(WebSiteRequest req)	Gets parameters that are added to the query string of URLs generated for this page.
String	getUrlPath()	Gets the context-relative path for the URL.
String	getUrlPattern()	Gets the URL pattern for this page as used in web.xml.
static WebPage	getWebPage(ServletContext context, Class<? extends WebPage> clazz)	Gets an instance of WebPage given the Class.
static WebPage	getWebPage(ServletContext context, Class<? extends WebPage> clazz, URIParameters params)	Gets an instance of WebPage given the Class.
static WebPage	getWebPage(ServletContext context, Class<? extends WebPage> clazz, WebSiteRequest req)	Gets an instance of WebPage given the Class.
WebPage	getWebPage(Class<? extends WebPage> clazz)	Gets a web page given no parameters.
WebPage	getWebPage(Class<? extends WebPage> clazz, URIParameters params)	Gets a web page with parameters.
WebPage	getWebPage(Class<? extends WebPage> clazz, WebSiteRequest req)	Gets a web page given no parameters.
long	getWebPageAndChildrenLastModified(WebSiteRequest req, HttpServletResponse resp)	Gets the most recent last modified time of this page and its immediate children.
WebPageLayout	getWebPageLayout(WebSiteRequest req)	Gets the current layout for this page.
protected abstract WebSiteRequest	getWebSiteRequest(HttpServletRequest req)	Gets the WebSiteRequest that handles authentication and other details of this site.
int	hashCode()	The default hashcode for a page is the hashcode of its classname.
boolean	includeNavImageAsParent()	Determine if the nav image for this page should remain visible, even when its children are displayed.
boolean	isHandler(URIParameters params)	Determines if this page is the instance that represents a certain set of parameters.
boolean	isHandler(WebSiteRequest req)	Determines if this page is the instance that should handle a particular request.
static Class<? extends WebPage>	loadClass(String className)	Dynamically loads new classes based on the source .class file's modified time.
void	printLoginForm(WebPage page, LoginException loginException, WebSiteRequest req, HttpServletResponse resp)	Prints the form that is used to login.
void	printUnauthorizedPage(WebPage page, WebSiteRequest req, HttpServletResponse resp)	Prints the unauthorized page message.
void	search(String[] words, WebSiteRequest req, HttpServletResponse response, List<SearchResult> results, CharArrayWriter buffer, Set<WebPage> finishedPages)	Searches this WebPage and all of its subordinate pages, returning the matches in a ArrayList with five elements per match.
protected void	service(HttpServletRequest req, HttpServletResponse resp)	Stores the current response in a request attribute named RESPONSE_REQUEST_ATTRIBUTE.
void	setHeaders(WebSiteRequest req, HttpServletResponse resp)	Sets headers for this page.
boolean	showInLocationPath(WebSiteRequest req)	Determines if this page will be displayed in the location bar.
final void	standardSearch(String[] words, WebSiteRequest req, HttpServletResponse resp, List<SearchResult> results, CharArrayWriter buffer, Set<WebPage> finishedPages)	The standard implementation of the search functionality.
boolean	useNavImage()	Determines whether or not to display the page in the left navigation.
boolean	useSiteMap()	Determines if this page will be displayed in the standard site map.

Methods inherited from class com.aoapps.web.resources.servlet.PageServlet

service

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, init

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Details

SEARCH_TWO

public static final String SEARCH_TWO

The name of the search form during per-page searches.

See Also:

• Constant Field Values

emptyWebPageArray

protected static final WebPage[] emptyWebPageArray

An empty array of WebPage objects to be used in returning no web pages.

reHTMLPattern

public static final Pattern reHTMLPattern

Constructor Details

WebPage

public WebPage()

Method Details

getUptime

public static long getUptime()

Gets the time the servlet environment was loaded.

configureResources

public void configureResources(ServletContext servletContext,
 WebSiteRequest req,
 HttpServletResponse resp,
 WebPageLayout layout,
 Registry pageRegistry)

Configures the page-scope web resources that this page uses.

Implementers should call super.configureResources(…) as a matter of convention, despite this default implementation doing nothing.

canAccess

public boolean canAccess(WebSiteUser user)
                  throws ServletException

Determines if the provided user can access the page. Defaults to inheriting the behavior of the parent page.

Throws:

ServletException

printLoginForm

public void printLoginForm(WebPage page,
 LoginException loginException,
 WebSiteRequest req,
 HttpServletResponse resp)
                    throws ServletException,
IOException

Prints the form that is used to login.

Throws:

ServletException

IOException

printUnauthorizedPage

public void printUnauthorizedPage(WebPage page,
 WebSiteRequest req,
 HttpServletResponse resp)
                           throws ServletException,
IOException

Prints the unauthorized page message.

Throws:

ServletException

IOException

getLastModified

protected final long getLastModified(HttpServletRequest httpReq)

The main entry point for getLastModified() requests. Prepares the request and performs initial actions:

1. Wraps the request in WebSiteRequest via getWebSiteRequest(jakarta.servlet.http.HttpServletRequest).
2. Resolves the current instance of WebPage via getWebPage(java.lang.Class, com.aoapps.web.framework.WebSiteRequest).
3. Handles any login request (parameter WebSiteRequest.LOGIN_REQUESTED="true") by returning -1 for unknown.
4. Resolves the current WebSiteUser via WebSiteRequest.getWebSiteUser(jakarta.servlet.http.HttpServletResponse) (if any). When login required and failed, returns -1 for unknown.
5. Ensures the user can access the page, returns -1 for unknown when not authorized.
6. If is a redirect, returns -1 for unknown.
7. Finally, dispatches the request to getLastModified(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse).

Overrides:

getLastModified in class HttpServlet

See Also:

• getLastModified(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse)

getLastModified

public long getLastModified(WebSiteRequest req,
 HttpServletResponse resp)
                     throws ServletException

The getLastModified defaults to -1.

Throws:

ServletException

getClassLastModified

protected final long getClassLastModified()
                                   throws ServletException

Gets the last modified time of the java class file. If the class file is unavailable, it defaults to the time the servlets were loaded.

Throws:

ServletException

See Also:

• getUptime()

getWebPageAndChildrenLastModified

public long getWebPageAndChildrenLastModified(WebSiteRequest req,
 HttpServletResponse resp)
                                       throws ServletException

Gets the most recent last modified time of this page and its immediate children.

Throws:

ServletException

getLastModifiedRecursive

public final long getLastModifiedRecursive(WebSiteRequest req,
 HttpServletResponse resp)
                                    throws ServletException

Recursively gets the most recent modification time.

Throws:

ServletException

getLastModifiedRecursive

public static long getLastModifiedRecursive(File file)

Recursively gets the most recent modification time of a file or directory.

getSearchLastModified

public long getSearchLastModified()
                           throws ServletException

Gets the last modified time for search indexing. The index will be recreated if the search last modified time is changed. If this method returns -1, no search index is built. This defaults to be a call to getLastModified with null WebSiteRequest and HttpServletResponse.

Throws:

ServletException

getSerialization

protected Serialization getSerialization(WebSiteRequest req)

Gets the Serialization to use for this page.

Parameters:

req - null during search

See Also:

• Serialization.DEFAULT
• SerializationEE.getDefault(jakarta.servlet.ServletContext, jakarta.servlet.http.HttpServletRequest)

getDoctype

protected Doctype getDoctype(WebSiteRequest req)

Gets the Doctype to use for this page.

Parameters:

req - null during search

See Also:

• Doctype.DEFAULT

getAutonli

protected boolean getAutonli(WebSiteRequest req)

Gets the automatic newline and indentation setting to use for this page. Defaults to DocumentEE.getAutonli(jakarta.servlet.ServletContext, jakarta.servlet.ServletRequest).

Parameters:

req - null during search

See Also:

• Content.setAutonli(boolean)

getIndent

protected boolean getIndent(WebSiteRequest req)

Gets the indentation setting to use for this page. Defaults to DocumentEE.getIndent(jakarta.servlet.ServletContext, jakarta.servlet.ServletRequest).

Parameters:

req - null during search

See Also:

• Whitespace.setIndent(boolean)

getDocument

protected DocumentEE getDocument(WebSiteRequest req,
 HttpServletResponse resp)
                          throws ServletException,
IOException

Prepares for output and returns the DocumentEE.

1. clears the output buffer.
2. Sets the response content type.
3. Sets the response character encoding to the default UTF-8.
4. Sets any additional headers.

Both the Serialization and Doctype may have been set on the request, and these must be considered in the content type.

Throws:

ServletException

IOException

See Also:

• SerializationEE.get(jakarta.servlet.ServletContext, jakarta.servlet.http.HttpServletRequest)
• DoctypeEE.get(jakarta.servlet.ServletContext, jakarta.servlet.ServletRequest)
• setHeaders(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse)

getHtmlOutputStream

protected OutputStream getHtmlOutputStream(WebSiteRequest req,
 HttpServletResponse resp)
                                    throws ServletException,
IOException

Prepares for output and returns the OutputStream.

1. clears the output buffer.
2. Sets the response content type.
3. Sets the response character encoding to the default UTF-8.
4. Sets any additional headers.

Both the Serialization and Doctype may have been set on the request, and these must be considered in the content type.

Throws:

ServletException

IOException

See Also:

• SerializationEE.get(jakarta.servlet.ServletContext, jakarta.servlet.http.HttpServletRequest)
• DoctypeEE.get(jakarta.servlet.ServletContext, jakarta.servlet.ServletRequest)
• setHeaders(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse)

service

protected void service(HttpServletRequest req,
 HttpServletResponse resp)
                throws ServletException,
IOException

Stores the current response in a request attribute named RESPONSE_REQUEST_ATTRIBUTE. This is used by getLastModified(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse).

Overrides:

service in class HttpServlet

Throws:

ServletException

IOException

doGet

protected final void doGet(HttpServletRequest httpReq,
 HttpServletResponse resp)
                    throws ServletException,
IOException

The main entry point for GET requests. Prepares the request and performs initial actions:

1. Wraps the request in WebSiteRequest via getWebSiteRequest(jakarta.servlet.http.HttpServletRequest).
2. Resolves the current instance of WebPage via getWebPage(java.lang.Class, com.aoapps.web.framework.WebSiteRequest).
3. Handles any logout request (parameter WebSiteRequest.LOGOUT_REQUESTED="true") via HttpServletRequestWrapper.logout().
4. Handles any login request (parameter WebSiteRequest.LOGIN_REQUESTED="true") by invoking printLoginForm(com.aoapps.web.framework.WebPage, com.aoapps.security.LoginException, com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse) and stops here.
5. Resolves the current WebSiteUser via WebSiteRequest.getWebSiteUser(jakarta.servlet.http.HttpServletResponse) (if any). When login required and failed, invokes printLoginForm(com.aoapps.web.framework.WebPage, com.aoapps.security.LoginException, com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse) and stops here.
6. Ensures the user can access the page, invokes printUnauthorizedPage(com.aoapps.web.framework.WebPage, com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse) when not authorized and stops here.
7. If is a redirect, sends the redirect of the correct type and stops here.
8. Finally, dispatches the request to doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse).

Overrides:

doGet in class HttpServlet

Throws:

ServletException

IOException

See Also:

• doGet(WebSiteRequest, HttpServletResponse)

doGet

public void doGet(WebSiteRequest req,
 HttpServletResponse resp)
           throws ServletException,
IOException

Prepares the request then invokes doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE). To not have these steps automatically applied, override this method. By the time this method is called, security checks, authentication, and redirects have been done.

1. Sets the serialization.
2. Sets the DOCTYPE.
3. Gets the response writer.
4. Invokes doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE).

Throws:

ServletException

IOException

See Also:

• doGet(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)
• getSerialization(com.aoapps.web.framework.WebSiteRequest)
• getDoctype(com.aoapps.web.framework.WebSiteRequest)
• doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE)

doGet

public void doGet(WebSiteRequest req,
 HttpServletResponse resp,
 DocumentEE document)
           throws ServletException,
IOException

The layout is automatically applied to the page, then doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.FlowContent) is called. To not have the layout automatically applied, override this method. By the time this method is called, security checks, authentication, redirects, doctype, and serialization have been done.

Parameters:

req - the WebSiteRequest for this request, or null when searching

resp - the HttpServletResponse for this request, or null when searching

document - the DocumentEE to send output to

Throws:

ServletException

IOException

See Also:

• doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse)
• getWebPageLayout(com.aoapps.web.framework.WebSiteRequest)
• WebPageLayout.doPage(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.DocumentEE, java.lang.String, com.aoapps.servlet.function.ServletConsumerE)
• doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.FlowContent)

doGet

public <__ extends FlowContent<__>> void doGet(WebSiteRequest req,
 HttpServletResponse resp,
 WebPageLayout layout,
 __ flow)
                                        throws ServletException,
IOException

By default, GET provides no content.

Parameters:

req - the WebSiteRequest for this request, or null when searching

resp - the HttpServletResponse for this request, or null when searching

layout - the WebPageLayout that has been applied

flow - the FlowContent to send output to

Throws:

ServletException

IOException

See Also:

• doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE)

doPost

protected final void doPost(HttpServletRequest httpReq,
 HttpServletResponse resp)
                     throws ServletException,
IOException

The main entry point for GET requests. Prepares the request and performs initial actions:

1. Wraps the request in WebSiteRequest via getWebSiteRequest(jakarta.servlet.http.HttpServletRequest).
2. Resolves the current instance of WebPage via getWebPage(java.lang.Class, com.aoapps.web.framework.WebSiteRequest).
3. Handles any logout request (parameter WebSiteRequest.LOGOUT_REQUESTED="true") via HttpServletRequestWrapper.logout().
4. Handles any login request (parameter WebSiteRequest.LOGIN_REQUESTED="true") by invoking printLoginForm(com.aoapps.web.framework.WebPage, com.aoapps.security.LoginException, com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse) and stops here.
5. Resolves the current WebSiteUser via WebSiteRequest.getWebSiteUser(jakarta.servlet.http.HttpServletResponse) (if any). When login required and failed, invokes printLoginForm(com.aoapps.web.framework.WebPage, com.aoapps.security.LoginException, com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse) and stops here.
6. Ensures the user can access the page, invokes printUnauthorizedPage(com.aoapps.web.framework.WebPage, com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse) when not authorized and stops here.
7. If is a redirect, sends the redirect of the correct type and stops here.
8. Avoid unexpected POST action after a (re)login: If has parameter WebSiteRequest.LOGIN_REQUESTED="true" or both WebSiteRequest.LOGIN_USERNAME and WebSiteRequest.LOGIN_PASSWORD parameters, dispatch to doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse) and stop here.
9. Finally, dispatches the request to doPostWithSearch(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse).

Overrides:

doPost in class HttpServlet

Throws:

ServletException

IOException

See Also:

• doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse)
• doPostWithSearch(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse)

doPostWithSearch

protected void doPostWithSearch(WebSiteRequest req,
 HttpServletResponse resp)
                         throws ServletException,
IOException

Handles any search posts, sends everything else on to doPost(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse). The search assumes the search parameters of WebSiteRequest.SEARCH_QUERY and WebSiteRequest.SEARCH_TARGET. Both these values must be present for a search to be performed. Search target may be either WebSiteRequest.SEARCH_THIS_AREA or WebSiteRequest.SEARCH_ENTIRE_SITE, defaulting to WebSiteRequest.SEARCH_THIS_AREA for any other value.

Throws:

ServletException

IOException

See Also:

• doPost(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)
• doPost(WebSiteRequest, HttpServletResponse)

doPost

public void doPost(WebSiteRequest req,
 HttpServletResponse resp)
            throws ServletException,
IOException

Prepares the request then invokes doPost(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE). To not have these steps automatically applied, override this method. By the time this method is called, security checks, authentication, and redirects have been done.

1. Sets the serialization.
2. Sets the DOCTYPE.
3. Gets the response writer.
4. Invokes doPost(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE).

Throws:

ServletException

IOException

See Also:

• doPostWithSearch(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse)
• getSerialization(com.aoapps.web.framework.WebSiteRequest)
• getDoctype(com.aoapps.web.framework.WebSiteRequest)
• doPost(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE)

doPost

public void doPost(WebSiteRequest req,
 HttpServletResponse resp,
 DocumentEE document)
            throws ServletException,
IOException

The layout is automatically applied to the page, then doPost(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.FlowContent) is called. To not have the layout automatically applied, override this method. By the time this method is called, security checks, authentication, redirects, doctype, and serialization have been done.

Parameters:

req - the WebSiteRequest for this request, or null when searching

resp - the HttpServletResponse for this request, or null when searching

document - the DocumentEE to send output to

Throws:

ServletException

IOException

See Also:

• doPost(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse)
• getWebPageLayout(com.aoapps.web.framework.WebSiteRequest)
• WebPageLayout.doPage(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.DocumentEE, java.lang.String, com.aoapps.servlet.function.ServletConsumerE)
• doPost(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.FlowContent)

doPost

public <__ extends FlowContent<__>> void doPost(WebSiteRequest req,
 HttpServletResponse resp,
 WebPageLayout layout,
 __ flow)
                                         throws ServletException,
IOException

By default, a POST request just calls doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.FlowContent).

Parameters:

req - the current WebSiteRequest

resp - the HttpServletResponse for this request

layout - the WebPageLayout that has been applied

flow - the FlowContent to send output to

Throws:

ServletException

IOException

See Also:

• doPost(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE)
• doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.FlowContent)

equals

public final boolean equals(Object obj)

Determines if this page equals another page.

Overrides:

equals in class Object

See Also:

• equals(WebPage)

equals

public boolean equals(WebPage other)

Determines if this page equals another page. By default, two pages of the same class are considered equal.

See Also:

• hashCode()

hashCode

public int hashCode()

The default hashcode for a page is the hashcode of its classname.

Overrides:

hashCode in class Object

See Also:

• equals(WebPage)

setHeaders

public void setHeaders(WebSiteRequest req,
 HttpServletResponse resp)

Sets headers for this page.

getAuthor

public String getAuthor(WebSiteRequest req)
                 throws ServletException

Gets the author of this page. By default, the author of the parent page is used.

Throws:

ServletException

getAuthorHref

public String getAuthorHref(WebSiteRequest req,
 HttpServletResponse resp)
                     throws ServletException

Gets the URL for the author of this page. By default, the URL of the author of the parent page is used.

Throws:

ServletException

getPreferredContentWidth

public String getPreferredContentWidth(WebSiteRequest req)
                                throws ServletException

Gets the preferred width of this content or null for no preference. It is up to the WebPageLayout to make use of this value. The preferred width defaults to the preferred width of the parent page.

Throws:

ServletException

See Also:

• WebPageLayout

getContentValign

public String getContentValign(WebSiteRequest req)

Gets the vertical alignment of the content area. Defaults to "top". It is up to the WebPageLayout to make use of this value.

See Also:

• WebPageLayout

getDescription

public String getDescription(WebSiteRequest req)
                      throws ServletException

Gets the description of this page. By default, the description of the parent page is used. May not contain HTML.

Throws:

ServletException

getRootPage

public final WebPage getRootPage()
                          throws ServletException

Gets the root page in the web page hierarchy. The root page has no parent.

Throws:

ServletException

getJavascriptSrc

public Object getJavascriptSrc(WebSiteRequest req)
                        throws ServletException

Gets the JavaScript's that should have script src= tags generated, urls relative to top of context path/to/javascript.js.

Parameters:

req - the current WebSiteRequest

Returns:

a String[] for multiple includes, a Class for one, a WebPage for one, a Object for one via Object.toString(), or null for none

Throws:

ServletException

getKeywords

public String getKeywords(WebSiteRequest req)
                   throws ServletException

Gets the keywords for this page. By default, no keywords.

Throws:

ServletException

getNavImageAlt

public String getNavImageAlt(WebSiteRequest req)
                      throws ServletException

Gets the text for the navigation image to use to represent this page. Defaults to getShortTitle.

Returns:

the alt text of the navigation image

Throws:

ServletException

See Also:

• getShortTitle(com.aoapps.web.framework.WebSiteRequest)
• getNavImageSuffix(com.aoapps.web.framework.WebSiteRequest)
• getNavImageUrl(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.net.URIParameters)

getNavImageSuffix

public String getNavImageSuffix(WebSiteRequest req)
                         throws ServletException

Gets the text that will be placed in to the right of the navigation image. If the image is not large enough to hold both getNavImageAlt and getNavImageSuffix, the beginning is truncated and ... appended so that both fit the image.

Throws:

ServletException

See Also:

• getNavImageAlt(com.aoapps.web.framework.WebSiteRequest)
• getNavImageUrl(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.net.URIParameters)

getNavImageUrl

public String getNavImageUrl(WebSiteRequest req,
 HttpServletResponse resp,
 URIParameters params)
                      throws ServletException

Gets the URL associated with a nav image, fully encoded.

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

See Also:

• getNavImageAlt(com.aoapps.web.framework.WebSiteRequest)
• getNavImageSuffix(com.aoapps.web.framework.WebSiteRequest)

getPageIndexInParent

public final int getPageIndexInParent(WebSiteRequest req,
 HttpServletResponse resp)
                               throws ServletException

Gets the index of this page in the parents list of children pages.

Throws:

ServletException

getNextPage

public final WebPage getNextPage(WebSiteRequest req,
 HttpServletResponse resp)
                          throws ServletException

Gets the WebPage that follows this one in the parents list of pages.

Returns:

the WebPage or null if not found

Throws:

ServletException

getPreviousPage

public final WebPage getPreviousPage(WebSiteRequest req,
 HttpServletResponse resp)
                              throws ServletException

Gets the WebPage that proceeds this one in the parents list of pages.

Returns:

the WebPage or null if not found

Throws:

ServletException

getOnloadScript

public String getOnloadScript(WebSiteRequest req)

Gets the JavaScript that should be executed with the onload event of the body tag. This is a default only used when a null onload is passed to WebPageLayout.startPage(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.DocumentEE, java.lang.String).

Parameters:

req - the current WebSiteRequest

Returns:

a String or null for none

getCachedChildren

public WebPage[] getCachedChildren(WebSiteRequest req,
 HttpServletResponse resp)
                            throws ServletException

Gets all of the pages that are children of this one in the page hierarchy. Unless overridden, the pages are cached in a WebPage[] for faster access. The actual list of pages is obtained from getChildren(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse).

Pages will also not be cached if the configuration property is set to anything other than "true"

Returns:

a WebPage[] of all of the lower-level pages

Throws:

ServletException

See Also:

• getChildren(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse)

getParent

public abstract WebPage getParent()
                           throws ServletException

Gets the parent of this page or null for none.

Throws:

ServletException

getRedirectUrl

public String getRedirectUrl(WebSiteRequest req)
                      throws ServletException

Gets the absolute or context-relative URL to direct to.

Returns:

the context-relative or absolute URL to redirect to or null for no redirect.

Throws:

ServletException

getRedirectType

public int getRedirectType()

Gets the redirect type, defaults to 302 (temporary).

getShortTitle

public String getShortTitle(WebSiteRequest req)
                     throws ServletException

A short title is used showing a path to the current location in the site. The short title defaults to getTitle.

Returns:

the short page title

Throws:

ServletException

See Also:

• getTitle(com.aoapps.web.framework.WebSiteRequest)

getTitle

public String getTitle(WebSiteRequest req)
                throws ServletException

Gets the title of the web page in order to generate the HTML. The title defaults to that of the parent page.

Returns:

the page title

Throws:

ServletException

getUrlParams

public URIParameters getUrlParams(WebSiteRequest req)
                           throws ServletException

Gets parameters that are added to the query string of URLs generated for this page.

Returns:

The parameters, may be null or empty when none.

Throws:

ServletException

See Also:

• EmptyURIParameters.getInstance()

getWebPage

public WebPage getWebPage(Class<? extends WebPage> clazz,
 WebSiteRequest req)
                   throws ServletException

Gets a web page given no parameters.

Throws:

ServletException

See Also:

• getWebPage(jakarta.servlet.ServletContext, java.lang.Class, com.aoapps.web.framework.WebSiteRequest)

getWebPage

public static WebPage getWebPage(ServletContext context,
 Class<? extends WebPage> clazz,
 WebSiteRequest req)
                          throws ServletException

Gets an instance of WebPage given the Class. Instances returned should never have the init method called and should allocate a minimal set of resources.

Unless caching is disabled, the generated pages are stored in a cache and resolved using the pages isHandler method.

When creating a new instance of WebPage, searches for constructors in the following order:

1. Single argument WebSiteRequest, given the request.
2. Single argument URIParameters, given a ServletRequestParameters wrapper around request.
3. No-args constructor.

Parameters:

context - the context the servlet will be run in

clazz - the Class to get an instance of

req - the request details are used to select the right instance

Returns:

a WebPage object of the given class that matches the request settings

Throws:

IllegalArgumentException - if unable to create the instance

ServletException

See Also:

• isHandler(WebSiteRequest)

getWebPage

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

Gets a web page with parameters.

Parameters:

params - The parameters used to select the right instance.

Throws:

ServletException

See Also:

• getWebPage(jakarta.servlet.ServletContext, java.lang.Class, com.aoapps.net.URIParameters)

getWebPage

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

Gets a web page given no parameters.

Throws:

ServletException

See Also:

• getWebPage(java.lang.Class, com.aoapps.net.URIParameters)

getWebPage

public static WebPage getWebPage(ServletContext context,
 Class<? extends WebPage> clazz,
 URIParameters params)
                          throws ServletException

Gets an instance of WebPage given the Class. Instances returned should never have the init method called and should allocate a minimal set of resources.

Unless caching is disabled, the generated pages are stored in a cache and resolved using the pages isHander method.

1. Single argument URIParameters, given the parameters.
2. No-args constructor.

Parameters:

context - the context the servlet will be run in

params - The parameters used to select the right instance.

Returns:

a WebPage object of the given class that matches the request settings

Throws:

IllegalArgumentException - if unable to create the instance

ServletException

See Also:

• isHandler(com.aoapps.net.URIParameters)

getWebPage

public static WebPage getWebPage(ServletContext context,
 Class<? extends WebPage> clazz)
                          throws ServletException

Gets an instance of WebPage given the Class. Instances returned should never have the init method called and should allocate a minimal set of resources.

Unless caching is disabled, the generated pages are stored in a cache and resolved using the pages isHander method.

1. Single argument URIParameters, given empty parameters.
2. No-args constructor.

Parameters:

context - the context the servlet will be run in

Returns:

a WebPage object of the given class that matches the request settings

Throws:

IllegalArgumentException - if unable to create the instance

ServletException

See Also:

• getWebPage(jakarta.servlet.ServletContext, java.lang.Class, com.aoapps.net.URIParameters)

loadClass

public static Class<? extends WebPage> loadClass(String className)
                                          throws ClassNotFoundException

Dynamically loads new classes based on the source .class file's modified time.

Throws:

ClassNotFoundException

getWebPageLayout

public WebPageLayout getWebPageLayout(WebSiteRequest req)
                               throws ServletException

Gets the current layout for this page. When req is null, should return SearchLayout or equivalent.

This default implementation returns SearchLayout.getInstance() for a search request (req is null), or inherits the layout of the parent.

Parameters:

req - the WebSiteRequest for this request, or null when searching

Returns:

the WebPageLayout

Throws:

ServletException

getChildren

protected WebPage[] getChildren(WebSiteRequest req,
 HttpServletResponse resp)
                         throws ServletException

Gets all of the children pages of this one in the page hierarchy. Defaults to none. The results of this call are never cached. For efficiency, please call getCachedWebPages. Subclasses will override and disable the caching provided by getCachedWebPages when appropriate.

Returns:

a WebPage[] of all of the lower-level pages

Throws:

ServletException

See Also:

• getCachedChildren(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse)
• emptyWebPageArray

isHandler

public boolean isHandler(WebSiteRequest req)

Determines if this page is the instance that should handle a particular request.

By default calls isHandler(com.aoapps.net.URIParameters), wrapping request in ServletRequestParameters. When no request, uses EmptyURIParameters.

See Also:

• getWebPage(jakarta.servlet.ServletContext, java.lang.Class, com.aoapps.web.framework.WebSiteRequest)

isHandler

public boolean isHandler(URIParameters params)

Determines if this page is the instance that represents a certain set of parameters.

By default returns true, meaning it is a handler for any parameters for this Class.

See Also:

• getWebPage(jakarta.servlet.ServletContext, java.lang.Class, com.aoapps.net.URIParameters)

getWebSiteRequest

protected abstract WebSiteRequest getWebSiteRequest(HttpServletRequest req)
                                             throws ServletException

Gets the WebSiteRequest that handles authentication and other details of this site.

Throws:

ServletException

search

public void search(String[] words,
 WebSiteRequest req,
 HttpServletResponse response,
 List<SearchResult> results,
 CharArrayWriter buffer,
 Set<WebPage> finishedPages)
            throws ServletException,
IOException

Searches this WebPage and all of its subordinate pages, returning the matches in a ArrayList with five elements per match.

1. A String for the absolute URL (including settings)
2. The probability as a Float
3. The title of the page
4. The description of the page
5. The author of the page

Defaults to standardSearch

Parameters:

words - all of the words that must match

req - the WebSiteRequest containing the users preferences

results - the ArrayList that contains the results

buffer - the SearchOutputStream to use for internal processing

Throws:

ServletException

IOException

See Also:

• standardSearch(java.lang.String[], com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, java.util.List<com.aoapps.web.framework.SearchResult>, java.io.CharArrayWriter, java.util.Set<com.aoapps.web.framework.WebPage>)

standardSearch

public final void standardSearch(String[] words,
 WebSiteRequest req,
 HttpServletResponse resp,
 List<SearchResult> results,
 CharArrayWriter buffer,
 Set<WebPage> finishedPages)
                          throws ServletException,
IOException

The standard implementation of the search functionality.

Throws:

ServletException

IOException

See Also:

• search(java.lang.String[], com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, java.util.List<com.aoapps.web.framework.SearchResult>, java.io.CharArrayWriter, java.util.Set<com.aoapps.web.framework.WebPage>)

includeNavImageAsParent

public boolean includeNavImageAsParent()

Determine if the nav image for this page should remain visible, even when its children are displayed. The default is false.

useNavImage

public boolean useNavImage()
                    throws ServletException

Determines whether or not to display the page in the left navigation.

Throws:

ServletException

useSiteMap

public boolean useSiteMap()

Determines if this page will be displayed in the standard site map.

showInLocationPath

public boolean showInLocationPath(WebSiteRequest req)

Determines if this page will be displayed in the location bar.

getCopyright

public String getCopyright(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage requestPage)
                    throws ServletException

Gets the copyright information for this page. Defaults to the copyright of the parent page. May not contain HTML.

TODO: 3.0.0: Use dcterms: http://stackoverflow.com/questions/6665312/is-the-copyright-meta-tag-valid-in-html5 https://wiki.whatwg.org/wiki/MetaExtensions http://dublincore.org/documents/dcmi-terms/

Throws:

ServletException

getUrlPath

public String getUrlPath()
                  throws ServletException

Gets the context-relative path for the URL.

Throws:

ServletException

generateUrlPath

public String generateUrlPath(WebPage page)
                       throws ServletException

Generates a URL path for this or another page, please call getUrlPath() instead. The default behavior is to ask the parent to generate the URL. Therefore the top-level WebPage of a site must implement this method.

Throws:

ServletException

getUrlPattern

public String getUrlPattern()
                     throws ServletException

Gets the URL pattern for this page as used in web.xml.

Throws:

ServletException