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: maxNetworks: the maximum number of networks to include. -1 indicates just use the networks implicit in the users collection. maxSites: in each network, the maximum number of sites to include. -1 indicates just use all the sites in the sites collection. maxMembersPerSite: the maximum number of members per site (currently from the same network only). -1 indicates just use all the users in the users collection for the current network. TODO Currently, site memberships only for users in the same network. Expand to include other networks.

Author:

steveglover

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_MEMBERS_PER_SITE
static int	DEFAULT_MAX_NETWORKS
static int	DEFAULT_MAX_SITES
static String	EVENT_NAME_SITE_MEMBERS_PREPARED

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

DEFAULT_CHART, DEFAULT_WARN_DELAY, logger

Constructor Summary

Constructors

Constructor and Description
PrepareSiteMembers(Services services)

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	setMaxNetworks(int maxNetworks)
void	setMaxSites(int maxSites)

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

getWarnDelay, isChart, register, setBeanName, setChart, setEventName, setEventNames, setRegistry, setWarnDelay

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_NAME_SITE_MEMBERS_PREPARED

public static final String EVENT_NAME_SITE_MEMBERS_PREPARED

See Also:

Constant Field Values

DEFAULT_MAX_NETWORKS

public static final int DEFAULT_MAX_NETWORKS

See Also:

Constant Field Values

DEFAULT_MAX_SITES

public static final int DEFAULT_MAX_SITES

See Also:

Constant Field Values

DEFAULT_MAX_MEMBERS_PER_SITE

public static final int DEFAULT_MAX_MEMBERS_PER_SITE

See Also:

Constant Field Values

Constructor Detail

PrepareSiteMembers

public PrepareSiteMembers(Services services)

Parameters:

services - data collections

Method Detail

setMaxNetworks

public void setMaxNetworks(int maxNetworks)

setMaxSites

public void setMaxSites(int maxSites)

setMaxMembersPerSite

public void setMaxMembersPerSite(int maxMembersPerSite)

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 interface: EventProcessor

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.

Parameters:

event - the event (along with associated data)

Returns:

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

Throws:

Exception