org.alfresco.bm.process.share

Class AbstractShareEventProcessor

java.lang.Object

org.alfresco.bm.event.AbstractEventProcessor

org.alfresco.bm.process.share.AbstractShareEventProcessor

All Implemented Interfaces:

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

Direct Known Subclasses:

CreateFolderEventProcess, EditOfflineEventProcess, FileDownloadEventProcess, FileUploadEventProcess, FileUploadNewVersionEventProcess, LoginEventProcess, LogoutEventProcess, NavigateToShareEventProcess, NavigateToSiteEventProcess, NavigationEventProcess, PeopleSearchEventProcess, SearchEventProcess, SelectDocLibFileEventProcess, SelectDocLibFolderEventProcess, SelectDocLibPageEventProcess, SelectFileUploadEventProcess, SelectNewFolderEventProcess, SelectSearchEntryEventProcess, SelectUploadNewVersionEventProcess, ShareScenarioSelector, SiteCreateEventProcess, SiteDeleteEventProcess, SiteFinderEventProcess, SiteNavigationEventProcess, WebDroneCloseEventProcess

public abstract class AbstractShareEventProcessor
extends org.alfresco.bm.event.AbstractEventProcessor

Abstract for all event process that use share with WebDrone.

Since:

1.0

Author:

Michael Suzuki

Field Summary

Fields

Modifier and Type	Field and Description
protected String	eventNameActionComplete The name of the next event to follow upon completing the current event.
protected org.apache.commons.logging.Log	logger
protected org.alfresco.bm.user.UserDataService	userDataService

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

DEFAULT_CHART, DEFAULT_PROPAGATE_SESSION_ID, DEFAULT_WARN_DELAY

Constructor Summary

Constructors

Constructor and Description
AbstractShareEventProcessor(org.alfresco.bm.user.UserDataService userDataService, String eventNameActionComplete) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeWebDrone(org.alfresco.webdrone.WebDrone drone, String sessionId) Shut WebDrone off.
org.alfresco.bm.user.UserData	getUserData(String username) Extracts user entity from data service.
org.alfresco.bm.event.EventResult	processEvent(org.alfresco.bm.event.Event event)
protected abstract org.alfresco.bm.event.EventResult	processEvent(org.alfresco.bm.event.Event event, ShareEventData eventData) Process a share based event.
void	setEventNameActionComplete(String eventNameActionComplete) Set the name of the event to follow.
void	setSessionService(org.alfresco.bm.session.SessionService sessionService) Set the service required to end browser sessions

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

logger

protected final org.apache.commons.logging.Log logger

userDataService

protected org.alfresco.bm.user.UserDataService userDataService

eventNameActionComplete

protected String eventNameActionComplete

The name of the next event to follow upon completing the current event.

Constructor Detail

AbstractShareEventProcessor

public AbstractShareEventProcessor(org.alfresco.bm.user.UserDataService userDataService,
                           String eventNameActionComplete)

Constructor.

Parameters:

userDataService - user data service

eventNameActionComplete - String next event name

Method Detail

setSessionService

public void setSessionService(org.alfresco.bm.session.SessionService sessionService)

Set the service required to end browser sessions

setEventNameActionComplete

public void setEventNameActionComplete(String eventNameActionComplete)

Set the name of the event to follow.

Parameters:

eventNameActionComplete -

processEvent

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

Process a share based event.

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

processEvent

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

Specified by:

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

Throws:

Exception

closeWebDrone

protected void closeWebDrone(org.alfresco.webdrone.WebDrone drone,
                 String sessionId)

Shut WebDrone off.

Parameters:

drone - WebDrone the unmanned browser

sessionId - the session to close

getUserData

public org.alfresco.bm.user.UserData getUserData(String username)
                                          throws UserNotFoudException

Extracts user entity from data service.

Parameters:

username - String user identifier

Returns:

UserData user entity

Throws:

UserNotFoudException - if user name did not match a user