Package org.ametys.web.userpref

Class FOUserPreferencesGenerator

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.core.util.cocoon.AbstractCurrentUserProviderServiceableGenerator

org.ametys.plugins.core.userpref.UserPreferencesGenerator

org.ametys.web.userpref.FOUserPreferencesGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

PreferenceServiceGenerator

public class FOUserPreferencesGenerator
extends UserPreferencesGenerator

Generates front-office user preferences and the current page.

Field Summary

Fields inherited from class org.ametys.plugins.core.userpref.UserPreferencesGenerator

_userPrefEP, _userPrefManager

Fields inherited from class org.ametys.core.util.cocoon.AbstractCurrentUserProviderServiceableGenerator

_currentUserProvider

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	Description
FOUserPreferencesGenerator()

Method Summary

Modifier and Type	Method	Description
protected void	_saxPreferences(String storageContext, Map<String,String> contextVars, UserIdentity user, boolean excludePrivate)	Generate the list of user preferences for a given user and context.
protected void	_saxUserInput(Map<String,String> contextVars)	Generate the user input.
protected Map<String,String>	getContextVars(Request request)	Get the preferences context.
protected UserIdentity	getUser()	Get the user in the user manager.
void	service(ServiceManager serviceManager)

Methods inherited from class org.ametys.plugins.core.userpref.UserPreferencesGenerator

_saxPreference, generate

Methods inherited from class org.ametys.core.util.cocoon.AbstractCurrentUserProviderServiceableGenerator

_getCurrentUser

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

Constructor Detail

FOUserPreferencesGenerator

public FOUserPreferencesGenerator()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class UserPreferencesGenerator

Throws:

ServiceException

getUser

protected UserIdentity getUser()

Description copied from class: UserPreferencesGenerator

Get the user in the user manager.

Overrides:

getUser in class UserPreferencesGenerator

Returns:

the user .

getContextVars

protected Map<String,String> getContextVars(Request request)

Description copied from class: UserPreferencesGenerator

Get the preferences context.

Overrides:

getContextVars in class UserPreferencesGenerator

Parameters:

request - the request.

Returns:

the preferences context as a Map.

_saxPreferences

protected void _saxPreferences(String storageContext,
                               Map<String,String> contextVars,
                               UserIdentity user,
                               boolean excludePrivate)
                        throws ProcessingException,
                               SAXException,
                               UserPreferencesException

Description copied from class: UserPreferencesGenerator

Generate the list of user preferences for a given user and context.

Overrides:

_saxPreferences in class UserPreferencesGenerator

Parameters:

storageContext - the preferences context.

contextVars - The context vars

user - the user.

excludePrivate - true to exclude private user preferences

Throws:

ProcessingException - if an error occurred

SAXException - if an error occurred

UserPreferencesException - if an error occurred

_saxUserInput

protected void _saxUserInput(Map<String,String> contextVars)
                      throws ProcessingException,
                             SAXException

Generate the user input.

Parameters:

contextVars - The context variables including environment elements

Throws:

SAXException - if an error occurs while saxing

ProcessingException - if failed to get user preferences