org.ow2.proactive.authentication

Interface UsersService

public interface UsersService

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.Multimap<String,String>	addOrEditTenant(String tenant, Set<String> groups) Add a tenant or edit an existing tenant If the tenant already exists, its set of associated groups will be updated
List<OutputUserInfo>	addUser(InputUserInfo userInfo) Add a new user
boolean	checkPassword(String userName, String password) Check the user's password
void	commit() Commit pending changes to the file system
List<OutputUserInfo>	deleteUser(String userName) Delete an existing user
Set<String>	getGroups(String userName) Return the set of groups associated with a user
String	getTenant(String userName) Return the tenant associated with a user
OutputUserInfo	getUser(String userName) Returns a user info
com.google.common.collect.Multimap<String,String>	listTenants() List the tenant associations
List<OutputUserInfo>	listUsers() Returns the list of users
void	refresh() Refreshes the internal state of the service Must be called before interacting with the service
com.google.common.collect.Multimap<String,String>	removeTenant(String tenant) Remove a tenant and all its group associations
List<OutputUserInfo>	updateUser(InputUserInfo userInfo) Update an existing user
boolean	userExists(String userName) Checks if a user exists
boolean	usersChanged() check if users state have changed

Method Detail

refresh

void refresh()
      throws LoginException

Refreshes the internal state of the service Must be called before interacting with the service

Throws:

LoginException

usersChanged

boolean usersChanged()

check if users state have changed

Returns:

true if a user has been modified

commit

void commit()
     throws LoginException

Commit pending changes to the file system

Throws:

LoginException

listUsers

List<OutputUserInfo> listUsers()
                        throws LoginException

Returns the list of users

Returns:

list of users info

Throws:

LoginException

addUser

List<OutputUserInfo> addUser(InputUserInfo userInfo)
                      throws LoginException

Add a new user

Parameters:

userInfo - user information input

Returns:

list of users info after update

Throws:

LoginException

userExists

boolean userExists(String userName)

Checks if a user exists

Parameters:

userName - user login name

Returns:

true if the user exists

getUser

OutputUserInfo getUser(String userName)
                throws LoginException

Returns a user info

Parameters:

userName - user login name

Returns:

user info

Throws:

LoginException

updateUser

List<OutputUserInfo> updateUser(InputUserInfo userInfo)
                         throws LoginException

Update an existing user

Parameters:

userInfo - user login name

Returns:

list of users info after update

Throws:

LoginException

deleteUser

List<OutputUserInfo> deleteUser(String userName)
                         throws LoginException

Delete an existing user

Parameters:

userName - user login name

Returns:

list of users info after update

Throws:

LoginException

listTenants

com.google.common.collect.Multimap<String,String> listTenants()

List the tenant associations

Returns:

multimap of tenant to group associations

addOrEditTenant

com.google.common.collect.Multimap<String,String> addOrEditTenant(String tenant,
                                                                  Set<String> groups)

Add a tenant or edit an existing tenant If the tenant already exists, its set of associated groups will be updated

Parameters:

tenant - tenant name

groups - set of groups associated with this tenant

Returns:

multimap of tenant to group associations after update

removeTenant

com.google.common.collect.Multimap<String,String> removeTenant(String tenant)

Remove a tenant and all its group associations

Parameters:

tenant - tenant name

Returns:

multimap of tenant to group associations after update

checkPassword

boolean checkPassword(String userName,
                      String password)
               throws LoginException

Check the user's password

Parameters:

userName - user login name

password - clear text password to check

Returns:

true if the password is correct, false otherwise

Throws:

LoginException

getGroups

Set<String> getGroups(String userName)
               throws LoginException

Return the set of groups associated with a user

Parameters:

userName - user login name

Returns:

set of groups

Throws:

LoginException

getTenant

String getTenant(String userName)
          throws LoginException

Return the tenant associated with a user

Parameters:

userName - user login name

Returns:

a tenant name or null if no tenant is associated

Throws:

LoginException