com.aoindustries.website.framework
Class DumpURLs

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          com.aoindustries.website.framework.ErrorReportingServlet
              com.aoindustries.website.framework.WebPage
                  com.aoindustries.website.framework.DumpURLs

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.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.aoindustries.website.framework.WebPage

emptyWebPageArray, reHTMLPattern

Fields inherited from class com.aoindustries.website.framework.ErrorReportingServlet

BUFFER_SIZE

Constructor Summary

DumpURLs(LoggerAccessor loggerAccessor)

DumpURLs(LoggerAccessor loggerAccessor, java.lang.Object param)

DumpURLs(WebSiteRequest req)

Method Summary

void	doGet(com.aoindustries.io.ChainWriter out, WebSiteRequest req, javax.servlet.http.HttpServletResponse resp) By default, GET provides no content.
java.lang.String	getDescription() Gets the description of this page.
java.lang.String	getKeywords() Gets the keywords for this page.
long	getLastModified(WebSiteRequest req) The last modified time is -1 to always reload the list.
long	getSearchLastModified() Gets the last modified time for search indexing.
java.lang.String	getTitle() Gets the title of the web page in order to generate the HTML.
void	search(java.lang.String[] words, WebSiteRequest req, java.util.ArrayList results, com.aoindustries.io.BetterByteArrayOutputStream bytes, com.aoindustries.util.SortedArrayList finishedPages) Do not include this in the search results.

Methods inherited from class com.aoindustries.website.framework.WebPage

canAccess, doGet, doPost, doPost, doPostWithSearch, enforceEncryption, equals, equals, generateURLPath, getAdditionalHeaders, getAuthor, getCachedPages, getClassLastModified, getClassLoaderUptime, getContentVAlign, getCopyright, getHTMLChainWriter, getHTMLOutputStream, getJavaScriptSrc, getLastModifiedRecursive, getLastModifiedRecursive, getNavImageAlt, getNavImageSuffix, getNavImageURL, getNextPage, getOnloadScript, getPageIndexInParent, getParent, getPreferredContentWidth, getPreviousPage, getRedirectURL, getRootPage, getServletContext, getShortTitle, getURLParams, getURLPath, getURLPattern, getWebPage, getWebPage, getWebPage, getWebPage, getWebPageAndChildrenLastModified, getWebPageLayout, getWebPages, getWebSiteRequest, hashCode, includeNavImageAsParent, isHandler, isHandler, loadClass, printLoginForm, printUnauthorizedPage, reportingDoGet, reportingDoPost, reportingGetLastModified, search, showInLocationPath, standardSearch, useEncryption, useNavImage, useSiteMap

Methods inherited from class com.aoindustries.website.framework.ErrorReportingServlet

doGet, doPost, getGetCount, getLastModified, getLastModifiedCount, getLogger, getLogger, getLogger, getLoggerAccessor, getPostCount, getUptime, log, log

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, service, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DumpURLs

public DumpURLs(LoggerAccessor loggerAccessor)

DumpURLs

public DumpURLs(WebSiteRequest req)

DumpURLs

public DumpURLs(LoggerAccessor loggerAccessor,
                java.lang.Object param)

Method Detail

doGet

public void doGet(com.aoindustries.io.ChainWriter out,
                  WebSiteRequest req,
                  javax.servlet.http.HttpServletResponse resp)
           throws java.io.IOException,
                  java.sql.SQLException

Description copied from class: WebPage

By default, GET provides no content.

Overrides:

doGet in class WebPage

Parameters:

out - the ChainWriter to send output to

req - the current WebSiteRequest

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

Throws:

java.io.IOException

java.sql.SQLException

getDescription

public java.lang.String getDescription()

Description copied from class: WebPage

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

Overrides:

getDescription in class WebPage

getKeywords

public java.lang.String getKeywords()

Description copied from class: WebPage

Gets the keywords for this page. By default, the keywords of the parent page are used.

Overrides:

getKeywords in class WebPage

getLastModified

public long getLastModified(WebSiteRequest req)
                     throws java.io.IOException,
                            java.sql.SQLException

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

Overrides:

getLastModified in class WebPage

Throws:

java.io.IOException

java.sql.SQLException

search

public void search(java.lang.String[] words,
                   WebSiteRequest req,
                   java.util.ArrayList results,
                   com.aoindustries.io.BetterByteArrayOutputStream bytes,
                   com.aoindustries.util.SortedArrayList finishedPages)

Do not include this in the search results.

getSearchLastModified

public long getSearchLastModified()
                           throws java.io.IOException,
                                  java.sql.SQLException

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 a null WebSiteRequest.

Overrides:

getSearchLastModified in class WebPage

Throws:

java.io.IOException

java.sql.SQLException

getTitle

public java.lang.String getTitle()

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