Package com.polarion.platform.jobs

Interface ISyncUsersJobUnit

All Superinterfaces:
IJobUnit
public interface ISyncUsersJobUnit extends IJobUnit
This job will synchronize Polarion users with LDAP based on the LDAP search filter set up in Polarion administration. Depending on the setup, users in Polarion may be created and/or edited. 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
    setConfigurationIds(String... configurationIds)
    Defines IDs of LDAP configurations from authentication.xml file, that should be synchronized
    All enabled configurations will be synchronized, if not set or argument is an empty array.
    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
    setUpdateUsers(boolean updateUsers)
    Defines whether fields of existing Users in Polarion can be automatically updated by data from LDAP in case of discrepancies.

    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.

    • setConfigurationIds

      void setConfigurationIds(@NotNull String... configurationIds)
      Defines IDs of LDAP configurations from authentication.xml file, that should be synchronized
      All enabled configurations will be synchronized, if not set or argument is an empty array.
      For more information about the authentication.xml file, see the "Authentication guide" section in Polarion's Help.
      Parameters:
      configurationIds - IDs of LDAP configurations.
      Since:
      3.21.1