Module com.aoapps.web.framework

Package com.aoapps.web.framework

Class RedirectWebPage

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.aoapps.web.resources.servlet.PageServlet

com.aoapps.web.framework.WebPage

com.aoapps.web.framework.RedirectWebPage

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

public class RedirectWebPage
extends WebPage

Redirects to the configured URL.

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.aoapps.web.framework.WebPage

emptyWebPageArray, reHTMLPattern, SEARCH_TWO

Constructor Summary

Constructors

Constructor	Description
RedirectWebPage(ServletContext context, WebPage parent, String path, int redirectType, String description, String keywords, String navImageAlt, String title)	Performs a redirect.

Method Summary

Modifier and Type	Method	Description
final void	doGet(WebSiteRequest req, HttpServletResponse resp, DocumentEE document)	Never do GET, redirect-only.
final <__ extends FlowContent<__>> void	doGet(WebSiteRequest req, HttpServletResponse resp, WebPageLayout layout, __ flow)	Never do GET, redirect-only.
final void	doPost(WebSiteRequest req, HttpServletResponse resp, DocumentEE document)	Never do POST, redirect-only.
final <__ extends FlowContent<__>> void	doPost(WebSiteRequest req, HttpServletResponse resp, WebPageLayout layout, __ flow)	Never do POST, redirect-only.
String	getDescription(WebSiteRequest req)	Gets the description of this page.
String	getKeywords(WebSiteRequest req)	Gets the keywords for this page.
String	getNavImageAlt(WebSiteRequest req)	Gets the text for the navigation image to use to represent this page.
WebPage	getParent()	Gets the parent of this page or null for none.
int	getRedirectType()	Gets the redirect type, defaults to 302 (temporary).
String	getRedirectUrl(WebSiteRequest req)	Gets the absolute or context-relative URL to direct to.
String	getTitle(WebSiteRequest req)	Gets the title of the web page in order to generate the HTML.
String	getUrlPath()	Gets the context-relative path for the URL.
protected WebSiteRequest	getWebSiteRequest(HttpServletRequest req)	Gets the WebSiteRequest that handles authentication and other details of this site.

Methods inherited from class com.aoapps.web.framework.WebPage

canAccess, configureResources, doGet, doGet, doPost, doPost, doPostWithSearch, equals, equals, generateUrlPath, getAuthor, getAuthorHref, getAutonli, getCachedChildren, getChildren, getClassLastModified, getContentValign, getCopyright, getDoctype, getDocument, getHtmlOutputStream, getIndent, getJavascriptSrc, getLastModified, getLastModified, getLastModifiedRecursive, getLastModifiedRecursive, getNavImageSuffix, getNavImageUrl, getNextPage, getOnloadScript, getPageIndexInParent, getPreferredContentWidth, getPreviousPage, getRootPage, getSearchLastModified, getSerialization, getServletContext, getShortTitle, getUptime, getUrlParams, getUrlPattern, getWebPage, getWebPage, getWebPage, getWebPage, getWebPage, getWebPage, getWebPageAndChildrenLastModified, getWebPageLayout, hashCode, includeNavImageAsParent, isHandler, isHandler, loadClass, printLoginForm, printUnauthorizedPage, search, service, setHeaders, showInLocationPath, standardSearch, useNavImage, useSiteMap

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

service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Constructor Details

RedirectWebPage

public RedirectWebPage(ServletContext context,
 WebPage parent,
 String path,
 int redirectType,
 String description,
 String keywords,
 String navImageAlt,
 String title)

Performs a redirect.

Parameters:

path - the context-relative path, with a preceding slash (/)

Method Details

getWebSiteRequest

protected WebSiteRequest getWebSiteRequest(HttpServletRequest req)
                                    throws ServletException

Description copied from class: WebPage

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

Specified by:

getWebSiteRequest in class WebPage

Throws:

ServletException

getParent

public WebPage getParent()

Description copied from class: WebPage

Gets the parent of this page or null for none.

Specified by:

getParent in class WebPage

doGet

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

Never do GET, redirect-only.

Overrides:

doGet in class WebPage

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:

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

doGet

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

Never do GET, redirect-only.

Overrides:

doGet in class WebPage

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:

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

doPost

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

Never do POST, redirect-only.

Overrides:

doPost in class WebPage

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:

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

doPost

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

Never do POST, redirect-only.

Overrides:

doPost in class WebPage

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:

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

getRedirectUrl

public String getRedirectUrl(WebSiteRequest req)
                      throws ServletException

Description copied from class: WebPage

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

Overrides:

getRedirectUrl in class WebPage

Returns:

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

Throws:

ServletException

getRedirectType

public int getRedirectType()

Description copied from class: WebPage

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

Overrides:

getRedirectType in class WebPage

getUrlPath

public String getUrlPath()

Description copied from class: WebPage

Gets the context-relative path for the URL.

Overrides:

getUrlPath in class WebPage

getDescription

public String getDescription(WebSiteRequest req)

Description copied from class: WebPage

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

Overrides:

getDescription in class WebPage

getKeywords

public String getKeywords(WebSiteRequest req)

Description copied from class: WebPage

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

Overrides:

getKeywords in class WebPage

getNavImageAlt

public String getNavImageAlt(WebSiteRequest req)

Description copied from class: WebPage

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

Overrides:

getNavImageAlt in class WebPage

Returns:

the alt text of the navigation image

See Also:

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

getTitle

public String getTitle(WebSiteRequest req)

Description copied from class: WebPage

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

Overrides:

getTitle in class WebPage

Returns:

the page title