org.apache.cocoon.generation
Class ServiceableGenerator

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.generation.AbstractGenerator
              org.apache.cocoon.generation.ServiceableGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCopletGenerator, BasketGenerator, CalendarGenerator, ConfigurationGenerator, ConfigurationGenerator, DirectoryGenerator, EventCacheGenerator, FileGenerator, FragmentExtractorGenerator, GenericProxyGenerator, HTMLGenerator, HttpProxyGenerator, I18nCatalogueGenerator, JSPGenerator, JXTemplateGenerator, JXTemplateGenerator, LinkStatusGenerator, NekoHTMLGenerator, PortalGenerator, PortalGenerator, ProfilerGenerator, RequestGenerator, ScriptGenerator, SearchGenerator, SlopGenerator, StatisticsGenerator, StatusGenerator, StreamGenerator, SuggestionListGenerator, TextGenerator, TraversableGenerator, VelocityGenerator, WebServiceProxyGenerator, XMLDBCollectionGenerator, XMLDBGenerator, XMLProfileGenerator

public abstract class ServiceableGenerator
extends AbstractGenerator
implements Serviceable, Disposable

A default implementation that can be used for writing own generators.

Since:

2.1.1

Version:

CVS $Id: ServiceableGenerator.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Carsten Ziegeler

Field Summary

protected ServiceManager

manager The service manager instance

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

ServiceableGenerator()

Method Summary

void	dispose() Release all resources.
void	service(ServiceManager manager) Set the current ServiceManager instance used by this Serviceable.

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 Detail

manager

protected ServiceManager manager

The service manager instance

Constructor Detail

ServiceableGenerator

public ServiceableGenerator()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Set the current ServiceManager instance used by this Serviceable.

Specified by:

service in interface Serviceable

Throws:

ServiceException

dispose

public void dispose()

Release all resources.

Specified by:

dispose in interface Disposable