org.ametys.web.inputdata

Class SitemapInputData

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.web.inputdata.SitemapInputData

All Implemented Interfaces:

InputData, Configurable, Contextualizable, LogEnabled, Serviceable

public class SitemapInputData
extends AbstractLogEnabled
implements InputData, Contextualizable, Configurable, Serviceable

InputData for SAXing events about the current sitemap.

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	_context Avalon context.
protected CurrentUserProvider	_currentUserProvider The current user provider
protected int	_descendantDepth Configured descendant depth.
protected int	_initialDepth Configured initial depth.
protected RenderingContextHandler	_renderingContextHandler The rendering context handler.
protected RightManager	_rightManager The right manager
protected SiteManager	_siteManager CMS Sites manager
static String	NAMESPACE_PREFIX Prefix for sitemap namespace.
static String	NAMESPACE_URI URI for sitemap namespace.
private static int	PATH_CURRENT
private static int	PATH_DESCENDANT
private static int	PATH_IN_PATH
private static int	PATH_NOT_IN_PATH

Constructor Summary

Constructors

Constructor and Description
SitemapInputData()

Method Summary

Modifier and Type	Method and Description
protected boolean	_processPage(Page page) Determine if the page will be processed. Default implementation returns true.
protected int	_saxCurrentStatus(String currentPagePath, String pagePath, AttributesImpl attrs) SAX current status.
protected void	_saxMetadatas(Page page, AttributesImpl attrs) SAX metadatas.
protected void	_saxPage(ContentHandler handler, String currentPagePath, int currentDepth, int descendantDepth, RestrictedPagePolicy policy, UserIdentity userIdentity, Page page) Sax a page
protected void	_saxPages(ContentHandler handler, PagesContainer composite, String currentPagePath, int currentDepth, int descendantDepth, RestrictedPagePolicy policy, UserIdentity userIdentity) SAX pages.
protected void	_saxTags(Page page, AttributesImpl attrs) SAX metadatas.
void	configure(Configuration configuration)
void	contextualize(Context context)
boolean	isCacheable(Site site, Page page) Returns true if this InputData is cacheable for the current site and if possible page.
void	service(ServiceManager manager)
void	toSAX(ContentHandler handler) Generates SAX events for providing data.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE_PREFIX

public static final String NAMESPACE_PREFIX

Prefix for sitemap namespace.

See Also:

Constant Field Values

NAMESPACE_URI

public static final String NAMESPACE_URI

URI for sitemap namespace.

See Also:

Constant Field Values

PATH_DESCENDANT

private static final int PATH_DESCENDANT

See Also:

Constant Field Values

PATH_NOT_IN_PATH

private static final int PATH_NOT_IN_PATH

See Also:

Constant Field Values

PATH_IN_PATH

private static final int PATH_IN_PATH

See Also:

Constant Field Values

PATH_CURRENT

private static final int PATH_CURRENT

See Also:

Constant Field Values

_context

protected Context _context

Avalon context.

_initialDepth

protected int _initialDepth

Configured initial depth.

_descendantDepth

protected int _descendantDepth

Configured descendant depth.

_siteManager

protected SiteManager _siteManager

CMS Sites manager

_rightManager

protected RightManager _rightManager

The right manager

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The rendering context handler.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Detail

SitemapInputData

public SitemapInputData()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

isCacheable

public boolean isCacheable(Site site,
                           Page page)

Description copied from interface: InputData

Returns true if this InputData is cacheable for the current site and if possible page.

Specified by:

isCacheable in interface InputData

Parameters:

site - the current Site.

page - the current Page. Can be null.

Returns:

true if this InputData is cacheable for the current site or page.

toSAX

public void toSAX(ContentHandler handler)
           throws SAXException,
                  ProcessingException

Description copied from interface: InputData

Generates SAX events for providing data.

Specified by:

toSAX in interface InputData

Parameters:

handler - the content handler to SAX into.

Throws:

SAXException - if an error occurs while SAXing.

ProcessingException - if an error occurs during processing.

_saxPages

protected void _saxPages(ContentHandler handler,
                         PagesContainer composite,
                         String currentPagePath,
                         int currentDepth,
                         int descendantDepth,
                         RestrictedPagePolicy policy,
                         UserIdentity userIdentity)
                  throws SAXException,
                         AmetysRepositoryException

SAX pages.

Parameters:

handler - the content handler to SAX into.

composite - the pages container.

currentPagePath - the path to the current page.

currentDepth - the current depth.

descendantDepth - the descendant depth.

policy - the site's RestrictedPagePolicy.

userIdentity - the current front-office's user.

Throws:

SAXException - if an error occurs while SAXing.

AmetysRepositoryException - if an error occurs.

_saxPage

protected void _saxPage(ContentHandler handler,
                        String currentPagePath,
                        int currentDepth,
                        int descendantDepth,
                        RestrictedPagePolicy policy,
                        UserIdentity userIdentity,
                        Page page)
                 throws SAXException

Sax a page

Parameters:

handler - the content handler to sax into

currentPagePath - The path of current page

currentDepth - The depth of current page

descendantDepth - The descendant depth

policy - the restricted page policy

userIdentity - the user identity

page - the page

Throws:

SAXException - if an error occurs while saxing

_processPage

protected boolean _processPage(Page page)
                        throws AmetysRepositoryException

Determine if the page will be processed.
Default implementation returns true.

Parameters:

page - the page.

Returns:

true if the page will be proceed, false otherwise.

Throws:

AmetysRepositoryException - if an error occurs.

_saxMetadatas

protected void _saxMetadatas(Page page,
                             AttributesImpl attrs)
                      throws AmetysRepositoryException

SAX metadatas.

Parameters:

page - the page.

attrs - the attributes to populate.

Throws:

AmetysRepositoryException - if an error occurs.

_saxTags

protected void _saxTags(Page page,
                        AttributesImpl attrs)
                 throws AmetysRepositoryException

SAX metadatas.

Parameters:

page - the page.

attrs - the attributes to populate.

Throws:

AmetysRepositoryException - if an error occurs.

_saxCurrentStatus

protected int _saxCurrentStatus(String currentPagePath,
                                String pagePath,
                                AttributesImpl attrs)

SAX current status.

Parameters:

currentPagePath - the path to the current page.

pagePath - the path to the page to process.

attrs - the attributes to populate.

Returns:

the current status.