org.alfresco.bm.event

Class RaiseEventsEventProcessor

java.lang.Object

org.alfresco.bm.event.AbstractEventProcessor

org.alfresco.bm.event.RaiseEventsEventProcessor

All Implemented Interfaces:

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

public class RaiseEventsEventProcessor
extends AbstractEventProcessor

Emits a given number of events at a given frequency for a given time.

Note that derivations of this class can be used to generate the desired data for each of the raised events.

Input

Any data

Actions

Emits events in batches before rescheduling itself.

Output

setEventNameRaiseEvents(String): Self-triggering event
outputEventName: Obtains data from getNextEventData()

Since:

1.4

Author:

Derek Hulley

Field Summary

Fields inherited from class org.alfresco.bm.event.AbstractEventProcessor

DEFAULT_CHART, DEFAULT_PROPAGATE_SESSION_ID, DEFAULT_WARN_DELAY, logger

Constructor Summary

Constructors

Constructor and Description
RaiseEventsEventProcessor(String outputEventName, long timeBetweenEvents, int outputEventCount) Constructor with essential values

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	getNextEventData() Get data to provide for each event raised.
EventResult	processEvent(Event event) Process an event.
void	setBatchSize(int batchSize) Override the default batch size
void	setEventNameRaiseEvents(String eventNameRaiseEvents) Override the default name for repeat batches

Methods inherited from class org.alfresco.bm.event.AbstractEventProcessor

getWarnDelay, isChart, processEvent, propagateSessionId, register, resumeTimer, setBeanName, setChart, setEventName, setEventNames, setPropagateSessionId, setRegistry, setWarnDelay, stopTimer, suspendTimer, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RaiseEventsEventProcessor

public RaiseEventsEventProcessor(String outputEventName,
                         long timeBetweenEvents,
                         int outputEventCount)

Constructor with essential values

Parameters:

outputEventName - the name of the event to emit

timeBetweenEvents - the time between events

outputEventCount - the number of events to emit

Method Detail

setBatchSize

public void setBatchSize(int batchSize)

Override the default batch size

setEventNameRaiseEvents

public void setEventNameRaiseEvents(String eventNameRaiseEvents)

Override the default name for repeat batches

processEvent

public EventResult processEvent(Event event)
                         throws Exception

Description copied from class: AbstractEventProcessor

Process an event.

NOTE: All errors are treated as terminal i.e. there will be no follow-up events published. The event and result services are provided to allow event processing to be aware of previous and future work. If the service is used to modify queues, the results could be unexpected e.g. clearing the queue will not always mean that no more events will be processed.

Timing: Where required, implementations can manually control the times recorded for event processing.

Specified by:

processEvent in class AbstractEventProcessor

Parameters:

event - the event (along with associated data)

Returns:

the result of the process (includes errors and next events)

Throws:

Exception

See Also:

AbstractEventProcessor.suspendTimer(), AbstractEventProcessor.resumeTimer(), AbstractEventProcessor.stopTimer()

getNextEventData

protected Object getNextEventData()

Get data to provide for each event raised.

This instance attaches no data but overriding classes can attach any other data as required.

Returns:

Return data to attach to the generated events