Package com.easydesk.modules.security.adaptor

Class ModuleUserManagerAdaptor<U extends User>

java.lang.Object

com.easydesk.modules.security.adaptor.ModuleUserManagerAdaptor<U>

All Implemented Interfaces:

SecurityEntityManager<User,Long>, UserManager, Serializable

@Component
public class ModuleUserManagerAdaptor<U extends User>
extends Object
implements UserManager

UserManagerAdaptor MVC module 안에서만 사용된다.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ModuleUserManagerAdaptor(CredentialService credentialService)

Method Summary

Modifier and Type	Method	Description
User	add(User entity)	database 에 존재하지 않는 user 인 경우에만 add 가능하다.
void	authenticate(User user, String password)	Authenticate an User with the specified password.
void	changePassword(User user, String oldPassword, String newPassword)	Change the password for an User.
boolean	exists(User entity)	entity 가 저장소에 존재하는지 확인한다.
boolean	exists(String name)	이름에 해당하는 entity 가 저장소에 존재하는지 확인한다.
void	forcePassword(User user, String password)	Forcibly sets new password for an User.
EasyDeskAccessControlList<?>	getACL(User user)	Return a Class object representing the system's chosen implementation of of ACL interface.
User[]	getByName(String... name)	이름에 해당하는 entity 를 구한다.
User	getInstance()	Empty User Object 이다.
User	getInstance(Long id)	id 에 해당하는 entity 를 구한다.
void	remove(User entity)	entity 를 삭제한다.
void	rename(User entity, String name)	entity 의 이름을 변경한다.
<T extends User> UserSet<T>	retrieveUserList(Object criteria)	Retrieves a list of users based on the specified criteria.
void	saveUser(User user)	Saves User's data in the permanent storage.

Methods inherited from class java.lang.Object

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

Constructor Details

ModuleUserManagerAdaptor

public ModuleUserManagerAdaptor(CredentialService credentialService)

Method Details

getInstance

public User getInstance()

Empty User Object 이다. 주의 : Anonymous User Object 는 EasyDeskUserManager.getAnonymous() 를 사용해야 한다.

Specified by:

getInstance in interface SecurityEntityManager<User,Long>

Returns:

U empty object

getInstance

public User getInstance(Long id)
                 throws DataBackendException,
UnknownEntityException

Description copied from interface: SecurityEntityManager

id 에 해당하는 entity 를 구한다.

Specified by:

getInstance in interface SecurityEntityManager<User,Long>

Parameters:

id - entity id

Returns:

T which has id

Throws:

Exception

DataBackendException - 저장소 접근 중 오류가 발생한 경우

UnknownEntityException - id 에 해당하는 entity 가 없는 경우

getByName

public User[] getByName(String... name)
                 throws DataBackendException,
UnknownEntityException

Description copied from interface: SecurityEntityManager

이름에 해당하는 entity 를 구한다.

Specified by:

getByName in interface SecurityEntityManager<User,Long>

Parameters:

name -

Returns:

T who's login username is name

Throws:

DataBackendException

UnknownEntityException

rename

public void rename(User entity,
 String name)
            throws DataBackendException,
UnknownEntityException

Description copied from interface: SecurityEntityManager

entity 의 이름을 변경한다.

Specified by:

rename in interface SecurityEntityManager<User,Long>

Parameters:

entity -

name -

Throws:

DataBackendException

UnknownEntityException

remove

public void remove(User entity)
            throws DataBackendException,
UnknownEntityException

Description copied from interface: SecurityEntityManager

entity 를 삭제한다.

Specified by:

remove in interface SecurityEntityManager<User,Long>

Parameters:

entity -

Throws:

DataBackendException

UnknownEntityException

add

public User add(User entity)
         throws DataBackendException,
EntityExistsException

database 에 존재하지 않는 user 인 경우에만 add 가능하다. (user.id 가 EMPTY_ID 인 경우)

Specified by:

add in interface SecurityEntityManager<User,Long>

Parameters:

entity -

Returns:

Throws:

DataBackendException

EntityExistsException

exists

public boolean exists(User entity)
               throws DataBackendException

Description copied from interface: SecurityEntityManager

entity 가 저장소에 존재하는지 확인한다.

Specified by:

exists in interface SecurityEntityManager<User,Long>

Parameters:

entity -

Returns:

Throws:

DataBackendException

exists

public boolean exists(String name)
               throws DataBackendException

Description copied from interface: SecurityEntityManager

이름에 해당하는 entity 가 저장소에 존재하는지 확인한다.

Specified by:

exists in interface SecurityEntityManager<User,Long>

Parameters:

name -

Returns:

Throws:

DataBackendException

retrieveUserList

public <T extends User> UserSet<T> retrieveUserList(Object criteria)
                                             throws DataBackendException

Retrieves a list of users based on the specified criteria.

Specified by:

retrieveUserList in interface UserManager

Type Parameters:

T - User type

Parameters:

criteria - the criteria for filtering users

Returns:

a set of users matching the criteria

Throws:

DataBackendException - if there is a problem accessing the storage

saveUser

public void saveUser(User user)
              throws UnknownEntityException,
DataBackendException

Saves User's data in the permanent storage. The user account is required to exist in the storage.

Specified by:

saveUser in interface UserManager

Parameters:

user - the user object to save

Throws:

UnknownEntityException - if the user's account does not exist in the database.

DataBackendException - if there is a problem accessing the storage.

authenticate

public void authenticate(User user,
 String password)
                  throws PasswordMismatchException,
UnknownEntityException,
DataBackendException

Authenticate an User with the specified password. If authentication is successful the method returns nothing. If there are any problems, exception was thrown.

Specified by:

authenticate in interface UserManager

Parameters:

user - an User object to authenticate.

password - the user supplied password. ( plain text password )

Throws:

PasswordMismatchException - if the supplied password was incorrect.

UnknownEntityException - if the user's record does not exist in the database.

DataBackendException - if there is a problem accessing the storage.

changePassword

public void changePassword(User user,
 String oldPassword,
 String newPassword)
                    throws PasswordMismatchException,
UnknownEntityException,
DataBackendException

Change the password for an User.

Specified by:

changePassword in interface UserManager

Parameters:

user - an User to change password for.

oldPassword - the current password suplied by the user. ( plain text password )

newPassword - the current password requested by the user. ( plain text password )

Throws:

PasswordMismatchException - if the supplied password was incorrect.

UnknownEntityException - if the user's record does not exist in the database.

DataBackendException - if there is a problem accessing the storage.

forcePassword

public void forcePassword(User user,
 String password)
                   throws UnknownEntityException,
DataBackendException

Forcibly sets new password for an User. This is supposed by the administrator to change the forgotten or compromised passwords. Certain implementatations of this feature would require administrative level access to the authenticating server / program.

Specified by:

forcePassword in interface UserManager

Parameters:

user - an User to change password for.

password - the new password. ( plain text password )

Throws:

UnknownEntityException - if the user's record does not exist in the database.

DataBackendException - if there is a problem accessing the storage.

getACL

public EasyDeskAccessControlList<?> getACL(User user)
                                    throws UnknownEntityException

Return a Class object representing the system's chosen implementation of of ACL interface.

Specified by:

getACL in interface UserManager

Parameters:

user - the user

Returns:

systems's chosen implementation of ACL interface.

Throws:

UnknownEntityException - if the implementation of ACL interface could not be determined, or does not exist.