org.alfresco.bm.event.user

Class CheckUserCountEventProcessor

java.lang.Object

org.alfresco.bm.event.AbstractEventProcessor

org.alfresco.bm.event.user.CheckUserCountEventProcessor

All Implemented Interfaces:

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

public class CheckUserCountEventProcessor
extends AbstractEventProcessor

An event processor that ensures the presence of a minimum number of users.

Input

No input requirements

Actions

The UserDataService is examined to check that the prescribed number of users are present.

Output

EVENT_NAME_USERS_READY: Passes inbound data through

Since:

1.4

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERR_NOT_ENOUGH_USERS
static String	EVENT_NAME_USERS_READY
static String	MSG_FOUND_USERS

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
CheckUserCountEventProcessor(UserDataService userDataService, long userCount)

Method Summary

Methods

Modifier and Type	Method and Description
EventResult	processEvent(Event event) Process an event.
void	setEventNameUsersReady(String eventNameUsersReady) Override the default event name when users are ready

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

Field Detail

EVENT_NAME_USERS_READY

public static final String EVENT_NAME_USERS_READY

See Also:

Constant Field Values

ERR_NOT_ENOUGH_USERS

public static final String ERR_NOT_ENOUGH_USERS

See Also:

Constant Field Values

MSG_FOUND_USERS

public static final String MSG_FOUND_USERS

See Also:

Constant Field Values

Constructor Detail

CheckUserCountEventProcessor

public CheckUserCountEventProcessor(UserDataService userDataService,
                            long userCount)

Parameters:

userDataService - the service that provides a view onto the users

userCount - the minimum number of users to have

Method Detail

setEventNameUsersReady

public void setEventNameUsersReady(String eventNameUsersReady)

Override the default event name when users are ready

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()