org.alfresco.bm.driver.event.producer

Class AbstractEventProducer

java.lang.Object

org.alfresco.bm.driver.event.producer.AbstractEventProducer

All Implemented Interfaces:

EventProducer, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

Direct Known Subclasses:

RandomRedirectEventProducer, RedirectEventProducer, TerminateEventProducer

public abstract class AbstractEventProducer
extends Object
implements EventProducer, org.springframework.beans.factory.BeanNameAware

Basic services for the event producer implementations

Read 'good practice' notes for documenting behaviour.

Since:

2.0

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEFAULT_AUTO_CLOSE_SESSION_ID
protected static boolean	DEFAULT_AUTO_PROPAGATE_SESSION_ID
protected static boolean	DEFAULT_CHART
protected static long	DEFAULT_WARN_DELAY
protected org.apache.commons.logging.Log	logger Resource for derived classes to use for logging

Fields inherited from interface org.alfresco.bm.driver.event.producer.EventProducer

PRODUCER_NAME_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractEventProducer() Default constructor

Method Summary

Modifier and Type	Method and Description
void	register() Register this instance for the event names that are handled.
protected long	resumeTimer() Continue timing the event processing
void	setBeanName(String beanName)
void	setEventName(String eventName) Set the single event name that this producer can handle
void	setEventNames(List<String> eventNames) Set the names of the events that this producer can handle
void	setRegistry(EventProducerRegistry registry) Inject the registry that this instance will register with.
protected long	stopTimer() Stop timing the event processing.
protected long	suspendTimer() Suspend the event processing timer.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.alfresco.bm.driver.event.producer.EventProducer

getNextEvents

Field Detail

DEFAULT_WARN_DELAY

protected static final long DEFAULT_WARN_DELAY

See Also:

Constant Field Values

DEFAULT_CHART

protected static final boolean DEFAULT_CHART

DEFAULT_AUTO_PROPAGATE_SESSION_ID

protected static final boolean DEFAULT_AUTO_PROPAGATE_SESSION_ID

DEFAULT_AUTO_CLOSE_SESSION_ID

protected static final boolean DEFAULT_AUTO_CLOSE_SESSION_ID

logger

protected org.apache.commons.logging.Log logger

Resource for derived classes to use for logging

Constructor Detail

AbstractEventProducer

public AbstractEventProducer()

Default constructor

Method Detail

toString

public String toString()

Overrides:

toString in class Object

setBeanName

public void setBeanName(String beanName)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

setEventName

public void setEventName(String eventName)

Set the single event name that this producer can handle

setEventNames

public void setEventNames(List<String> eventNames)

Set the names of the events that this producer can handle

setRegistry

public void setRegistry(EventProducerRegistry registry)

Inject the registry that this instance will register with.

register

public void register()

Register this instance for the event names that are handled.

suspendTimer

protected long suspendTimer()

Suspend the event processing timer.

Throws:

IllegalStateException - if the timer is not running

resumeTimer

protected long resumeTimer()

Continue timing the event processing

Throws:

IllegalStateException - if the timer is is not suspended

stopTimer

protected long stopTimer()

Stop timing the event processing. This does not need to be called by derived classes.

Throws:

IllegalStateException - if the timer is is not running or suspended