org.alfresco.bm.driver.event

Class CreateSessionsEventProcessor

java.lang.Object

org.alfresco.bm.driver.event.AbstractEventProcessor

org.alfresco.bm.driver.event.CreateSessionsEventProcessor

All Implemented Interfaces:

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

public class CreateSessionsEventProcessor
extends AbstractEventProcessor

Ensures that a certain number of sessions are active when it takes samples and raises more events for session creation, if required.

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 to create new sessions before rescheduling itself.

Output

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

Since:

1.4

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_COMPLETED_SESSION_COUNT
static String	KEY_OUTPUT_EVENTS_RAISED

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

DEFAULT_AUTO_CLOSE_SESSION_ID, DEFAULT_AUTO_PROPAGATE_SESSION_ID, DEFAULT_CHART, DEFAULT_WARN_DELAY, logger

Constructor Summary

Constructors

Constructor and Description
CreateSessionsEventProcessor(SessionService sessionService, String outputEventName, int concurrentSessions, int totalSessions) Constructor with essential values

Method Summary

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	setCheckPeriod(long checkPeriod) Override the default time between session count checks
void	setEventNameCreateSessions(String eventNameCreateSessions) Override the default name for repeats
void	setTimeBetweenSessions(long timeBetweenSessions) Override the default time between sessions

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

getName, getWarnDelay, isAutoCloseSessionId, isAutoPropagateSessionId, isChart, processEvent, register, resumeTimer, setAutoCloseSessionId, setAutoPropagateSessionId, setBeanName, setChart, setEventName, setEventNames, setRegistry, setWarnDelay, stopTimer, suspendTimer, toString

Methods inherited from class java.lang.Object

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

Field Detail

KEY_OUTPUT_EVENTS_RAISED

public static final String KEY_OUTPUT_EVENTS_RAISED

See Also:

Constant Field Values

KEY_COMPLETED_SESSION_COUNT

public static final String KEY_COMPLETED_SESSION_COUNT

See Also:

Constant Field Values

Constructor Detail

CreateSessionsEventProcessor

public CreateSessionsEventProcessor(SessionService sessionService,
                                    String outputEventName,
                                    int concurrentSessions,
                                    int totalSessions)

Constructor with essential values

Parameters:

sessionService - session information

outputEventName - the name of the event to emit

concurrentSessions - the number of concurrent sessions to maintain

totalSessions - the maxiumum number of sessions to create

Method Detail

setEventNameCreateSessions

public void setEventNameCreateSessions(String eventNameCreateSessions)

Override the default name for repeats

setCheckPeriod

public void setCheckPeriod(long checkPeriod)

Override the default time between session count checks

setTimeBetweenSessions

public void setTimeBetweenSessions(long timeBetweenSessions)

Override the default time between sessions

processEvent

public EventResult processEvent(Event event)

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)

See Also:

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

getNextEventData

protected Object getNextEventData()

Get data to provide for each event raised. Implementations can override to add any data that is required for the each of the events being raised.

The default is to return null i.e. no data will be provided to each new event.

Use a DBObject for complicated data transfer

Returns:

Return data to attach to the generated events