This project has retired. For details please refer to its Attic page.

org.apache.cocoon.generation
Class StatusGenerator

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.apache.cocoon.generation.StatusGenerator

All Implemented Interfaces:

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

public class StatusGenerator
extends ServiceableGenerator
implements Contextualizable, Configurable

Version:

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

Author:

Paul Russell (Luminas Limited), Stefano Mazzocchi, Sébastien Kœchlin (iVision), Gerhard Froehlich

Field Summary

protected Context	context The component context.
static String	NAMESPACE The XML namespace for the output document.
protected StoreJanitor	storeJanitor The StoreJanitor used to get cache statistics
protected Store	storePersistent The persistent store
protected static String	XLINK_NS The XML namespace for xlink
protected static String	XLINK_PREFIX The namespace prefix for xlink namespace

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

StatusGenerator()

Method Summary

void	configure(Configuration configuration)
void	contextualize(Context context)
void	dispose() Release all resources.
void	generate() Generate the status information in XML format.
void	service(ServiceManager manager) Set the current ServiceManager instance used by this Serviceable.
void	setup(SourceResolver resolver, Map objectModel, String src, Parameters par) Set the SourceResolver, object model Map, the source and sitemap Parameters used to process the request.

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle

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 Detail

NAMESPACE

public static final String NAMESPACE

The XML namespace for the output document.

See Also:

Constant Field Values

XLINK_NS

protected static final String XLINK_NS

The XML namespace for xlink

See Also:

Constant Field Values

XLINK_PREFIX

protected static final String XLINK_PREFIX

The namespace prefix for xlink namespace

See Also:

Constant Field Values

context

protected Context context

The component context.

storeJanitor

protected StoreJanitor storeJanitor

The StoreJanitor used to get cache statistics

storePersistent

protected Store storePersistent

The persistent store

Constructor Detail

StatusGenerator

public StatusGenerator()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

service

public void service(ServiceManager manager)
             throws ServiceException

Set the current ServiceManager instance used by this Serviceable. Need to get statistics about cache hits

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

setup

public void setup(SourceResolver resolver,
                  Map objectModel,
                  String src,
                  Parameters par)
           throws ProcessingException,
                  SAXException,
                  IOException

Description copied from class: AbstractGenerator

Set the SourceResolver, object model Map, the source and sitemap Parameters used to process the request.

Specified by:

setup in interface SitemapModelComponent

Overrides:

setup in class AbstractGenerator

Throws:

ProcessingException

SAXException

IOException

dispose

public void dispose()

Description copied from class: ServiceableGenerator

Release all resources.

Specified by:

dispose in interface Disposable

Overrides:

dispose in class ServiceableGenerator

See Also:

Disposable.dispose()

generate

public void generate()
              throws SAXException,
                     ProcessingException

Generate the status information in XML format.

Specified by:

generate in interface Generator

Throws:

SAXException - when there is a problem creating the output SAX events.

ProcessingException