org.alfresco.bm.user

Class PrepareUsers

java.lang.Object

org.alfresco.bm.event.AbstractEventProcessor

org.alfresco.bm.user.PrepareUsers

All Implemented Interfaces:

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

public class PrepareUsers
extends AbstractEventProcessor

Prepare a specific number of users for interaction with Alfresco. This does not actually create users in Alfresco but merely creates a population of users (email addresses, names, etc) that can be used by subsequent operations.

Numerical-based values can be used in:

• setEmailDomainPattern(String)
• setFirstNamePattern(String)
• setLastNamePattern(String)

Value substitution can be used in:

• setDomainPattern(String)
• setEmailAddressPattern(String)
• setUsernamePattern(String)
• setPasswordPattern(String)

Values that can be substituted are:

• PATTERN_EMAIL_DOMAIN
• PATTERN_FIRST_NAME
• PATTERN_LAST_NAME
• PATTERN_EMAIL_ADDRESS

User data will be similar to this:

      {
        "_id" : ObjectId("504f19ce4ece382c484d3dc1"),
        "_class" : "org.alfresco.bm.user.UserData",
        "randomizer" : 774971,
        "username" : "0000001.test@00000.test",
        "password" : "0000001.test@00000.test",
        "created" : false,
        "firstName" : "0000001",
        "lastName" : "Test",
        "email" : "0000001.test@00000.test",
        "domain" : "00000.test"
      }
 

where the "randomizer" field is used to return users in a random order when querying for lists of users.
Username, first name, last name and email patterns can be set.

Input

None.

Data

No data requirements.

Actions

Users data objects are created. This data is local only.

Output

EVENT_NAME_USERS_PREPARED: Marker indicating completion

Since:

1.1

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DOMAIN_PATTERN
static String	DEFAULT_EMAIL_ADDRESS_PATTERN
static String	DEFAULT_EMAIL_DOMAIN_PATTERN
static String	DEFAULT_FIRST_NAME_PATTERN
static String	DEFAULT_LAST_NAME_PATTERN
static String	DEFAULT_PASSWORD_PATTERN
static String	DEFAULT_USERNAME_PATTERN
static long	DEFAULT_USERS_PER_DOMAIN
static String	EVENT_NAME_USERS_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
PrepareUsers(UserDataService userDataService, long numberOfUsers)

Method Summary

Methods

Modifier and Type	Method and Description
EventResult	processEvent(Event event) Process an event.
void	setAssumeCreated(boolean assumeCreated) Assume that all users already exist on the server i.e.
void	setDomainPattern(String domainPattern) Override the default pattern for user domain names.
void	setEmailAddressPattern(String emailAddressPattern) Override the default pattern for the email address.
void	setEmailDomainPattern(String emailDomainPattern) Override the default pattern for email domains.
void	setEventNameUsersCreated(String eventNameUsersPrepared) Override the default event name when users have been prepared.
void	setFirstNamePattern(String firstNamePattern) Override the default pattern for user first names.
void	setLastNamePattern(String lastNamePattern) Override the default pattern for user last names.
void	setPasswordPattern(String passwordPattern) Override the default pattern for the password.
void	setUsernamePattern(String usernamePattern) Override the default pattern for the username.
void	setUsersPerDomain(long usersPerDomain) Override the default number of users per email domain

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

DEFAULT_USERS_PER_DOMAIN

public static final long DEFAULT_USERS_PER_DOMAIN

See Also:

Constant Field Values

EVENT_NAME_USERS_PREPARED

public static final String EVENT_NAME_USERS_PREPARED

See Also:

Constant Field Values

DEFAULT_DOMAIN_PATTERN

public static final String DEFAULT_DOMAIN_PATTERN

See Also:

Constant Field Values

DEFAULT_EMAIL_DOMAIN_PATTERN

public static final String DEFAULT_EMAIL_DOMAIN_PATTERN

See Also:

Constant Field Values

DEFAULT_FIRST_NAME_PATTERN

public static final String DEFAULT_FIRST_NAME_PATTERN

See Also:

Constant Field Values

DEFAULT_LAST_NAME_PATTERN

public static final String DEFAULT_LAST_NAME_PATTERN

See Also:

Constant Field Values

DEFAULT_EMAIL_ADDRESS_PATTERN

public static final String DEFAULT_EMAIL_ADDRESS_PATTERN

See Also:

Constant Field Values

DEFAULT_USERNAME_PATTERN

public static final String DEFAULT_USERNAME_PATTERN

See Also:

Constant Field Values

DEFAULT_PASSWORD_PATTERN

public static final String DEFAULT_PASSWORD_PATTERN

See Also:

Constant Field Values

Constructor Detail

PrepareUsers

public PrepareUsers(UserDataService userDataService,
            long numberOfUsers)

Parameters:

userDataService - service for UserData operations

numberOfUsers - number of users to create in total

Method Detail

setEventNameUsersCreated

public void setEventNameUsersCreated(String eventNameUsersPrepared)

Override the default event name when users have been prepared.

setUsersPerDomain

public void setUsersPerDomain(long usersPerDomain)

Override the default number of users per email domain

setDomainPattern

public void setDomainPattern(String domainPattern)

Override the default pattern for user domain names. A numerical domain name counter is not available. Consider using the PATTERN_EMAIL_DOMAIN e.g. [emailDomain]

Parameters:

domainPattern - a pattern e.g. [emailDomain]

setEmailDomainPattern

public void setEmailDomainPattern(String emailDomainPattern)

Override the default pattern for email domains. A numerical domain name counter is available.

Parameters:

emailDomainPattern - a pattern that may contain something like %05d

setFirstNamePattern

public void setFirstNamePattern(String firstNamePattern)

Override the default pattern for user first names. A numberical user counter is available.

Parameters:

firstNamePattern - a pattern that may contain something like %05d

setLastNamePattern

public void setLastNamePattern(String lastNamePattern)

Override the default pattern for user last names. A numberical user counter is available.

Parameters:

lastNamePattern - a pattern that may contain something like %05d

setEmailAddressPattern

public void setEmailAddressPattern(String emailAddressPattern)

Override the default pattern for the email address. Values ${firstName}, ${lastName} and ${emailDomain} will be substituted with values generated for the fist name, last name and email domain respectively.

Parameters:

emailAddressPattern - a pattern containing the placeholders to change.

setUsernamePattern

public void setUsernamePattern(String usernamePattern)

Override the default pattern for the username. Values ${firstName}, ${lastName}, ${emailDomain} and ${emailAddress} will be substituted with values generated for the fist name, last name, email domain and email address respectively.

Parameters:

usernamePattern - a pattern containing the placeholders to change.

setPasswordPattern

public void setPasswordPattern(String passwordPattern)

Override the default pattern for the password. Values ${firstName}, ${lastName}, ${emailDomain} and ${emailAddress} will be substituted with values generated for the fist name, last name, email domain and email address respectively.

Parameters:

passwordPattern - a pattern containing the placeholders to change.

setAssumeCreated

public void setAssumeCreated(boolean assumeCreated)

Assume that all users already exist on the server i.e. mark them as created.

Parameters:

assumeCreated - true to mark users as created immediately

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