org.alfresco.bm.site

Class PrepareSiteMembers

java.lang.Object

org.alfresco.bm.event.AbstractEventProcessor

org.alfresco.bm.site.PrepareSiteMembers

All Implemented Interfaces:

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

public class PrepareSiteMembers
extends AbstractEventProcessor

Prepares site members for creation by populating the site members collection. The number of site members to create is driven by: maxSites: if -1, uses all created sites in the sites collection maxMembersPerSite: must be greater than 0

Author:

steveglover TODO: only site members from same network as site at present.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_NAME_SITE_MEMBERS_PREPARED

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
PrepareSiteMembers(UserDataService userDataService, SiteDataService siteDataService)

Method Summary

Methods

Modifier and Type	Method and Description
EventResult	processEvent(Event event) Process an event.
void	setEventNameSiteMembersPrepared(String eventNameSiteMembersPrepared) Override the default event name when site members have been created.
void	setMaxMembersPerSite(int maxMembersPerSite)
void	setMaxSiteMembers(int maxSiteMembers)

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_SITE_MEMBERS_PREPARED

public static final String EVENT_NAME_SITE_MEMBERS_PREPARED

See Also:

Constant Field Values

Constructor Detail

PrepareSiteMembers

public PrepareSiteMembers(UserDataService userDataService,
                  SiteDataService siteDataService)

Parameters:

userDataService - user data service

siteDataService - site data service

Method Detail

setMaxMembersPerSite

public void setMaxMembersPerSite(int maxMembersPerSite)

setMaxSiteMembers

public void setMaxSiteMembers(int maxSiteMembers)

setEventNameSiteMembersPrepared

public void setEventNameSiteMembersPrepared(String eventNameSiteMembersPrepared)

Override the default event name when site members have been created.

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