org.ikasan.security.service

Interface UserService

All Superinterfaces:

org.springframework.security.provisioning.UserDetailsManager, org.springframework.security.core.userdetails.UserDetailsService

All Known Implementing Classes:

UserServiceImpl

public interface UserService
extends org.springframework.security.provisioning.UserDetailsManager

User and Authority service interface

Author:

Ikasan Development Team

Method Summary

Modifier and Type	Method and Description
void	changeUsersEmail(java.lang.String username, java.lang.String newEmail) Allows a specified user's email address.
void	changeUsersPassword(java.lang.String username, java.lang.String newPassword, java.lang.String confirmNewPassword) Allows a specified user's password.
void	disableUser(java.lang.String username) Disables the specified user
void	enableUser(java.lang.String username) Enables the specified user
java.util.List<Policy>	getAuthorities() Gets all Authorities in the system
java.util.List<User>	getUserByFirstnameLike(java.lang.String firstname) Retrieves a List of User whose firstname like firstname%
java.util.List<User>	getUserBySurnameLike(java.lang.String surname) Retrieves a List of User whose surname like surname%
java.util.List<User>	getUserByUsernameLike(java.lang.String username) Retrieves a List of User whose username like username%
java.util.List<UserLite>	getUserLites() Gets all UserLites in the system
java.util.List<User>	getUsers() Gets all Users in the system
void	grantAuthority(java.lang.String username, java.lang.String authority) Attempts to grant an authority to a user
User	loadUserByUsername(java.lang.String username)
void	revokeAuthority(java.lang.String username, java.lang.String authority) Attempts to revoke an authority from a user

Methods inherited from interface org.springframework.security.provisioning.UserDetailsManager

changePassword, createUser, deleteUser, updateUser, userExists

Method Detail

getUsers

java.util.List<User> getUsers()

Gets all Users in the system

Returns:

all Users

getUserLites

java.util.List<UserLite> getUserLites()

Gets all UserLites in the system

Returns:

all Users

getAuthorities

java.util.List<Policy> getAuthorities()

Gets all Authorities in the system

Returns:

all Authorities

loadUserByUsername

User loadUserByUsername(java.lang.String username)
                 throws org.springframework.security.core.userdetails.UsernameNotFoundException,
                        org.springframework.dao.DataAccessException

Specified by:

loadUserByUsername in interface org.springframework.security.core.userdetails.UserDetailsService

Throws:

org.springframework.security.core.userdetails.UsernameNotFoundException

org.springframework.dao.DataAccessException

grantAuthority

void grantAuthority(java.lang.String username,
                    java.lang.String authority)

Attempts to grant an authority to a user

Parameters:

username -

authority -

Throws:

java.lang.IllegalArgumentException - - if the user already has the authority

revokeAuthority

void revokeAuthority(java.lang.String username,
                     java.lang.String authority)

Attempts to revoke an authority from a user

Parameters:

username -

authority -

Throws:

java.lang.IllegalArgumentException - - if the user does not hold the authority

changeUsersPassword

void changeUsersPassword(java.lang.String username,
                         java.lang.String newPassword,
                         java.lang.String confirmNewPassword)
                  throws java.lang.IllegalArgumentException

Allows a specified user's password. Note that this should be an administrator function or a function of that particular user

Parameters:

username -

newPassword - as plain text

confirmNewPassword - as plain text

Throws:

java.lang.IllegalArgumentException - If the passwords don't match

changeUsersEmail

void changeUsersEmail(java.lang.String username,
                      java.lang.String newEmail)
               throws java.lang.IllegalArgumentException

Allows a specified user's email address. Note that this should be an administrator function or a function of that particular user

Parameters:

username -

newEmail - as plain text

Throws:

java.lang.IllegalArgumentException - If the user is not valid

disableUser

void disableUser(java.lang.String username)

Disables the specified user

Parameters:

username -

Throws:

java.lang.IllegalArgumentException - - if the specified user does not exist

enableUser

void enableUser(java.lang.String username)

Enables the specified user

Parameters:

username -

Throws:

java.lang.IllegalArgumentException - - if the specified user does not exist

getUserByUsernameLike

java.util.List<User> getUserByUsernameLike(java.lang.String username)

Retrieves a List of User whose username like username%

Parameters:

username -

Returns:

specified User or null if does not exist

getUserByFirstnameLike

java.util.List<User> getUserByFirstnameLike(java.lang.String firstname)

Retrieves a List of User whose firstname like firstname%

Parameters:

username -

Returns:

specified User or null if does not exist

getUserBySurnameLike

java.util.List<User> getUserBySurnameLike(java.lang.String surname)

Retrieves a List of User whose surname like surname%

Parameters:

username -

Returns:

specified User or null if does not exist