org.alfresco.dataprep

Class GroupService

java.lang.Object

org.alfresco.dataprep.GroupService

@Service
public class GroupService
extends Object

Constructor Summary

Constructors

Constructor and Description
GroupService()

Method Summary

Modifier and Type	Method and Description
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.
boolean	changeGroupRole(String siteManager, String passwordManager, String siteName, String groupName, String role) Change the role for a group
int	countAuthoritiesFromGroup(String adminUser, String adminPass, String groupName) Count users and groups added in root group
boolean	createGroup(String adminUser, String adminPass, String groupName) Create a new Group.
boolean	groupExists(String adminUser, String adminPass, String groupName) Checks if group exists.
boolean	inviteGroupToSite(String siteManager, String passwordManager, String siteId, String groupName, String role) Method to request to join a site
boolean	isUserAddedToGroup(String adminUser, String adminPass, String groupName, String userName) Verify if a user is member of a group.
boolean	removeGroup(String adminUser, String adminPass, String groupName) Remove a root group
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

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupService

public GroupService()

Method Detail

inviteGroupToSite

public boolean inviteGroupToSite(String siteManager,
                                 String passwordManager,
                                 String siteId,
                                 String groupName,
                                 String role)

Method to request to join a site

Parameters:

siteManager - String site manager

passwordManager - String password

siteId - site identifier

groupName - group to be invited

role - applied for the group

Returns:

true if request is successful

Throws:

RuntimeException - if invalid site or user role

groupExists

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

Checks if group exists.

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - String group name

Returns:

true if user exists

createGroup

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

Create a new Group.

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - group name

Returns:

true if user exists

addUserToGroup

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

Add user to group.

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - group name

userName - String identifier

Returns:

true if user exists

addSubGroup

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

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

removeUserFromGroup

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

Remove user from group

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - group name

userName - String identifier

Returns:

true if user exists

removeSubgroupFromGroup

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

Remove subgroup from group

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - group name

subGroup - sub group name

Returns:

true if user exists

removeGroup

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

Remove a root group

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - String group name

Returns:

true if user exists

countAuthoritiesFromGroup

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

Count users and groups added in root group

Parameters:

adminUser - admin username

adminPass - admin credential

groupName - String group name

Returns:

true if user exists

isUserAddedToGroup

public boolean isUserAddedToGroup(String adminUser,
                                  String adminPass,
                                  String groupName,
                                  String userName)

Verify if a user is member of a group.

Parameters:

adminUser - String admin user

adminPass - String admin password

groupName - String group

userName - String user to be searched

Returns:

boolean true if user is found

changeGroupRole

public boolean changeGroupRole(String siteManager,
                               String passwordManager,
                               String siteName,
                               String groupName,
                               String role)

Change the role for a group

Parameters:

siteManager - String site manager

passwordManager - String password

siteName - String site id

groupName - String identifier group name

role - String role

Returns:

true if request is successful (Status: 200)

Throws:

RuntimeException - if invalid site or if groupName is not member of the site