oracle.webcenter.spaces.sitemap

Interface SitemapManager

public interface SitemapManager

SitemapManager is responsible for handling all sitemap related operations. The sitemap can be created/deleted/modified using the APIs provided by this interface.

The following code snippet depicts how one can get hold of SitemapManager:
SitemapManagerFactory factory = FactoryFinder.getFactory(SitemapManagerFactory.class.getCanonicalName());
SitemapManager manager = factory.getSitemapManager();


Method Summary

Modifier and Type	Method and Description
void	deleteSitemap(java.lang.String spaceName) Deletes the sitemap information for the space in the sitemap index.
void	generateSitemap() Generates the Sitemap for public spaces.
oracle.webcenter.spaces.sitemap.beans.space.SpaceSitemap	generateSitemap(java.lang.String spaceName) Generates the Sitemap for the specified space.
oracle.webcenter.spaces.sitemap.beans.Sitemap	getSitemap() Returns the sitemap index.
oracle.webcenter.spaces.sitemap.beans.space.SpaceSitemap	getSitemap(java.lang.String spaceName) Returns the sitemap for a space.
org.w3c.dom.Document	getSitemapDocument() Returns the sitemap index document.
org.w3c.dom.Document	getSitemapDocument(java.lang.String spaceName) Returns the sitemap document for a space.
void	updateSitemap(java.lang.String spaceName) Updates the sitemap information for the space in the sitemap index.

Method Detail

getSitemap

oracle.webcenter.spaces.sitemap.beans.Sitemap getSitemap()
                                                  throws SitemapException

Returns the sitemap index. Essentially it returns the content of /oracle/webcenter/space/metadata/spaces/sitemap.xml

Returns:

Sitemap that holds Sitemap Index File content.

Throws:

SitemapException

getSitemapDocument

org.w3c.dom.Document getSitemapDocument()
                                 throws SitemapException

Returns the sitemap index document. Essentially it returns the content of /oracle/webcenter/space/metadata/spaces/sitemap.xml as a DOM document

Returns:

Document that holds Sitemap Index File content.

Throws:

SitemapException

getSitemap

oracle.webcenter.spaces.sitemap.beans.space.SpaceSitemap getSitemap(java.lang.String spaceName)
                                                             throws SitemapException

Returns the sitemap for a space. Essentially it returns the content of /oracle/webcenter/space/metadata/spaces//space-sitemap.xml

Parameters:

spaceName - the name of the space

Returns:

SpaceSitemap that holds Sitemap content of the space.

Throws:

SitemapException

getSitemapDocument

org.w3c.dom.Document getSitemapDocument(java.lang.String spaceName)
                                 throws SitemapException

Returns the sitemap document for a space. Essentially it returns the content of /oracle/webcenter/space/metadata/spaces//space-sitemap.xml as a DOM document

Parameters:

spaceName - the name of the space

Returns:

Document that holds Sitemap content of the space.

Throws:

SitemapException

updateSitemap

void updateSitemap(java.lang.String spaceName)
            throws SitemapException

Updates the sitemap information for the space in the sitemap index.

Parameters:

spaceName - the name of the space

Throws:

SitemapException

deleteSitemap

void deleteSitemap(java.lang.String spaceName)
            throws SitemapException

Deletes the sitemap information for the space in the sitemap index.

Parameters:

spaceName - the name of the space

Throws:

SitemapException

generateSitemap

void generateSitemap()
              throws SitemapException

Generates the Sitemap for public spaces. First it generates the sitemap for all public spaces and then generates the sitemap index that contains the entry for all generated space sitemaps.

Throws:

SitemapException

generateSitemap

oracle.webcenter.spaces.sitemap.beans.space.SpaceSitemap generateSitemap(java.lang.String spaceName)
                                                                  throws SitemapException

Generates the Sitemap for the specified space. If the space is not public, not sitemap will be generated.

Parameters:

spaceName - the name of the space

Throws:

SitemapException