org.opencms.site.xmlsitemap

类 CmsXmlSitemapActionElement

java.lang.Object

org.opencms.jsp.CmsJspBean

org.opencms.jsp.CmsJspActionElement

org.opencms.site.xmlsitemap.CmsXmlSitemapActionElement

public class CmsXmlSitemapActionElement
extends CmsJspActionElement

Action element class for displaying the XML sitemap from a JSP.

字段概要

字段

限定符和类型	字段和说明
protected CmsXmlSeoConfiguration	m_configuration The configuration bean.

从类继承的字段 org.opencms.jsp.CmsJspActionElement

NOT_INITIALIZED

构造器概要

构造器

构造器和说明
CmsXmlSitemapActionElement(javax.servlet.jsp.PageContext pageContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Constructor, with parameters.

方法概要

方法

限定符和类型	方法和说明
CmsXmlSitemapGenerator	createSitemapGenerator(java.lang.String className, java.lang.String folderRootPath) Creates an XML sitemap generator instance given a class name and the root path for the sitemap.
void	renderXmlSitemap() Writes the XML sitemap to the response.
void	run() Displays either the generated sitemap.xml or the generated robots.txt, depending on the configuration.

从类继承的方法 org.opencms.jsp.CmsJspActionElement

editable, editable, editable, editableManualClose, editableManualOpen, getContent, getContent, getMessages, getMessages, getMessages, getMessages, getNavigation, getNavigationUri, img, img, include, include, include, include, include, include, includeSilent, includeSilent, includeSilent, includeSilent, info, label, link, link, properties, properties, property, property, property, property, template, template, template, toAbsolute, user

从类继承的方法 org.opencms.jsp.CmsJspBean

getCmsObject, getController, getJspContext, getMessage, getRequest, getRequestContext, getResponse, handleException, init, isNotInitialized, isSupressingExceptions, setContentType, setStatus, setSupressingExceptions

从类继承的方法 java.lang.Object

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

字段详细资料

m_configuration

protected CmsXmlSeoConfiguration m_configuration

The configuration bean.

构造器详细资料

CmsXmlSitemapActionElement

public CmsXmlSitemapActionElement(javax.servlet.jsp.PageContext pageContext,
                          javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)

Constructor, with parameters.

参数:

pageContext - the JSP page context object

request - the JSP request

response - the JSP response

方法详细资料

createSitemapGenerator

public CmsXmlSitemapGenerator createSitemapGenerator(java.lang.String className,
                                            java.lang.String folderRootPath)
                                              throws CmsException

Creates an XML sitemap generator instance given a class name and the root path for the sitemap.

参数:

className - the class name of the sitemap generator (may be null for the default

folderRootPath - the root path of the start folder for the sitemap

返回:

the sitemap generator instance

抛出:

CmsException - if something goes wrong

renderXmlSitemap

public void renderXmlSitemap()
                      throws java.lang.Exception

Writes the XML sitemap to the response.

抛出:

java.lang.Exception - if something goes wrong

run

public void run()
         throws java.lang.Exception

Displays either the generated sitemap.xml or the generated robots.txt, depending on the configuration.

抛出:

java.lang.Exception - if something goes wrong