com.logicaldoc.webservice.security

Interface SecurityService

All Known Implementing Classes:

SecurityClient, SecurityServiceImpl

public interface SecurityService

Security Web Service definition interface

Since:

6.1

Author:

Matteo Caruso - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
int	changePassword(String sid, long userId, String oldPassword, String newPassword) Changes the password of a user
void	deleteGroup(String sid, long groupId) Deletes an existing group with the given identifier.
void	deleteUser(String sid, long userId) Deletes an existing user with the given identifier.
WSGroup	getGroup(String sid, long groupId) Gets group metadata of an existing group with the given identifier.
WSUser	getUser(String sid, long userId) Gets user metadata of an existing user with the given identifier.
WSUser	getUserByUsername(String sid, String username) Gets user metadata of an existing user with the given username.
WSGroup[]	listGroups(String sid) Gets group metadata of all existing groups.
WSUser[]	listUsers(String sid) Gets metadata of all existing users.
long	storeGroup(String sid, WSGroup group) Create/Update a group.
long	storeUser(String sid, WSUser user) Create/Update a user.

Method Detail

listUsers

WSUser[] listUsers(String sid)
                   throws Exception

Gets metadata of all existing users.

Parameters:

sid - Session identifier. Must be an administrator.

Returns:

A value object containing the users metadata.

Throws:

Exception

listGroups

WSGroup[] listGroups(String sid)
                     throws Exception

Gets group metadata of all existing groups.

Parameters:

sid - Session identifier. Must be an administrator.

Returns:

A value object containing the groups metadata.

Throws:

Exception

storeUser

long storeUser(String sid,
             WSUser user)
               throws Exception

Create/Update a user. You can completely customize the user through a value object containing the user's metadata. The current user must be an administrator.

Parameters:

sid - Session identifier. Must be an administrator.

user - Web service value object containing the user's metadata

Returns:

id of the created/updated user.

Throws:

Exception

storeGroup

long storeGroup(String sid,
              WSGroup group)
                throws Exception

Create/Update a group. You can completely customize the group through a value object containing the group's metadata.

Parameters:

sid - Session identifier. Must be an administrator.

group - Web service value object containing the group's metadata

Returns:

id of the created/updated group.

Throws:

Exception

deleteUser

void deleteUser(String sid,
              long userId)
                throws Exception

Deletes an existing user with the given identifier.

Parameters:

sid - Session identifier. Must be an administrator.

userId - The user id

Throws:

Exception

deleteGroup

void deleteGroup(String sid,
               long groupId)
                 throws Exception

Deletes an existing group with the given identifier.

Parameters:

sid - Session identifier. Must be an administrator.

groupId - The group id

Throws:

Exception

changePassword

int changePassword(String sid,
                 long userId,
                 String oldPassword,
                 String newPassword)
                   throws Exception

Changes the password of a user

Parameters:

userId - The user Identifier. Must be an administrator.

oldPassword - can be null

newPassword -

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

Throws:

Exception

getUser

WSUser getUser(String sid,
             long userId)
               throws Exception

Gets user metadata of an existing user with the given identifier.

Parameters:

sid - Session identifier

userId - The user id

Returns:

A value object containing the user's metadata.

Throws:

Exception

getUserByUsername

WSUser getUserByUsername(String sid,
                       String username)
                         throws Exception

Gets user metadata of an existing user with the given username.

Parameters:

sid - Session identifier

username - The user name

Returns:

A value object containing the user's metadata.

Throws:

Exception

getGroup

WSGroup getGroup(String sid,
               long groupId)
                 throws Exception

Gets group metadata of an existing group with the given identifier.

Parameters:

sid - Session identifier

groupId - The group id

Returns:

A value object containing the group's metadata.

Throws:

Exception