org.apache.cocoon.portal.event.impl
Class DefaultEventConverter

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.portal.event.impl.DefaultEventConverter

All Implemented Interfaces:

Component, LogEnabled, Serviceable, ThreadSafe, EventConverter

public class DefaultEventConverter
extends AbstractLogEnabled
implements EventConverter, Serviceable, ThreadSafe

Version:

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

Author:

Carsten Ziegeler, Volker Schmitt

Field Summary

protected static String	DECODE_LIST
protected static String	ENCODE_LIST
protected ServiceManager	manager

Fields inherited from interface org.apache.cocoon.portal.event.EventConverter

ROLE

Constructor Summary

DefaultEventConverter()

Method Summary

Event	decode(String value) Decode an event This is used to "activate" events using a link
String	encode(Event event) Encode an event.
void	finish() This notifies the converter that an event processing phase ends
boolean	isMarshallEvents() Returns true if events are not to be returned as request parameters
void	service(ServiceManager manager)
void	start() This notifies the converter that a new event processing phase starts

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

Field Detail

DECODE_LIST

protected static final String DECODE_LIST

ENCODE_LIST

protected static final String ENCODE_LIST

manager

protected ServiceManager manager

Constructor Detail

DefaultEventConverter

public DefaultEventConverter()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

encode

public String encode(Event event)

Description copied from interface: EventConverter

Encode an event. This is used to "activate" events using a link

Specified by:

encode in interface EventConverter

Parameters:

event - The event to encode

Returns:

A unique string representation for this event

decode

public Event decode(String value)

Description copied from interface: EventConverter

Decode an event This is used to "activate" events using a link

Specified by:

decode in interface EventConverter

Parameters:

value - The string representation created using EventConverter.encode(Event)

Returns:

The event or null

start

public void start()

Description copied from interface: EventConverter

This notifies the converter that a new event processing phase starts

Specified by:

start in interface EventConverter

finish

public void finish()

Description copied from interface: EventConverter

This notifies the converter that an event processing phase ends

Specified by:

finish in interface EventConverter

isMarshallEvents

public boolean isMarshallEvents()

Description copied from interface: EventConverter

Returns true if events are not to be returned as request parameters

Specified by:

isMarshallEvents in interface EventConverter