Package com.polarion.platform.jobs

Interface ISyncUserGroupsJobUnit

All Superinterfaces:
IJobUnit
public interface ISyncUserGroupsJobUnit extends IJobUnit
This job will synchronize Polarion users, belonging to specific User Groups, with LDAP based on the LDAP search filter set up in the respective User Groups. Depending on the setup, users in Polarion may be created, edited and added to matching User Groups. Users in LDAP will not be affected.
Since:
3.20.1

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    JOB_NAME
     

    Fields inherited from interface com.polarion.platform.jobs.IJobUnit

    UNKNOWN_WORK_LENGTH

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    setConfigurationId(String configurationId)
    Defines ID of LDAP configuration from authentication.xml file, that should be synchronized
    If not set, the configuration with syncUserGroups = true attribute will be synchronized
    For more information about the authentication.xml file, see the "Authentication guide" section in Polarion's Help.
    void
    setCreateUsers(boolean createUsers)
    Defines whether new Users can be automatically created in Polarion if they are found in LDAP, but not in Polarion.
    void
    setUpdateAllUserGroups(boolean updateAllUserGroups)
    If set to "true", the job will synchronize all User Group users with LDAP.
    void
    setUpdateUsers(boolean updateUsers)
    Defines whether fields of existing Users in Polarion can be automatically updated by data from LDAP in case of discrepancies.
    void
    setUserGroupIds(String... userGroupIds)
    Sets up a specific group of User Groups for user synchronization with LDAP.

    Methods inherited from interface com.polarion.platform.jobs.IJobUnit

    activate, getCreator, getJob, getLogger, getName, getPriority, getScope, getWorkLength, run, setJob, setLogger, setScope, setWorkDir

  • Field Details

  • Method Details

    • setCreateUsers

      void setCreateUsers(boolean createUsers)
      Defines whether new Users can be automatically created in Polarion if they are found in LDAP, but not in Polarion.
      Parameters:
      createUsers - By default it behaves as if it was set to false.

    • setUpdateUsers

      void setUpdateUsers(boolean updateUsers)
      Defines whether fields of existing Users in Polarion can be automatically updated by data from LDAP in case of discrepancies.
      Parameters:
      updateUsers - By default it behaves as if it was set to false.

    • setUpdateAllUserGroups

      void setUpdateAllUserGroups(boolean updateAllUserGroups)
      If set to "true", the job will synchronize all User Group users with LDAP.

      Note: Any setup done by calling setUserGroupIds(String...) will be disregarded.

      Parameters:
      updateAllUserGroups - By default it behaves as if it was set to false.

    • setUserGroupIds

      void setUserGroupIds(@NotNull String... userGroupIds)
      Sets up a specific group of User Groups for user synchronization with LDAP. Other User Groups will be ignored.

      Note: If setUpdateAllUserGroups(boolean) is set to "true", all User Groups will be synchronized disregarding any selection done by calling this method.

      Parameters:
      userGroupIds - Array of User Group IDs, that will be synchronized with LDAP.

    • setConfigurationId

      void setConfigurationId(@NotNull String configurationId)
      Defines ID of LDAP configuration from authentication.xml file, that should be synchronized
      If not set, the configuration with syncUserGroups = true attribute will be synchronized
      For more information about the authentication.xml file, see the "Authentication guide" section in Polarion's Help.
      Parameters:
      configurationId - ID of LDAP configuration.
      Since:
      3.21.1