com.logicaldoc.gui.common.client.services

Interface SecurityService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

SecurityServiceImpl

@RemoteServiceRelativePath(value="security")
public interface SecurityService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the Security Service. This service gives all needed methods to handle user sessions.

Method Summary

Methods

Modifier and Type	Method and Description
void	addUserToGroup(String sid, long groupId, long userId) Adds a user to a group
void	applyRights(String sid, GUIMenu menu) Applies all security settings to menu
int	changePassword(long userId, String oldPassword, String newPassword, boolean notify) Changes the password of a user
void	deleteGroup(String sid, long groupId) Deletes a given group
void	deleteUser(String sid, long userId) Deletes a given user
GUIGroup	getGroup(String sid, long groupId) Loads a given group from the database
GUIMenu	getMenu(String sid, long id) Retrieves the specified menu
GUIUser	getUser(String sid, long userId) Loads a given user from the database
void	kill(String sid) Kill the session with the given sid.
GUISecuritySettings	loadSettings(String sid) Loads security settings
GUISession	login(String sid) Logs-in a user by an existing session ID (session reuse)
GUISession	login(String username, String password, String locale) Logs-in a user
void	logout(String sid) Logs out the current user
void	removeFromGroup(String sid, long groupId, long[] userIds) Removes users from a group
void	resetPassword(String username, String emailAddress, String productName) Reset the password for the given email.
GUIGroup	saveGroup(String sid, GUIGroup group) Creates or updates a group
GUIUser	saveProfile(String sid, GUIUser user) Saves the profile data only
void	saveSettings(String sid, GUISecuritySettings settings) Saves security settings
GUIUser	saveUser(String sid, GUIUser user, GUIInfo info) Creates or updates a user
GUIUser[]	searchUsers(String sid, String username, String groupId) Searches for users

Method Detail

login

GUISession login(String username,
               String password,
               String locale)

Logs-in a user

Parameters:

username -

password -

locale -

Returns:

The newly created session

login

GUISession login(String sid)

Logs-in a user by an existing session ID (session reuse)

changePassword

int changePassword(long userId,
                 String oldPassword,
                 String newPassword,
                 boolean notify)

Changes the password of a user

Parameters:

userId - The user Identifier

oldPassword - can be null

newPassword -

notify - If the new credentials need to be notified

Returns:

0 if all is ok, 1 if the password is incorrect, 2 if the new password cannot be notified, otherwise a positive number grater than 2

logout

void logout(String sid)

Logs out the current user

deleteUser

void deleteUser(String sid,
              long userId)
                throws InvalidSessionException

Deletes a given user

Throws:

InvalidSessionException

saveUser

GUIUser saveUser(String sid,
               GUIUser user,
               GUIInfo info)
                 throws InvalidSessionException

Creates or updates a user

Throws:

InvalidSessionException

saveProfile

GUIUser saveProfile(String sid,
                  GUIUser user)
                    throws InvalidSessionException

Saves the profile data only

Throws:

InvalidSessionException

getUser

GUIUser getUser(String sid,
              long userId)
                throws InvalidSessionException

Loads a given user from the database

Throws:

InvalidSessionException

getGroup

GUIGroup getGroup(String sid,
                long groupId)
                  throws InvalidSessionException

Loads a given group from the database

Throws:

InvalidSessionException

saveGroup

GUIGroup saveGroup(String sid,
                 GUIGroup group)
                   throws InvalidSessionException

Creates or updates a group

Throws:

InvalidSessionException

deleteGroup

void deleteGroup(String sid,
               long groupId)
                 throws InvalidSessionException

Deletes a given group

Throws:

InvalidSessionException

removeFromGroup

void removeFromGroup(String sid,
                   long groupId,
                   long[] userIds)
                     throws InvalidSessionException

Removes users from a group

Throws:

InvalidSessionException

addUserToGroup

void addUserToGroup(String sid,
                  long groupId,
                  long userId)
                    throws InvalidSessionException

Adds a user to a group

Throws:

InvalidSessionException

saveSettings

void saveSettings(String sid,
                GUISecuritySettings settings)
                  throws InvalidSessionException

Saves security settings

Throws:

InvalidSessionException

loadSettings

GUISecuritySettings loadSettings(String sid)
                                 throws InvalidSessionException

Loads security settings

Throws:

InvalidSessionException

kill

void kill(String sid)
          throws InvalidSessionException

Kill the session with the given sid.

Throws:

InvalidSessionException

applyRights

void applyRights(String sid,
               GUIMenu menu)
                 throws InvalidSessionException

Applies all security settings to menu

Throws:

InvalidSessionException

getMenu

GUIMenu getMenu(String sid,
              long id)
                throws InvalidSessionException

Retrieves the specified menu

Throws:

InvalidSessionException

resetPassword

void resetPassword(String username,
                 String emailAddress,
                 String productName)
                   throws Exception

Reset the password for the given email.

Parameters:

emailAddress - the username for which reset password

emailAddress - the email for which reset password

productName - the application product name

Throws:

Exception

searchUsers

GUIUser[] searchUsers(String sid,
                    String username,
                    String groupId)
                      throws InvalidSessionException

Searches for users

Parameters:

sid - The current session ID

username - The username used in the like operator (optional)

groupId - The group ID (optional)

Returns:

Array of found users

Throws:

InvalidSessionException