org.alfresco.bm.process.share.soak

Class ShareScenarioSelector

java.lang.Object

org.alfresco.bm.event.AbstractEventProcessor

org.alfresco.bm.process.share.AbstractShareEventProcessor

org.alfresco.bm.process.share.soak.ShareScenarioSelector

All Implemented Interfaces:

org.alfresco.bm.event.EventProcessor, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class ShareScenarioSelector
extends AbstractShareEventProcessor

A processor that chooses the next Share user scenario based on the current session's context.

This class makes use of a registry of EventProcessor instances that effectively choose the next event(s) to execute.
Events are extracted from the normal results and modified to ensure a minimum delay in the processing.

A user's session is always respected i.e. the user scenario will be called to determine the next user action. Where there is no active user scenario, the current session time will be examined and the user either logout or a new scenario will be chosen (according to weightings). Scenarios will start on the user dashboard page.

Input

ShareEventData with a valid Share page.

Actions

No actions are performed. This processor is merely a route selector.

Output

EVENT_NAME_LOGOUT: A share page is carried forward to log out

Since:

1.0

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FALLBACK_EVENT_NAME
static long	DEFAULT_MAX_EVENT_DELAY
static long	DEFAULT_MAX_SESSION_TIME
static long	DEFAULT_MIN_EVENT_DELAY
static long	DEFAULT_MIN_SESSION_TIME
static int	DEFAULT_SESSION_ATTEMPTS
static String	EVENT_NAME_LOGOUT

Fields inherited from class org.alfresco.bm.process.share.AbstractShareEventProcessor

eventNameActionComplete, logger, userDataService

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

DEFAULT_AUTO_CLOSE_SESSION_ID, DEFAULT_AUTO_PROPAGATE_SESSION_ID, DEFAULT_CHART, DEFAULT_WARN_DELAY

Constructor Summary

Constructors

Constructor and Description
ShareScenarioSelector(org.alfresco.bm.user.UserDataService userDataService, org.alfresco.bm.session.SessionService sessionService, ShareScenarioRegistry scenarioRegistry)

Method Summary

Modifier and Type	Method and Description
org.alfresco.bm.event.EventResult	processEvent(org.alfresco.bm.event.Event event, ShareEventData eventData) Process a share based event.
void	setBeanName(String beanName) Overridden to record the bean name for reporting.
void	setFallbackEventName(String fallbackEventName) Override the default event name to be called when no scenario could be found.
void	setMaxEventDelay(long maxEventDelay) Override the default maximum user wait
void	setMaxSessionTime(long maxSessionTime) Override the default maximum user session length
void	setMinEventDelay(long minEventDelay) Override the default minimum user wait
void	setMinSessionTime(long minSessionTime) Override the default minimum user session length
void	setSessionAttempts(int sessionAttempts) Override the default number of times to try to get a session that can continue from the current context.

Methods inherited from class org.alfresco.bm.process.share.AbstractShareEventProcessor

closeWebDriver, getUserData, processEvent, setEventNameActionComplete, setSessionService

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

getName, getWarnDelay, isAutoCloseSessionId, isAutoPropagateSessionId, isChart, processEvent, register, resumeTimer, setAutoCloseSessionId, setAutoPropagateSessionId, 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

EVENT_NAME_LOGOUT

public static final String EVENT_NAME_LOGOUT

See Also:

Constant Field Values

DEFAULT_FALLBACK_EVENT_NAME

public static final String DEFAULT_FALLBACK_EVENT_NAME

See Also:

Constant Field Values

DEFAULT_MIN_SESSION_TIME

public static final long DEFAULT_MIN_SESSION_TIME

See Also:

Constant Field Values

DEFAULT_MAX_SESSION_TIME

public static final long DEFAULT_MAX_SESSION_TIME

See Also:

Constant Field Values

DEFAULT_MIN_EVENT_DELAY

public static final long DEFAULT_MIN_EVENT_DELAY

See Also:

Constant Field Values

DEFAULT_MAX_EVENT_DELAY

public static final long DEFAULT_MAX_EVENT_DELAY

See Also:

Constant Field Values

DEFAULT_SESSION_ATTEMPTS

public static final int DEFAULT_SESSION_ATTEMPTS

See Also:

Constant Field Values

Constructor Detail

ShareScenarioSelector

public ShareScenarioSelector(org.alfresco.bm.user.UserDataService userDataService,
                             org.alfresco.bm.session.SessionService sessionService,
                             ShareScenarioRegistry scenarioRegistry)

Parameters:

userDataService - required in case user needs to log in again

sessionService - service to access session-specific data

scenarioRegistry - a registry of user scenario processors.

Method Detail

setBeanName

public void setBeanName(String beanName)

Overridden to record the bean name for reporting. The base class implementation is called.

Specified by:

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

Overrides:

setBeanName in class org.alfresco.bm.event.AbstractEventProcessor

setMinSessionTime

public void setMinSessionTime(long minSessionTime)

Override the default minimum user session length

setMaxSessionTime

public void setMaxSessionTime(long maxSessionTime)

Override the default maximum user session length

setMinEventDelay

public void setMinEventDelay(long minEventDelay)

Override the default minimum user wait

setMaxEventDelay

public void setMaxEventDelay(long maxEventDelay)

Override the default maximum user wait

setSessionAttempts

public void setSessionAttempts(int sessionAttempts)

Override the default number of times to try to get a session that can continue from the current context.

setFallbackEventName

public void setFallbackEventName(String fallbackEventName)

Override the default event name to be called when no scenario could be found.

processEvent

public org.alfresco.bm.event.EventResult processEvent(org.alfresco.bm.event.Event event,
                                                      ShareEventData eventData)
                                               throws Exception

Description copied from class: AbstractShareEventProcessor

Process a share based event.

Specified by:

processEvent in class AbstractShareEventProcessor

Parameters:

event - the origininating event (not normally required)

eventData - the share event data entity

Returns:

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

Throws:

Exception