Package com.logicaldoc.gui.frontend.client.services

Interface LDAPService

All Superinterfaces:

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

@RemoteServiceRelativePath("ldap")
public interface LDAPService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the LdapService.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LDAPService.Instance

Method Summary

Modifier and Type	Method	Description
void	delete(long serverId)	Deletes the specified server
GUILDAPServer	get(long serverId)	Loads external authentication settings
GUIValue[]	importUsers(String[] usernames, long serverId)	Imports a selection of users
GUIUser[]	listUsers(String login, long serverId)	Search for users in the LDAP repository
void	reorder(Long[] serverIds)
GUILDAPServer	save(GUILDAPServer ldapServer)	Saves external authentication settings
boolean	testConnection(GUILDAPServer ldapServer)	Tests the connection

Method Detail

save

GUILDAPServer save(GUILDAPServer ldapServer)
            throws ServerException

Saves external authentication settings

Parameters:

ldapServer - the external authentication server

Returns:

the saved Saves external authentication settings

Throws:

ServerException - an error happened in the server application

testConnection

boolean testConnection(GUILDAPServer ldapServer)
                throws ServerException

Tests the connection

Parameters:

ldapServer - the external authentication server

Returns:

true if the external authentication server allowed the access

Throws:

ServerException - an error happened in the server application

get

GUILDAPServer get(long serverId)
           throws ServerException

Loads external authentication settings

Parameters:

serverId - identifier of the external authentication server

Returns:

the external authentication settings retrieved by the server application

Throws:

ServerException - an error happened in the server application

delete

void delete(long serverId)
     throws ServerException

Deletes the specified server

Parameters:

serverId - identifier of the authentication server

Throws:

ServerException - an error happened in the server application

reorder

void reorder(Long[] serverIds)
      throws ServerException

Throws:

ServerException

listUsers

GUIUser[] listUsers(String login,
                    long serverId)
             throws ServerException

Search for users in the LDAP repository

Parameters:

login - used with LIKE operator to restrict the search

serverId - identifier of the LDAP server to use

Returns:

the users that match the login

Throws:

ServerException - an error happened in the server application

importUsers

GUIValue[] importUsers(String[] usernames,
                       long serverId)
                throws ServerException

Imports a selection of users

Parameters:

usernames - the list of usernames to import

serverId - identifier of the server to use

Returns:

number of imports, updates, errors

Throws:

ServerException - an error happened in the server application