com.trackstudio.securedkernel
Class SecuredUserAdapterManager

java.lang.Object
  com.trackstudio.securedkernel.SecuredUserAdapterManager

public class SecuredUserAdapterManager
extends java.lang.Object

This manager is used for performing operations with users

Constructor Summary

SecuredUserAdapterManager()

Method Summary

java.lang.String	authenticate(java.lang.String login, java.lang.String password) Try to authenticate
void	changePassword(SessionContext sc, java.lang.String userId, java.lang.String password1, java.lang.String password2) Change password for the user
java.lang.String	createUser(SessionContext sc, java.lang.String parentId, java.lang.String login, java.lang.String name, java.lang.String prstatusId) Create a user
void	deleteUser(SessionContext sc, java.lang.String userId) Delete user
SecuredUserBean	findByLogin(SessionContext sc, java.lang.String login) Find user by ligin
java.lang.String	findUserIdByQuickGo(SessionContext sc, java.lang.String quickGo)
void	forgotPassword(java.lang.String login, java.lang.String email) Send e-mail with forgotten password
boolean	getActive(SessionContext sc, java.lang.String userId) Check is user active
java.util.ArrayList	getChildren(SessionContext sc, java.lang.String userId) Get children
java.util.ArrayList	getPossibleManagerList(SessionContext sc, java.lang.String userId) Get all possible managers
java.util.ArrayList	getUserAndChildrenList(SessionContext sc, java.lang.String userId) Get user and subordinates
java.util.LinkedList	getUserChain(SessionContext sc, java.lang.String stopUserId) Get chain of users
java.util.LinkedList	getUserChain(SessionContext sc, java.lang.String stopUserId, java.lang.String startUserId) Get chain of users
long	getUserExpireDate(SessionContext sc, java.lang.String userId) Get expire date for the user
java.lang.String	getUserId(SessionContext sc) Get id of a current user
Slider	getUserList(SessionContext sc, java.lang.String managerId, java.lang.String filterId, int page, boolean withUdf, java.lang.String order) Get filtered list of subordinates
Slider	getUserList(SessionContext sc, java.lang.String managerId, UserFValue filter, int page, boolean withUdf, java.lang.String order) Get filtered list of subordinates
java.util.ArrayList	getUserListForNewAcl(SessionContext sc, java.lang.String forUserId) Get user for just created access control rule
java.util.ArrayList	getUserManagerChildren(SessionContext sc, java.lang.String userId) Get subordinates for manager
boolean	isParentOf(SessionContext sc, java.lang.String parentId, java.lang.String userId) Check if one user is parent of another
void	pasteUsers(SessionContext sc, java.lang.String parentId, java.lang.String[] userIds) Paste users
void	setMaximumChildrenAllowed(SessionContext sc, java.lang.String userId, java.lang.Integer count) Set number of maximum allowed children
void	updateLastLogonDate(SessionContext sc, java.lang.String userId) Update date of last logon for the user
void	updateUser(SessionContext sc, java.lang.String userId, java.lang.String login, java.lang.String name, java.lang.String tel, java.lang.String email, java.lang.String prstatusId, java.lang.String managerId, java.lang.String timezone, java.lang.String locale, java.lang.String company, java.lang.String emailTypeId, java.lang.String taskId, java.util.Calendar expire, boolean active, boolean help, java.lang.Integer showTreeMode, boolean htmlEditor) Update properties of user

Methods inherited from class java.lang.Object

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

Constructor Detail

SecuredUserAdapterManager

public SecuredUserAdapterManager()

Method Detail

createUser

public java.lang.String createUser(SessionContext sc,
                                   java.lang.String parentId,
                                   java.lang.String login,
                                   java.lang.String name,
                                   java.lang.String prstatusId)
                            throws GranException

Create a user

Parameters:

sc - session context

parentId - parent user's id

login - login

name - name

prstatusId - user's status

Returns:

id of a new user

Throws:

GranException

deleteUser

public void deleteUser(SessionContext sc,
                       java.lang.String userId)
                throws GranException

Delete user

Parameters:

sc - session context

userId - user's id

Throws:

GranException

updateLastLogonDate

public void updateLastLogonDate(SessionContext sc,
                                java.lang.String userId)
                         throws GranException

Update date of last logon for the user

Parameters:

sc - session context

userId - user's id

Throws:

GranException

changePassword

public void changePassword(SessionContext sc,
                           java.lang.String userId,
                           java.lang.String password1,
                           java.lang.String password2)
                    throws GranException

Change password for the user

Parameters:

sc - session context

userId - user's id

password1 - password

password2 - confirmation of password

Throws:

GranException

updateUser

public void updateUser(SessionContext sc,
                       java.lang.String userId,
                       java.lang.String login,
                       java.lang.String name,
                       java.lang.String tel,
                       java.lang.String email,
                       java.lang.String prstatusId,
                       java.lang.String managerId,
                       java.lang.String timezone,
                       java.lang.String locale,
                       java.lang.String company,
                       java.lang.String emailTypeId,
                       java.lang.String taskId,
                       java.util.Calendar expire,
                       boolean active,
                       boolean help,
                       java.lang.Integer showTreeMode,
                       boolean htmlEditor)
                throws GranException

Update properties of user

Parameters:

sc - session context

userId - user's id

login - login

name - name

tel - telephone number

email - e-mail address

prstatusId - user's status

managerId - manager's id

timezone - time zone

locale - locale

company - company

emailTypeId - id of email template

taskId - task's id

expire - login expire date

active - is user active

help - if true, help will be shown for the user

showTreeMode - if true, navigate tree be shown for the user

htmlEditor - if true, html editor be shown for the user

Throws:

GranException

getPossibleManagerList

public java.util.ArrayList getPossibleManagerList(SessionContext sc,
                                                  java.lang.String userId)
                                           throws GranException

Get all possible managers

Parameters:

sc - session context

userId - user's id

Returns:

array of manager ids

Throws:

GranException

getUserList

public Slider getUserList(SessionContext sc,
                          java.lang.String managerId,
                          java.lang.String filterId,
                          int page,
                          boolean withUdf,
                          java.lang.String order)
                   throws GranException

Get filtered list of subordinates

Parameters:

sc - session context

managerId - manager's id

filterId - filter's id

page - number of values per page

withUdf - if true, custom fields values will be loaded

order - sorting order

Returns:

Slider object

Throws:

GranException

See Also:

Slider

getUserList

public Slider getUserList(SessionContext sc,
                          java.lang.String managerId,
                          UserFValue filter,
                          int page,
                          boolean withUdf,
                          java.lang.String order)
                   throws GranException

Get filtered list of subordinates

Parameters:

sc - session context

managerId - manager's id

filter - filter

page - number of values per page

withUdf - if true, custom fields values will be loaded

order - sorting order

Returns:

Slider object

Throws:

GranException

See Also:

Slider

getUserManagerChildren

public java.util.ArrayList getUserManagerChildren(SessionContext sc,
                                                  java.lang.String userId)
                                           throws GranException

Get subordinates for manager

Parameters:

sc - session context

userId - user's id

Returns:

array of SecuredUserBean

Throws:

GranException

See Also:

SecuredUserBean

getUserAndChildrenList

public java.util.ArrayList getUserAndChildrenList(SessionContext sc,
                                                  java.lang.String userId)
                                           throws GranException

Get user and subordinates

Parameters:

sc - session context

userId - user's id

Returns:

array of SecuredUserBean

Throws:

GranException

See Also:

SecuredUserBean

getUserListForNewAcl

public java.util.ArrayList getUserListForNewAcl(SessionContext sc,
                                                java.lang.String forUserId)
                                         throws GranException

Get user for just created access control rule

Parameters:

sc - session context

forUserId - user's id

Returns:

array of SecuredUserBean

Throws:

GranException

See Also:

SecuredUserBean

getChildren

public java.util.ArrayList getChildren(SessionContext sc,
                                       java.lang.String userId)
                                throws GranException

Get children

Parameters:

sc - session context

userId - user's id

Returns:

array of SecuredUserBean

Throws:

GranException

See Also:

SecuredUserBean

getUserChain

public java.util.LinkedList getUserChain(SessionContext sc,
                                         java.lang.String stopUserId)
                                  throws GranException

Get chain of users

Parameters:

sc - session context

stopUserId - list user's id

Returns:

linked list of user ids

Throws:

GranException

getUserChain

public java.util.LinkedList getUserChain(SessionContext sc,
                                         java.lang.String stopUserId,
                                         java.lang.String startUserId)
                                  throws GranException

Get chain of users

Parameters:

sc - session context

stopUserId - list user's id

startUserId - first user's id

Returns:

linked list of user ids

Throws:

GranException

authenticate

public java.lang.String authenticate(java.lang.String login,
                                     java.lang.String password)
                              throws GranException

Try to authenticate

Parameters:

login - login

password - password

Returns:

session context

Throws:

GranException

getUserId

public java.lang.String getUserId(SessionContext sc)
                           throws GranException

Get id of a current user

Parameters:

sc - session context

Returns:

id of a current user

Throws:

GranException

getUserExpireDate

public long getUserExpireDate(SessionContext sc,
                              java.lang.String userId)
                       throws GranException

Get expire date for the user

Parameters:

sc - session context

userId - user's id

Returns:

expire date

Throws:

GranException

setMaximumChildrenAllowed

public void setMaximumChildrenAllowed(SessionContext sc,
                                      java.lang.String userId,
                                      java.lang.Integer count)
                               throws GranException

Set number of maximum allowed children

Parameters:

sc - session context

userId - user's id

count - maximum allowed children count

Throws:

GranException

getActive

public boolean getActive(SessionContext sc,
                         java.lang.String userId)
                  throws GranException

Check is user active

Parameters:

sc - session context

userId - user's id

Returns:

true if user is active

Throws:

GranException

forgotPassword

public void forgotPassword(java.lang.String login,
                           java.lang.String email)
                    throws GranException

Send e-mail with forgotten password

Parameters:

login - login

email - e-mail

Throws:

GranException

isParentOf

public boolean isParentOf(SessionContext sc,
                          java.lang.String parentId,
                          java.lang.String userId)
                   throws GranException

Check if one user is parent of another

Parameters:

sc - session context

parentId - parent's id

userId - user's id

Returns:

true if yes

Throws:

GranException

findByLogin

public SecuredUserBean findByLogin(SessionContext sc,
                                   java.lang.String login)
                            throws GranException

Find user by ligin

Parameters:

sc - session context

login - login

Returns:

user (SecuredUserBean)

Throws:

GranException

See Also:

SecuredUserBean

findUserIdByQuickGo

public java.lang.String findUserIdByQuickGo(SessionContext sc,
                                            java.lang.String quickGo)
                                     throws GranException

Throws:

GranException

pasteUsers

public void pasteUsers(SessionContext sc,
                       java.lang.String parentId,
                       java.lang.String[] userIds)
                throws GranException

Paste users

Parameters:

sc - session context

parentId - id of a parent for pasted users

userIds - pasted user ids

Throws:

GranException