| com.ivata.groupware.admin.security.server.SecurityServer
All known Subclasses: com.ivata.groupware.admin.security.server.TestSecurityServer, com.ivata.groupware.admin.security.server.PlainTextSecurityServer,
| SecurityServer | | public interface SecurityServer extends Serializable(Code) | |
Instances of this class define how we authenticate and add users to the local
system.
author:
Colin MacLeod
author:
colin.macleod@ivata.com |
| Method Summary | |
| void | addUser(SecuritySession securitySession, String userName, String fullName)
Add a new user to the system. | | boolean | checkPassword(SecuritySession securitySession, String userName, String password)
Check the password for a user is correct.
Parameters:
securitySession - Used to authenticate the current user.
Parameters:
userName - name of the user for whom to check the password.
Parameters:
password - the new password value to check against the system. | | String | getSystemUserName(SecuritySession securitySession, String userName)
| | String | getUserNameFromSystemUserName(SecuritySession securitySession, String systemUserName)
Refer to
com.ivata.groupware.admin.security.Security.getUserNameFromSystemUserName . | | boolean | isUser(SecuritySession securitySession, String userName)
Find out if a user name is used or not.
Parameters:
securitySession - Used to authenticate the current user.
Parameters:
userName - user to check
throws:
SystemException - if the user name cannot be checked for anyreason. | | SecuritySession | login(UserDO user, String password)
Login to an authentication server using the user name and password
provided. | | SecuritySession | loginGuest()
Login as a guest user to an authentication server. | | void | removeUser(SecuritySession securitySession, String userName)
| | void | setPassword(SecuritySession securitySession, String userName, String password)
Set the password for a user. |
| addUser | | void addUser(SecuritySession securitySession, String userName, String fullName) throws SystemException(Code) | | Add a new user to the system.
Parameters:
securitySession - Used to authenticate the current user.
Parameters:
userName - user name to add.
Parameters:
fullName - full name under which the user will be filed.
throws:
SystemException - if this user cannot be added. |
| checkPassword | | boolean checkPassword(SecuritySession securitySession, String userName, String password) throws SystemException(Code) | | Check the password for a user is correct.
Parameters:
securitySession - Used to authenticate the current user.
Parameters:
userName - name of the user for whom to check the password.
Parameters:
password - the new password value to check against the system. TODO
throws:
SystemException - if the password cannot be checked for anyreason. |
| isUser | | boolean isUser(SecuritySession securitySession, String userName) throws SystemException(Code) | | Find out if a user name is used or not.
Parameters:
securitySession - Used to authenticate the current user.
Parameters:
userName - user to check
throws:
SystemException - if the user name cannot be checked for anyreason. true if there is a user with the name given. |
| login | | SecuritySession login(UserDO user, String password) throws SystemException(Code) | | Login to an authentication server using the user name and password
provided.
Parameters:
user - user to login to the server.
Parameters:
password - used to login to the server valid session for this username password combination.
throws:
SystemException - if this user cannot be authenticated. |
| loginGuest | | SecuritySession loginGuest() throws SystemException(Code) | | Login as a guest user to an authentication server.
valid session for the guest user.
throws:
SystemException - if this user cannot be authenticated. |
| removeUser | | void removeUser(SecuritySession securitySession, String userName) throws SystemException(Code) | | Remove the user with the given name from the system.
Parameters:
securitySession - Used to authenticate the current user.
Parameters:
userName - name of the user to be removed.
throws:
SystemException - if this user cannot be removed. |
| setPassword | | void setPassword(SecuritySession securitySession, String userName, String password) throws SystemException(Code) | | Set the password for a user.
Parameters:
securitySession - Used to authenticate the current user.
Parameters:
userName - name of the user for whom to set the password.
Parameters:
password - the new password value to set.
throws:
SystemException - if the password cannot be set for anyreason. |
|
|