org.broadleafcommerce.common.sitemap.service

Interface SiteMapService

All Known Implementing Classes:

SiteMapServiceImpl

public interface SiteMapService

Class responsible for generating the SiteMap.xml and related files. This service generates the structure of the SiteMap file. It assumes the use of SiteMap indexes and follows the convention siteMap#.xml

Author:

bpolster

Method Summary

Modifier and Type	Method and Description
SiteMapGenerationResponse	generateSiteMap() Generates a well formed SiteMap.
File	getSiteMapFile(String fileName) Returns the File object that can be used to retrieve the SiteMap.xml file

Method Detail

generateSiteMap

SiteMapGenerationResponse generateSiteMap()
                                   throws IOException,
                                          SiteMapException

Generates a well formed SiteMap. When getSiteMapFile(String) is called, if no file is found then it will invoke this method. Typically, an implementation will setup scheduled jobs to create the siteMap.xml. Implementation should implement a well formed SiteMap (for example, the default Broadleaf SiteMapImpl returns a SiteMap compatible with this schema. http://www.sitemaps.org/schemas/sitemap/0.9/siteindex.xsd Implementations should utilize the list of SiteMapGenerators that build the actual entries in the sitemap.xml files.

Throws:

SiteMapException

IOException

See Also:

SiteMapGenerator

getSiteMapFile

File getSiteMapFile(String fileName)
             throws SiteMapException,
                    IOException

Returns the File object that can be used to retrieve the SiteMap.xml file

Throws:

IOException

SiteMapException