Package org.broadleafcommerce.common.sitemap.domain

Class SiteMapConfigurationImpl

java.lang.Object

org.broadleafcommerce.common.config.domain.AbstractModuleConfiguration

org.broadleafcommerce.common.sitemap.domain.SiteMapConfigurationImpl

All Implemented Interfaces:

Serializable, AbstractModuleConfigurationAdminPresentation, ModuleConfiguration, Status, SiteMapConfiguration

@Entity
public class SiteMapConfigurationImpl
extends AbstractModuleConfiguration
implements SiteMapConfiguration, AbstractModuleConfigurationAdminPresentation

Author:

Joshua Skorton (jskorton)

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.broadleafcommerce.common.config.domain.AbstractModuleConfigurationAdminPresentation

AbstractModuleConfigurationAdminPresentation.GroupName, AbstractModuleConfigurationAdminPresentation.GroupOrder, AbstractModuleConfigurationAdminPresentation.TabName, AbstractModuleConfigurationAdminPresentation.TabOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	indexedSiteMapFileName
protected String	indexedSiteMapFilePattern
protected Integer	maximumURLEntriesPerFile
protected String	siteMapFileName
protected List<SiteMapGeneratorConfiguration>	siteMapGeneratorConfigurations

Fields inherited from class org.broadleafcommerce.common.config.domain.AbstractModuleConfiguration

activeEndDate, activeStartDate, archiveStatus, auditable, configType, id, isDefault, moduleName, priority

Constructor Summary

Constructors

Constructor	Description
SiteMapConfigurationImpl()

Method Summary

Modifier and Type	Method	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 indexedSiteMapFilePattern)	Sets the name of the file to use when creating sitemaps and the system requires indexed files.
void	setMaximumUrlEntriesPerFile(Integer maximumSiteMapURLEntriesPerFile)	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 class org.broadleafcommerce.common.config.domain.AbstractModuleConfiguration

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

Methods inherited from class java.lang.Object

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

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

Field Details

maximumURLEntriesPerFile

protected Integer maximumURLEntriesPerFile

siteMapGeneratorConfigurations

protected List<SiteMapGeneratorConfiguration> siteMapGeneratorConfigurations

siteMapFileName

protected String siteMapFileName

indexedSiteMapFileName

protected String indexedSiteMapFileName

indexedSiteMapFilePattern

protected String indexedSiteMapFilePattern

Constructor Details

SiteMapConfigurationImpl

public SiteMapConfigurationImpl()

Method Details

getSiteMapGeneratorConfigurations

public List<SiteMapGeneratorConfiguration> getSiteMapGeneratorConfigurations()

Description copied from interface: SiteMapConfiguration

Returns the list of SiteMapGeneratorConfigurations used by this SiteMapConfiguration.

Specified by:

getSiteMapGeneratorConfigurations in interface SiteMapConfiguration

Returns:

setSiteMapGeneratorConfigurations

public void setSiteMapGeneratorConfigurations(List<SiteMapGeneratorConfiguration> siteMapGeneratorConfigurations)

Description copied from interface: SiteMapConfiguration

Sets the list of SiteMapGeneratorConfigurations.

Specified by:

setSiteMapGeneratorConfigurations in interface SiteMapConfiguration

getMaximumUrlEntriesPerFile

public Integer getMaximumUrlEntriesPerFile()

Description copied from interface: SiteMapConfiguration

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.

Specified by:

getMaximumUrlEntriesPerFile in interface SiteMapConfiguration

Returns:

setMaximumUrlEntriesPerFile

public void setMaximumUrlEntriesPerFile(Integer maximumSiteMapURLEntriesPerFile)

Description copied from interface: SiteMapConfiguration

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.

Specified by:

setMaximumUrlEntriesPerFile in interface SiteMapConfiguration

fixSiteUrlPath

public String fixSiteUrlPath(String siteUrlPath)

Description copied from interface: SiteMapConfiguration

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

Specified by:

fixSiteUrlPath in interface SiteMapConfiguration

Returns:

getSiteMapFileName

public String getSiteMapFileName()

Description copied from interface: SiteMapConfiguration

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.

Specified by:

getSiteMapFileName in interface SiteMapConfiguration

Returns:

setSiteMapFileName

public void setSiteMapFileName(String siteMapFileName)

Description copied from interface: SiteMapConfiguration

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

Specified by:

setSiteMapFileName in interface SiteMapConfiguration

See Also:

• SiteMapConfiguration.getSiteMapFileName()

getIndexedSiteMapFileName

public String getIndexedSiteMapFileName()

Description copied from interface: SiteMapConfiguration

The name to use for the primary site map file when it contains indexed files.

Delegates to SiteMapConfiguration.getSiteMapFileName() if not set. Be sure to update robots.txt if changing this value.

Specified by:

getIndexedSiteMapFileName in interface SiteMapConfiguration

Returns:

See Also:

• SiteMapConfiguration.getSiteMapFileName()

setIndexedSiteMapFileName

public void setIndexedSiteMapFileName(String fileName)

Description copied from interface: SiteMapConfiguration

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

Specified by:

setIndexedSiteMapFileName in interface SiteMapConfiguration

getSiteMapIndexFilePattern

public String getSiteMapIndexFilePattern()

Description copied from interface: SiteMapConfiguration

The name to use for the indexed sitemap files.

Defaults to the pattern of SiteMapConfiguration.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

Specified by:

getSiteMapIndexFilePattern in interface SiteMapConfiguration

Returns:

See Also:

• SiteMapConfiguration.getSiteMapFileName()

setIndexedSiteMapFilePattern

public void setIndexedSiteMapFilePattern(String indexedSiteMapFilePattern)

Description copied from interface: SiteMapConfiguration

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

Specified by:

setIndexedSiteMapFilePattern in interface SiteMapConfiguration