org.broadleafcommerce.common.sitemap.domain

Interface SiteMapConfiguration

All Superinterfaces:

ModuleConfiguration, Serializable

All Known Implementing Classes:

SiteMapConfigurationImpl

public interface SiteMapConfiguration
extends ModuleConfiguration

The SiteMapConfiguration is a class that drives the building of the SiteMap. It contains general properties that drive the creation of the SiteMap such as directory paths, etc.

Author:

bpolster

Method Summary

Methods

Modifier and Type	Method and Description
String	fixSiteUrlPath(String siteUrlPath) Ensure that the site URL path does not end with a "/"
String	getIndexedSiteMapFileName() The name to use for the primary site map file when it contains indexed files.
Integer	getMaximumUrlEntriesPerFile() Returns the maximumUrlEntriesPerFile.
String	getSiteMapFileName() The name to use for the primary site map file when it does not contain indexed files.
List<SiteMapGeneratorConfiguration>	getSiteMapGeneratorConfigurations() Returns the list of SiteMapGeneratorConfigurations used by this SiteMapConfiguration.
String	getSiteMapIndexFilePattern() The name to use for the indexed sitemap files.
void	setIndexedSiteMapFileName(String fileName) Sets the name of the file to use when creating sitemaps and the system requires indexed files.
void	setIndexedSiteMapFilePattern(String filePattern) Sets the name of the file to use when creating sitemaps and the system requires indexed files.
void	setMaximumUrlEntriesPerFile(Integer maximumUrlEntriesPerFile) Sets the maximumUrl Entries per sitemap file.
void	setSiteMapFileName(String siteMapFileName) Sets the value to be returned for the name of the sitemap file.
void	setSiteMapGeneratorConfigurations(List<SiteMapGeneratorConfiguration> siteMapGeneratorConfigurations) Sets the list of SiteMapGeneratorConfigurations.

Methods inherited from interface org.broadleafcommerce.common.config.domain.ModuleConfiguration

getActiveEndDate, getActiveStartDate, getAuditable, getId, getIsDefault, getModuleConfigurationType, getModuleName, getPriority, isDefault, setActiveEndDate, setActiveStartDate, setAuditable, setId, setIsDefault, setModuleName, setPriority

Method Detail

getSiteMapGeneratorConfigurations

List<SiteMapGeneratorConfiguration> getSiteMapGeneratorConfigurations()

Returns the list of SiteMapGeneratorConfigurations used by this SiteMapConfiguration.

Returns:

setSiteMapGeneratorConfigurations

void setSiteMapGeneratorConfigurations(List<SiteMapGeneratorConfiguration> siteMapGeneratorConfigurations)

Sets the list of SiteMapGeneratorConfigurations.

Parameters:

siteMapGeneratorConfigurations -

getMaximumUrlEntriesPerFile

Integer getMaximumUrlEntriesPerFile()

Returns the maximumUrlEntriesPerFile. Defaults to 50000 per the sitemap.org schema requirement of a maximum of 50000 per file. Useful to override for testing purposes. Will allow values over 50000 but this would be considered invalid for the 0.9 version of the sitemap.org contract.

Returns:

setMaximumUrlEntriesPerFile

void setMaximumUrlEntriesPerFile(Integer maximumUrlEntriesPerFile)

Sets the maximumUrl Entries per sitemap file. The sitemap.org contract (version 0.9) says that this number should be a maximum of 50000 but it may be helpful for some implementations to override the default for testing purposes.

Parameters:

maximumUrlEntriesPerFile -

fixSiteUrlPath

String fixSiteUrlPath(String siteUrlPath)

Ensure that the site URL path does not end with a "/"

Parameters:

siteUrlPath -

Returns:

getSiteMapFileName

String getSiteMapFileName()

The name to use for the primary site map file when it does not contain indexed files. Note that changing the name of the siteMap file should be reflected in robots.txt (See BroadleafRobotsController) if using Broadleaf to produce the robots.txt file. Returns "sitemap.xml" if no value is set.

Returns:

setSiteMapFileName

void setSiteMapFileName(String siteMapFileName)

Sets the value to be returned for the name of the sitemap file.

See Also:

getSiteMapFileName()

getIndexedSiteMapFileName

String getIndexedSiteMapFileName()

The name to use for the primary site map file when it contains indexed files. Delegates to getSiteMapFileName() if not set. Be sure to update robots.txt if changing this value.

Returns:

See Also:

getSiteMapFileName()

setIndexedSiteMapFileName

void setIndexedSiteMapFileName(String fileName)

Sets the name of the file to use when creating sitemaps and the system requires indexed files.

getSiteMapIndexFilePattern

String getSiteMapIndexFilePattern()

The name to use for the indexed sitemap files. Defaults to the pattern of getSiteMapFileName()###. Where "###" is a token that will be replaced with the current index. For example, a file that required 2 indexed files would create the following two files: sitemap1.xml sitemap2.xml

Returns:

See Also:

getSiteMapFileName()

setIndexedSiteMapFilePattern

void setIndexedSiteMapFilePattern(String filePattern)

Sets the name of the file to use when creating sitemaps and the system requires indexed files.