Package org.ametys.plugins.workspaces.project.generators

Class AbstractMailNotifierGenerator

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.workspaces.project.generators.AbstractMailNotifierGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

CalendarEventMailNotifierGenerator, CommentMailNotifierGenerator, MemberEventMailNotifierGenerator, MemberMailNotifierGenerator, MinisiteMailNotifierGenerator, NewsMailNotifierGenerator, ResourceMailNotifierGenerator, TaskMailNotifierGenerator, ThreadMailNotifierGenerator, WallContentMailNotifierGenerator

public abstract class AbstractMailNotifierGenerator
extends ServiceableGenerator

Abstract generator for mail notification

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkspaceModuleExtensionPoint	_moduleManagerEP	The workspace module managers EP
protected ProjectManager	_projectManager	The project manager
protected RenderingContextHandler	_renderingContextHandler	The rendering context handler
protected UserHelper	_userHelper	The user Helper
protected UserManager	_userManager	The user Manager
static final String	ROOT_ELEMENT	The name of the root element

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

Method Summary

Modifier and Type	Method	Description
protected abstract String	_getModuleId()	Get the URL of module to insert in email body
protected void	_saxProjectUserIdentity(UserIdentity issuerIdentity, Project project, String tagname)	Sax the user and project information relative to the user such as manager
void	generate()
protected String	getEventIdAsI18nKey(String eventId)	Transform the event Id in the I18n key format
protected Page	getModulePage(Project project)	Get the module's page
protected String	getProjectManagersNames(Project project)	Get the list of names of the project managers
protected String	getProjectUrl(Project project)	Get the absolute url of project
protected void	saxAdditionalData(Activity activity)	Use this method to provide additional information not stored directly in the activity
protected void	saxProject(Project project)	Sax the project basic informations
void	service(ServiceManager smanager)

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 Details

ROOT_ELEMENT

public static final String ROOT_ELEMENT

The name of the root element

See Also:

• Constant Field Values

_moduleManagerEP

protected WorkspaceModuleExtensionPoint _moduleManagerEP

The workspace module managers EP

_projectManager

protected ProjectManager _projectManager

The project manager

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The rendering context handler

_userHelper

protected UserHelper _userHelper

The user Helper

_userManager

protected UserManager _userManager

The user Manager

Constructor Details

AbstractMailNotifierGenerator

public AbstractMailNotifierGenerator()

Method Details

service

public void service(ServiceManager smanager)
             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

saxAdditionalData

protected void saxAdditionalData(Activity activity)
                          throws SAXException

Use this method to provide additional information not stored directly in the activity

Parameters:

activity - the activity

Throws:

SAXException - When a error occurred

_saxProjectUserIdentity

protected void _saxProjectUserIdentity(UserIdentity issuerIdentity,
 Project project,
 String tagname)
                                throws SAXException

Sax the user and project information relative to the user such as manager

Parameters:

issuerIdentity - the identity of the user

project - the project concerned

tagname - the name of the element

Throws:

SAXException - if an error occurred while saxing

saxProject

protected void saxProject(Project project)
                   throws SAXException

Sax the project basic informations

Parameters:

project - the project to SAX

Throws:

SAXException - if an error occurred while saxing

getProjectManagersNames

protected String getProjectManagersNames(Project project)

Get the list of names of the project managers

Parameters:

project - The project

Returns:

The list of names, as a single string, comma separated

_getModuleId

protected abstract String _getModuleId()

Get the URL of module to insert in email body

Returns:

The full URL

getModulePage

protected Page getModulePage(Project project)

Get the module's page

Parameters:

project - The project

Returns:

The page or null if not found

getProjectUrl

protected String getProjectUrl(Project project)

Get the absolute url of project

Parameters:

project - The project

Returns:

the project's url

getEventIdAsI18nKey

protected String getEventIdAsI18nKey(String eventId)

Transform the event Id in the I18n key format

Parameters:

eventId - the event Id

Returns:

the Id as an I18n key