com.logicaldoc.webservice.security

Class SecurityClient

java.lang.Object

com.logicaldoc.webservice.AbstractClient<SecurityService>

com.logicaldoc.webservice.security.SecurityClient

All Implemented Interfaces:

SecurityService

public class SecurityClient
extends AbstractClient<SecurityService>
implements SecurityService

Security Web Service client.

Since:

6.1

Author:

Matteo Caruso - Logical Objects

Field Summary

Fields inherited from class com.logicaldoc.webservice.AbstractClient

client, endpoint

Constructor Summary

Constructors

Constructor and Description
SecurityClient(String endpoint)

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.

Methods inherited from class com.logicaldoc.webservice.AbstractClient

configureSSL, configureTimeout, initClient

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityClient

public SecurityClient(String endpoint)
               throws IOException

Throws:

IOException

Method Detail

listUsers

public WSUser[] listUsers(String sid)
                   throws Exception

Description copied from interface: SecurityService

Gets metadata of all existing users.

Specified by:

listUsers in interface SecurityService

Parameters:

sid - Session identifier. Must be an administrator.

Returns:

A value object containing the users metadata.

Throws:

Exception

listGroups

public WSGroup[] listGroups(String sid)
                     throws Exception

Description copied from interface: SecurityService

Gets group metadata of all existing groups.

Specified by:

listGroups in interface SecurityService

Parameters:

sid - Session identifier. Must be an administrator.

Returns:

A value object containing the groups metadata.

Throws:

Exception

storeUser

public long storeUser(String sid,
             WSUser user)
               throws Exception

Description copied from interface: SecurityService

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.

Specified by:

storeUser in interface SecurityService

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

public long storeGroup(String sid,
              WSGroup group)
                throws Exception

Description copied from interface: SecurityService

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

Specified by:

storeGroup in interface SecurityService

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

public void deleteUser(String sid,
              long userId)
                throws Exception

Description copied from interface: SecurityService

Deletes an existing user with the given identifier.

Specified by:

deleteUser in interface SecurityService

Parameters:

sid - Session identifier. Must be an administrator.

userId - The user id

Throws:

Exception

deleteGroup

public void deleteGroup(String sid,
               long groupId)
                 throws Exception

Description copied from interface: SecurityService

Deletes an existing group with the given identifier.

Specified by:

deleteGroup in interface SecurityService

Parameters:

sid - Session identifier. Must be an administrator.

groupId - The group id

Throws:

Exception

changePassword

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

Description copied from interface: SecurityService

Changes the password of a user

Specified by:

changePassword in interface SecurityService

userId - The user Identifier. Must be an administrator.

oldPassword - can be null

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

public WSUser getUser(String sid,
             long userId)
               throws Exception

Description copied from interface: SecurityService

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

Specified by:

getUser in interface SecurityService

Parameters:

sid - Session identifier

userId - The user id

Returns:

A value object containing the user's metadata.

Throws:

Exception

getUserByUsername

public WSUser getUserByUsername(String sid,
                       String username)
                         throws Exception

Description copied from interface: SecurityService

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

Specified by:

getUserByUsername in interface SecurityService

Parameters:

sid - Session identifier

username - The user name

Returns:

A value object containing the user's metadata.

Throws:

Exception

getGroup

public WSGroup getGroup(String sid,
               long groupId)
                 throws Exception

Description copied from interface: SecurityService

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

Specified by:

getGroup in interface SecurityService

Parameters:

sid - Session identifier

groupId - The group id

Returns:

A value object containing the group's metadata.

Throws:

Exception