org.alfresco.test.util

Class UserService

java.lang.Object

org.alfresco.test.util.UserService

public class UserService
extends Object

Create user helper class, creates an Alfresco user using public API.

Author:

Michael Suzuki, Bocancea Bogdan

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LAST_NAME
static String	PAGE_ACCEPT_URL
static String	PAGE_REJECT_URL

Constructor Summary

Constructors

Constructor and Description
UserService()

Method Summary

Modifier and Type	Method and Description
boolean	addDashlet(String userName, String password, DashboardCustomization.UserDashlet dashlet, DashboardCustomization.DashletLayout layout, int column, int position) Add dashlet to user dashboard
boolean	addSubGroup(String adminUser, String adminPass, String groupName, String subGroup) Add sub group.
boolean	addUserToGroup(String adminUser, String adminPass, String groupName, String userName) Add user to group.
int	countAuthoritiesFromGroup(String adminUser, String adminPass, String groupName) Count users and groups added in root group
int	countSiteMembers(String userName, String userPass, String siteName) Count members of a site
boolean	create(String adminUser, String adminPass, String userName, String password, String email) Create an Alfresco user on enterprise.
boolean	createGroup(String adminUser, String adminPass, String groupName) Create a new Group.
boolean	delete(String adminUser, String adminPass, String userName) Delete a user from enterprise.
boolean	groupExists(String adminUser, String adminPass, String groupName) Checks if group exists.
boolean	inviteUserToSiteAndAccept(String invitingUserName, String invitingUserPassword, String userToInvite, String siteName, String role) Utility to invite a enterprise user to Site and accept the invitation
boolean	login(String userName, String userPass) Login in alfresco share
boolean	removeGroup(String adminUser, String adminPass, String groupName) Remove a root group
boolean	removePendingSiteRequest(String siteManager, String passwordManager, String userName, String siteId) Delete a pending request for a Moderated Site
boolean	removeSiteMembership(String siteManager, String passwordManager, String userName, String siteId) Remove a user from site
boolean	removeSubgroupFromGroup(String adminUser, String adminPass, String groupName, String subGroup) Remove subgroup from group
boolean	removeUserFromGroup(String adminUser, String adminPass, String groupName, String userName) Remove user from group
boolean	requestSiteMembership(String userName, String password, String siteId) Method to request to join a site
boolean	userExists(String adminUser, String adminPass, String username) Checks if user already exists.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LAST_NAME

public static String DEFAULT_LAST_NAME

PAGE_ACCEPT_URL

public static String PAGE_ACCEPT_URL

PAGE_REJECT_URL

public static String PAGE_REJECT_URL

Constructor Detail

UserService

public UserService()

Method Detail

create

public boolean create(String adminUser,
                      String adminPass,
                      String userName,
                      String password,
                      String email)
               throws Exception

Create an Alfresco user on enterprise.

Parameters:

adminUser - admin username

adminPass - password

userName - String identifier new user

password - new user password

email - new user email

Returns:

true if successful

Throws:

Exception - if error

userExists

public boolean userExists(String adminUser,
                          String adminPass,
                          String username)
                   throws Exception

Checks if user already exists.

Parameters:

adminUser - admin username

adminPass - admin credential

username - user identifier

Returns:

true if user exists

Throws:

Exception - if error

delete

public boolean delete(String adminUser,
                      String adminPass,
                      String userName)
               throws Exception

Delete a user from enterprise.

Parameters:

adminUser - admin username

adminPass - admin credential

userName - String identifier user identifier

Returns:

true if successful

Throws:

Exception - if error

inviteUserToSiteAndAccept

public boolean inviteUserToSiteAndAccept(String invitingUserName,
                                         String invitingUserPassword,
                                         String userToInvite,
                                         String siteName,
                                         String role)
                                  throws Exception

Utility to invite a enterprise user to Site and accept the invitation

Parameters:

invitingUserName - user identifier

invitingUserPassword - user password

userToInvite - user label

siteName - site identifier which invite user.

role - user role

Returns:

true if invite is successful

Throws:

Exception - if error

requestSiteMembership

public boolean requestSiteMembership(String userName,
                                     String password,
                                     String siteId)
                              throws Exception

Method to request to join a site

Parameters:

userName - String identifier

password - String password

siteId - site identifier

Returns:

true if request is successful

Throws:

Exception - if error

removePendingSiteRequest

public boolean removePendingSiteRequest(String siteManager,
                                        String passwordManager,
                                        String userName,
                                        String siteId)
                                 throws Exception

Delete a pending request for a Moderated Site

Parameters:

siteManager - site manager id

passwordManager - password

userName - String identifier - user that made the request to the Site

siteId - site identifier

Returns:

true if request is deleted (204 Status)

Throws:

Exception - if error

removeSiteMembership

public boolean removeSiteMembership(String siteManager,
                                    String passwordManager,
                                    String userName,
                                    String siteId)
                             throws Exception

Remove a user from site

Parameters:

siteManager - String site manager

passwordManager - String password

userName - String identifier - user that made the request to the Site

siteId - String site id

Returns:

true if request is deleted (204 Status)

Throws:

Exception - if error

groupExists

public boolean groupExists(String adminUser,
                           String adminPass,
                           String groupName)
                    throws Exception

Checks if group exists.

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - String group name

Returns:

true if user exists

Throws:

Exception - if error

createGroup

public boolean createGroup(String adminUser,
                           String adminPass,
                           String groupName)
                    throws Exception

Create a new Group.

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - group name

Returns:

true if user exists

Throws:

Exception - if error

addUserToGroup

public boolean addUserToGroup(String adminUser,
                              String adminPass,
                              String groupName,
                              String userName)
                       throws Exception

Add user to group.

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - group name

userName - String identifier

Returns:

true if user exists

Throws:

Exception - if error

addSubGroup

public boolean addSubGroup(String adminUser,
                           String adminPass,
                           String groupName,
                           String subGroup)
                    throws Exception

Add sub group. If sub group doesn't exists it will be created.

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - group name

subGroup - sub group name

Returns:

true if subgroup is created

Throws:

Exception - if error

removeUserFromGroup

public boolean removeUserFromGroup(String adminUser,
                                   String adminPass,
                                   String groupName,
                                   String userName)
                            throws Exception

Remove user from group

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - group name

userName - String identifier

Returns:

true if user exists

Throws:

Exception - if error

removeSubgroupFromGroup

public boolean removeSubgroupFromGroup(String adminUser,
                                       String adminPass,
                                       String groupName,
                                       String subGroup)
                                throws Exception

Remove subgroup from group

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - group name

subGroup - sub group name

Returns:

true if user exists

Throws:

Exception - if error

removeGroup

public boolean removeGroup(String adminUser,
                           String adminPass,
                           String groupName)
                    throws Exception

Remove a root group

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - String group name

Returns:

true if user exists

Throws:

Exception - if error

countAuthoritiesFromGroup

public int countAuthoritiesFromGroup(String adminUser,
                                     String adminPass,
                                     String groupName)
                              throws Exception

Count users and groups added in root group

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - String group name

Returns:

true if user exists

Throws:

Exception - if error

countSiteMembers

public int countSiteMembers(String userName,
                            String userPass,
                            String siteName)
                     throws Exception

Count members of a site

Parameters:

userName - login user that owns the site

userPass - user password

siteName - String site name

Returns:

total number of site members

Throws:

Exception - if error

login

public boolean login(String userName,
                     String userPass)
              throws Exception

Login in alfresco share

Parameters:

userName - login user name

userPass - login user password

Returns:

true for successful user login

Throws:

Exception - if error

addDashlet

public boolean addDashlet(String userName,
                          String password,
                          DashboardCustomization.UserDashlet dashlet,
                          DashboardCustomization.DashletLayout layout,
                          int column,
                          int position)
                   throws Exception

Add dashlet to user dashboard

Parameters:

userName - String identifier

password - String password

dashlet - Dashlet dashlet

layout - dashlet layout

column - int column index

position - position in column

Returns:

true if the dashlet is added

Throws:

Exception - if error