org.alfresco.bm.user

Class CreateUser

java.lang.Object

org.alfresco.bm.event.AbstractEventProcessor

org.alfresco.bm.http.AuthenticatedHttpEventProcessor

org.alfresco.bm.user.CreateUser

All Implemented Interfaces:

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

public class CreateUser
extends org.alfresco.bm.http.AuthenticatedHttpEventProcessor

Event processor that creates a test-user in the alfresco-system based on the username present in the event and inserts an entry in mongo.

Input

Username of user to create

Data

Collection containing users. User* will be marked as created.

Actions

The user is created in alfresco through REST. An exception is thrown when user creation fails. When user already existed in alfresco when processed and 'ignoreExistingUsers' property is set to true, the event is considered processed successfuly instead of throwing an exception.

Output

No next event will be scheduled.

Since:

1.1

Author:

Frederik Heremans, Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static String	PEOPLE_JSON_EMAIL
static String	PEOPLE_JSON_FIRSTNAME
static String	PEOPLE_JSON_GROUPS
static String	PEOPLE_JSON_LASTNAME
static String	PEOPLE_JSON_NODEREF
static String	PEOPLE_JSON_PASSWORD
static String	PEOPLE_JSON_USERNAME

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

DEFAULT_AUTO_CLOSE_SESSION_ID, DEFAULT_AUTO_PROPAGATE_SESSION_ID, DEFAULT_CHART, DEFAULT_WARN_DELAY, logger

Constructor Summary

Constructors

Constructor and Description
CreateUser(org.alfresco.http.HttpClientProvider httpClientProvider, org.alfresco.http.AuthenticationDetailsProvider authenticationDetailsProvider, String baseUrl, org.alfresco.bm.user.UserDataService userDataService)

Method Summary

Modifier and Type	Method and Description
List<String>	getRandomGroups() Using the current user group chances, generate a set of random groups according to the chances.
Map<String,Double>	getUserGroups() Used for testing
org.alfresco.bm.event.EventResult	processEvent(org.alfresco.bm.event.Event event)
void	setIgnoreExistingUsers(boolean ignoreExistingUsers)
void	setUserGroups(String userGroupStr) A description of the groups users should be added to with percentage chances.

Methods inherited from class org.alfresco.bm.http.AuthenticatedHttpEventProcessor

executeHttpMethodAsAdmin, executeHttpMethodAsUser, getAuthDetailProvider, getFullUrlForPath, getHttpProvider, releaseResources

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

getName, getWarnDelay, isAutoCloseSessionId, isAutoPropagateSessionId, isChart, processEvent, register, resumeTimer, setAutoCloseSessionId, setAutoPropagateSessionId, setBeanName, setChart, setEventName, setEventNames, setRegistry, setWarnDelay, stopTimer, suspendTimer, toString

Methods inherited from class java.lang.Object

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

Field Detail

PEOPLE_JSON_USERNAME

public static final String PEOPLE_JSON_USERNAME

See Also:

Constant Field Values

PEOPLE_JSON_FIRSTNAME

public static final String PEOPLE_JSON_FIRSTNAME

See Also:

Constant Field Values

PEOPLE_JSON_LASTNAME

public static final String PEOPLE_JSON_LASTNAME

See Also:

Constant Field Values

PEOPLE_JSON_EMAIL

public static final String PEOPLE_JSON_EMAIL

See Also:

Constant Field Values

PEOPLE_JSON_PASSWORD

public static final String PEOPLE_JSON_PASSWORD

See Also:

Constant Field Values

PEOPLE_JSON_GROUPS

public static final String PEOPLE_JSON_GROUPS

See Also:

Constant Field Values

PEOPLE_JSON_NODEREF

public static final String PEOPLE_JSON_NODEREF

See Also:

Constant Field Values

Constructor Detail

CreateUser

public CreateUser(org.alfresco.http.HttpClientProvider httpClientProvider,
                  org.alfresco.http.AuthenticationDetailsProvider authenticationDetailsProvider,
                  String baseUrl,
                  org.alfresco.bm.user.UserDataService userDataService)

Method Detail

setIgnoreExistingUsers

public void setIgnoreExistingUsers(boolean ignoreExistingUsers)

Parameters:

ignoreExistingUsers - whether or not to ignore existing users when creating. If set to true the event will be successful when executed. If set to false, an exception will be thrown when user already exists.

setUserGroups

public void setUserGroups(String userGroupStr)

A description of the groups users should be added to with percentage chances. The following string:

    SITE_ADMINISTRATORS:0.05, DATA_ANALYSTS:0.25
 

will result in users having a 5% chance of being assigned to the 'SITE_ADMINISTRATORS' group and a 25% chance of being assigned to the 'DATA_ANALYSTS' group. The group assignments are always considered separately i.e. being assigned to one group does not change the chances of being assigned to another group.

NOTE: The API used requires that the group names are prepended with the GROUP_ prefix; this is done automatically and should not be specified here. Use the group names as they appear on the administrator's group management screens.

Parameters:

userGroupStr - a string description of groups to assign users to

Throws:

IllegalArgumentException - if the input string is not well-formed

getUserGroups

public Map<String,Double> getUserGroups()

Used for testing

getRandomGroups

public List<String> getRandomGroups()

Using the current user group chances, generate a set of random groups according to the chances.

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