ILdapUsersSynchronization

All Superinterfaces:: ILdapSynchronization

All Known Subinterfaces:: ILdapUsersSynchronization.ITyped

public interface ILdapUsersSynchronization extends ILdapSynchronization

New API for synchronizing users from LDAP server. This should be used instead of ILDAPUserSynchronization.

Since:: 3.20.1

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

ILdapUsersSynchronization.ITyped

An extension interface to add builder pattern methods to ILdapUsersSynchronization
Method Summary

Modifier and Type

Method

Description

ILDAPUserSynchronization.ILDAPUserSynchronizationReport

synchronizeUsers()

Synchronizes users on the Polarion and LDAP servers.

boolean

updateUser(IUser user)

Updates the user object with information from LDAP server.

Methods inherited from interface com.polarion.alm.projects.ldap.ILdapSynchronization
isEnabled, setCreate, setUpdate

Method Details
- updateUser
  
  boolean updateUser(@NotNull IUser user) throws NamingException, IOException
  
  Updates the user object with information from LDAP server.
  Parameters:
  
  user -
  
  Returns:
  
  true if the user object was modified as a result of the call.
  
  Throws:
  
  IllegalStateException - if not enabled.
  
  NamingException
  
  IOException
  
  See Also:
  
  ILdapSynchronization.isEnabled()
- synchronizeUsers
  
  @NotNull ILDAPUserSynchronization.ILDAPUserSynchronizationReport synchronizeUsers()
  
  Synchronizes users on the Polarion and LDAP servers. Depends on fields set through the ILdapSynchronization.setCreate(boolean) and ILdapSynchronization.setUpdate(boolean) setter methods. The default values for these fields are both false (in which case, only synchronization state information is obtained).
  Returns:
  
  Returns report with synchronization results.
  
  Throws:
  
  IllegalStateException - if not enabled.
  
  See Also:
  
  ILdapSynchronization.isEnabled()