Package org.opencms.site.xmlsitemap

Class CmsXmlSeoConfiguration

java.lang.Object

org.opencms.site.xmlsitemap.CmsXmlSeoConfiguration

public class CmsXmlSeoConfiguration
extends Object

Configuration bean which represents the options which are configurable from a 'seo-file' resource.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	m_excludes	The exclude paths.
protected List<String>	m_includes	The include paths.
protected String	m_mode	The mode.
protected String	m_robotsTxtText	Text to be included in robots.txt after the sitemap references.
static final Object	MODE_ROBOTS_TXT	Mode name constant.
static final Object	MODE_XML_SITEMAP	Mode name constant.
static final String	N_CACHE	Node name.
static final String	N_COMPUTE_CONTAINER_PAGE_DATES	Node name.
static final String	N_EXCLUDE	Node name.
static final String	N_GENERATOR_CLASS	Node name.
static final String	N_INCLUDE	Node name.
static final String	N_MODE	Node name.
static final String	N_ROBOTS_TXT_TEXT	Node name.
static final String	N_SERVER_URL	Node name.
static final String	SEO_FILE_TYPE	The file type used for generating XML sitemaps or robots.txt files.

Constructor Summary

Constructors

Constructor	Description
CmsXmlSeoConfiguration()

Method Summary

Modifier and Type	Method	Description
List<String>	getExcludes()	Gets the list of exclude paths.
List<String>	getIncludes()	Gets the list of include paths.
String	getMode()	Gets the mode.
String	getRobotsTxtText()	Gets the text which should be inserted in robots.txt mode.
String	getServerUrl()	Gets the configured server URL.
String	getSitemapGeneratorClassName()	Gets the class name for the sitemap generator class (may return null if none is explicitly configured).
boolean	isXmlSitemapMode()	Returns true if this configuration is configured as robots.txt mode.
void	load(CmsObject cms, CmsResource resource)	Loads the bean data from the given resource.
boolean	shouldComputeContainerPageModificationDates()	Returns true if container page modification dates should be computed.
boolean	usesCache()	True if caching should be used for the generated XML sitemap.

Methods inherited from class java.lang.Object

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

Field Details

MODE_ROBOTS_TXT

public static final Object MODE_ROBOTS_TXT

Mode name constant.

MODE_XML_SITEMAP

public static final Object MODE_XML_SITEMAP

Mode name constant.

N_COMPUTE_CONTAINER_PAGE_DATES

public static final String N_COMPUTE_CONTAINER_PAGE_DATES

Node name.

See Also:

• Constant Field Values

N_EXCLUDE

public static final String N_EXCLUDE

Node name.

See Also:

• Constant Field Values

N_CACHE

public static final String N_CACHE

Node name.

See Also:

• Constant Field Values

N_SERVER_URL

public static final String N_SERVER_URL

Node name.

See Also:

• Constant Field Values

N_GENERATOR_CLASS

public static final String N_GENERATOR_CLASS

Node name.

See Also:

• Constant Field Values

N_INCLUDE

public static final String N_INCLUDE

Node name.

See Also:

• Constant Field Values

N_MODE

public static final String N_MODE

Node name.

See Also:

• Constant Field Values

N_ROBOTS_TXT_TEXT

public static final String N_ROBOTS_TXT_TEXT

Node name.

See Also:

• Constant Field Values

SEO_FILE_TYPE

public static final String SEO_FILE_TYPE

The file type used for generating XML sitemaps or robots.txt files.

See Also:

• Constant Field Values

m_excludes

protected List<String> m_excludes

The exclude paths.

m_includes

protected List<String> m_includes

The include paths.

m_mode

protected String m_mode

The mode.

m_robotsTxtText

protected String m_robotsTxtText

Text to be included in robots.txt after the sitemap references.

Constructor Details

CmsXmlSeoConfiguration

public CmsXmlSeoConfiguration()

Method Details

getExcludes

public List<String> getExcludes()

Gets the list of exclude paths.

Returns:

the list of exclude paths

getIncludes

public List<String> getIncludes()

Gets the list of include paths.

Returns:

the list of include paths

getMode

public String getMode()

Gets the mode.

Returns:

the mode

getRobotsTxtText

public String getRobotsTxtText()

Gets the text which should be inserted in robots.txt mode.

Returns:

the text to insert in robots.txt mode

getServerUrl

public String getServerUrl()

Gets the configured server URL.

This, if set, replaces the host/port used by getOnlineLink() for the URLs in the XML sitemap.

Returns:

the server URL

getSitemapGeneratorClassName

public String getSitemapGeneratorClassName()

Gets the class name for the sitemap generator class (may return null if none is explicitly configured).

Returns:

the sitemap generator class name

isXmlSitemapMode

public boolean isXmlSitemapMode()

Returns true if this configuration is configured as robots.txt mode.

Returns:

true if the mode is set to the robots.txt mode

load

public void load(CmsObject cms,
 CmsResource resource)
          throws CmsException

Loads the bean data from the given resource.

Parameters:

cms - the CMS context to use

resource - the resource from which to load the data

Throws:

CmsException - if something goes wrong

shouldComputeContainerPageModificationDates

public boolean shouldComputeContainerPageModificationDates()

Returns true if container page modification dates should be computed.

Returns:

true if container page modification dates should be computed

usesCache

public boolean usesCache()

True if caching should be used for the generated XML sitemap.

Returns:

true if caching should be used for the generated XML sitemap