Package org.ametys.core.util.cocoon

Class AbstractCurrentUserProviderServiceableGenerator

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ApplicationContextGenerator, UnlockGenerator, UserPreferencesGenerator, UserPreferencesValuesGenerator, WorkflowTasksGenerator

public abstract class AbstractCurrentUserProviderServiceableGenerator
extends ServiceableGenerator

ServiceableGenerator which provides the current user if necessary.

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider.

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
AbstractCurrentUserProviderServiceableGenerator()

Method Summary

Modifier and Type	Method	Description
protected UserIdentity	_getCurrentUser()	Provides the the current user.
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.generation.Generator

generate

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

setConsumer

Field Details

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

Constructor Details

AbstractCurrentUserProviderServiceableGenerator

public AbstractCurrentUserProviderServiceableGenerator()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

_getCurrentUser

protected UserIdentity _getCurrentUser()

Provides the the current user.

Returns:

the user which cannot be null.