org.ametys.plugins.linkdirectory.link

Class LinksGenerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.generation.AbstractGenerator

org.apache.cocoon.generation.ServiceableGenerator

org.ametys.plugins.linkdirectory.link.LinksGenerator

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, LogEnabled, Serviceable, Generator, SitemapModelComponent, XMLProducer

public class LinksGenerator
extends ServiceableGenerator

Generate the links' list of a link directory as XML.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__DISPLAY_USER_LINKS_PARAMETER
private CurrentUserProvider	_currentUserProvider The current user provider
private DirectoryHelper	_directoryHelper

Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

Constructors

Constructor and Description
LinksGenerator()

Method Summary

Modifier and Type	Method and Description
protected void	_saxDeletedThemes(String siteName, String language, List<String> themesIdsList) Sax the amount of deleted themes
protected void	_saxUserLinks(Request request, AttributesImpl attrs, String siteName, String language, UserIdentity currentUser, String storageContext) SAX the links of current user
void	generate()
void	service(ServiceManager serviceManager)

Methods inherited from class org.apache.cocoon.generation.ServiceableGenerator

dispose

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle, setup

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

__DISPLAY_USER_LINKS_PARAMETER

private static final String __DISPLAY_USER_LINKS_PARAMETER

See Also:

Constant Field Values

_currentUserProvider

private CurrentUserProvider _currentUserProvider

The current user provider

_directoryHelper

private DirectoryHelper _directoryHelper

Constructor Detail

LinksGenerator

public LinksGenerator()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

generate

public void generate()
              throws IOException,
                     SAXException,
                     ProcessingException

Throws:

IOException

SAXException

ProcessingException

_saxDeletedThemes

protected void _saxDeletedThemes(String siteName,
                                 String language,
                                 List<String> themesIdsList)
                          throws SAXException

Sax the amount of deleted themes

Parameters:

siteName - the site's name

language - the language

themesIdsList - the list of theme ids

Throws:

SAXException - if an exception occurs while saxing

_saxUserLinks

protected void _saxUserLinks(Request request,
                             AttributesImpl attrs,
                             String siteName,
                             String language,
                             UserIdentity currentUser,
                             String storageContext)
                      throws SAXException,
                             UserPreferencesException

SAX the links of current user

Parameters:

request - The request

attrs - The attributes for user-links tag

siteName - The site name

language - The language

currentUser - The current user identity

storageContext - The storage context

Throws:

SAXException - if an exception occurs while saxing

UserPreferencesException - if an exception occurs while getting the user preferences