Module com.aoapps.web.framework

Package com.aoapps.web.framework

Class DumpURLs

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.DumpURLs

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

public abstract class DumpURLs
extends WebPage

Generates a list of all URLs in the site. This is useful for adding this site to search engines.

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
DumpURLs()

Method Summary

Modifier and Type	Method	Description
<__ extends FlowContent<__>> void	doGet(WebSiteRequest req, HttpServletResponse resp, WebPageLayout layout, __ flow)	By default, GET provides no content.
String	getDescription(WebSiteRequest req)	Gets the description of this page.
String	getKeywords(WebSiteRequest req)	Gets the keywords for this page.
long	getLastModified(WebSiteRequest req, HttpServletResponse resp)	The last modified time is -1 to always reload the list.
long	getSearchLastModified()	Gets the last modified time for search indexing.
String	getTitle(WebSiteRequest req)	Gets the title of the web page in order to generate the HTML.
void	search(String[] words, WebSiteRequest req, HttpServletResponse response, List<SearchResult> results, CharArrayWriter buffer, Set<WebPage> finishedPages)	Do not include this in the search results.

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

canAccess, configureResources, doGet, doGet, doGet, doPost, doPost, doPost, doPost, doPostWithSearch, equals, equals, generateUrlPath, getAuthor, getAuthorHref, getAutonli, getCachedChildren, getChildren, getClassLastModified, getContentValign, getCopyright, getDoctype, getDocument, getHtmlOutputStream, getIndent, getJavascriptSrc, getLastModified, getLastModifiedRecursive, getLastModifiedRecursive, getNavImageAlt, getNavImageSuffix, getNavImageUrl, getNextPage, getOnloadScript, getPageIndexInParent, getParent, getPreferredContentWidth, getPreviousPage, getRedirectType, getRedirectUrl, getRootPage, getSerialization, getServletContext, getShortTitle, getUptime, getUrlParams, getUrlPath, getUrlPattern, getWebPage, getWebPage, getWebPage, getWebPage, getWebPage, getWebPage, getWebPageAndChildrenLastModified, getWebPageLayout, getWebSiteRequest, hashCode, includeNavImageAsParent, isHandler, isHandler, loadClass, printLoginForm, printUnauthorizedPage, 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

DumpURLs

public DumpURLs()

Method Details

doGet

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

Description copied from class: WebPage

By default, GET provides no content.

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)

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

getLastModified

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

The last modified time is -1 to always reload the list.

Overrides:

getLastModified in class WebPage

Throws:

ServletException

search

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

Do not include this in the search results.

Overrides:

search in class WebPage

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

See Also:

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

getSearchLastModified

public long getSearchLastModified()
                           throws ServletException

Description copied from class: WebPage

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.

Overrides:

getSearchLastModified in class WebPage

Throws:

ServletException

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