Package org.ametys.plugins.workspaces.documents.generators

Class DocumentStreamGenerator

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.documents.generators.DocumentStreamGenerator

All Implemented Interfaces:

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

public class DocumentStreamGenerator
extends ServiceableGenerator
implements Contextualizable

Document stream generator for the simple service.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	Avalon context
protected CurrentUserProvider	_currentUserProvider	Current user provider
protected DocumentWorkspaceModule	_documentModule	The document manager
protected ProjectsCatalogueManager	_projectCatalogManager	The project catalog helper
protected ProjectManager	_projectManager	The project manager
protected ProjectMemberManager	_projectMemberManager	The project member manager
protected RightManager	_rightManager	The right manager
protected SearcherFactory	_searcherFactory	The searcher factory
protected UserHelper	_userHelper	The user helper
protected UserManager	_userManager	The user manager

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

Method Summary

Modifier and Type	Method	Description
protected String	_getDocumentUrl(Project project, ResourceCollection folder)	Retrieves the URL of a folder in the document module of a project
protected void	_saxDocument(Resource resource)	SAX necessary document properties for the simple document stream service.
void	contextualize(Context context)
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 Details

_projectManager

protected ProjectManager _projectManager

The project manager

_projectMemberManager

protected ProjectMemberManager _projectMemberManager

The project member manager

_projectCatalogManager

protected ProjectsCatalogueManager _projectCatalogManager

The project catalog helper

_documentModule

protected DocumentWorkspaceModule _documentModule

The document manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

Current user provider

_searcherFactory

protected SearcherFactory _searcherFactory

The searcher factory

_userManager

protected UserManager _userManager

The user manager

_userHelper

protected UserHelper _userHelper

The user helper

_rightManager

protected RightManager _rightManager

The right manager

_context

protected Context _context

Avalon context

Constructor Details

DocumentStreamGenerator

public DocumentStreamGenerator()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

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

Specified by:

generate in interface Generator

Throws:

IOException

SAXException

ProcessingException

_saxDocument

protected void _saxDocument(Resource resource)

SAX necessary document properties for the simple document stream service.

Parameters:

resource - The resource

_getDocumentUrl

protected String _getDocumentUrl(Project project,
 ResourceCollection folder)

Retrieves the URL of a folder in the document module of a project

Parameters:

project - The project

folder - The folder

Returns:

The url or null if no module page is found for this project and the current language