public class PrepareUsers
extends org.alfresco.bm.driver.event.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.
The user collection will be cleaned of any user entries where the 'created' flag is false i.e. users already created will be preserved. Once cleaned up, the preparation will check all users including those created.
In this way, the number of users can be extended but never decreased. If users already exist and you wish to ensure that all users are new users, change the user name pattern or use a new user mirror name. Numerical-based values can be used in: Value substitution can be used in:setDomainPattern(String)
setEmailAddressPattern(String)
setUsernamePattern(String)
setPasswordPattern(String)
{ "_id" : ObjectId("504f19ce4ece382c484d3dc1"), "randomizer" : 774971, "username" : "0000001.test@00000.example.com", "password" : "0000001.test@00000.example.com", "created" : false, "firstName" : "0000001", "lastName" : "Test", "email" : "0000001.test@00000.example.com", "domain" : "00000.example.com" }where the "randomizer" field is used to return users in a random order when querying for lists of users.
EVENT_NAME_USERS_PREPARED
: Marker indicating completionModifier 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 |
Constructor and Description |
---|
PrepareUsers(UserDataService userDataService,
long numberOfUsers) |
Modifier and Type | Method and Description |
---|---|
org.alfresco.bm.common.EventResult |
processEvent(org.alfresco.bm.driver.event.Event 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 |
getName, getWarnDelay, isAutoCloseSessionId, isAutoPropagateSessionId, isChart, processEvent, register, resumeTimer, setAutoCloseSessionId, setAutoPropagateSessionId, setBeanName, setChart, setEventName, setEventNames, setRegistry, setWarnDelay, stopTimer, suspendTimer, toString
public static final long DEFAULT_USERS_PER_DOMAIN
public static final String EVENT_NAME_USERS_PREPARED
public static final String DEFAULT_DOMAIN_PATTERN
public static final String DEFAULT_EMAIL_DOMAIN_PATTERN
public static final String DEFAULT_FIRST_NAME_PATTERN
public static final String DEFAULT_LAST_NAME_PATTERN
public static final String DEFAULT_EMAIL_ADDRESS_PATTERN
public static final String DEFAULT_USERNAME_PATTERN
public static final String DEFAULT_PASSWORD_PATTERN
public PrepareUsers(UserDataService userDataService, long numberOfUsers)
userDataService
- service for UserData
operationsnumberOfUsers
- number of users to create in totalpublic void setEventNameUsersCreated(String eventNameUsersPrepared)
default
event name when users have been prepared.public void setUsersPerDomain(long usersPerDomain)
default
number of users per email domainpublic void setDomainPattern(String domainPattern)
default
pattern for user domain names.
A numerical domain name counter is not available. Consider using the
PATTERN_EMAIL_DOMAIN
e.g. [emailDomain]domainPattern
- a pattern e.g. [emailDomain]public void setEmailDomainPattern(String emailDomainPattern)
default
pattern for email domains.
A numerical domain name counter is available.emailDomainPattern
- a pattern that may contain something like %05d
public void setFirstNamePattern(String firstNamePattern)
default
pattern for user first names.
A numberical user counter is available.firstNamePattern
- a pattern that may contain something like %05d
public void setLastNamePattern(String lastNamePattern)
default
pattern for user last names.
A numberical user counter is available.lastNamePattern
- a pattern that may contain something like %05d
public void setEmailAddressPattern(String emailAddressPattern)
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.emailAddressPattern
- a pattern containing the placeholders to change.public void setUsernamePattern(String usernamePattern)
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.usernamePattern
- a pattern containing the placeholders to change.public void setPasswordPattern(String passwordPattern)
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.passwordPattern
- a pattern containing the placeholders to change.public void setAssumeCreated(boolean assumeCreated)
assumeCreated
- true to mark users as created immediatelyCopyright © 2005–2019 Alfresco Software. All rights reserved.