ILdapUserGroupSynchronization

All Superinterfaces:: ILdapSynchronization

All Known Subinterfaces:: ILdapUserGroupSynchronization.ITyped

public interface ILdapUserGroupSynchronization extends ILdapSynchronization

Since:: 3.20.1

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

ILdapUserGroupSynchronization.ITyped

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

Modifier and Type

Method

Description

ILDAPUserSynchronization.ILDAPUserSynchronizationReport

synchronizeUserGroup(IUserGroup userGroup)

Synchronizes users in Polarion User Group from the LDAP server.

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

Method Details
- synchronizeUserGroup
  
  @NotNull ILDAPUserSynchronization.ILDAPUserSynchronizationReport synchronizeUserGroup(@NotNull IUserGroup userGroup)
  
  Synchronizes users in Polarion User Group from the LDAP server. 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).
  Parameters:
  
  userGroup - User Group to synchronize
  
  Returns:
  
  Returns report with synchronization results.
  
  Throws:
  
  IllegalStateException - if not enabled.
  
  See Also:
  
  ILdapSynchronization.isEnabled()