Package com.xwiki.azureoauth.user.sync

Class EntraIDUsersSyncJobRequest

java.lang.Object
org.xwiki.job.AbstractRequest
com.xwiki.azureoauth.user.sync.EntraIDUsersSyncJobRequest
All Implemented Interfaces:
Serializable, org.xwiki.job.Request
@Unstable public class EntraIDUsersSyncJobRequest extends org.xwiki.job.AbstractRequest
Represents a request to start a EntraID users sync job.
Since:
2.1
Version:
$Id$
See Also:

  • Field Summary

    Fields inherited from interface org.xwiki.job.Request

    PROPERTY_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

  • Constructor Summary

    Constructors
    Constructor
    Description
    EntraIDUsersSyncJobRequest()
    Default constructor.
    EntraIDUsersSyncJobRequest(List<String> jobId, boolean disable, boolean remove)
    Creates a specific request for users sync job.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    shouldDisable()
     
    boolean
    shouldRemove()
     

    Methods inherited from class org.xwiki.job.AbstractRequest

    containsProperty, equals, getContext, getId, getProperties, getProperty, getProperty, getPropertyNames, hashCode, isInteractive, isRemote, isStatusLogIsolated, isStatusSerialized, isVerbose, removeProperty, setContext, setId, setId, setId, setInteractive, setProperty, setRemote, setStatusLogIsolated, setStatusSerialized, setVerbose

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • EntraIDUsersSyncJobRequest

      public EntraIDUsersSyncJobRequest()
      Default constructor.

    • EntraIDUsersSyncJobRequest

      public EntraIDUsersSyncJobRequest(List<String> jobId, boolean disable, boolean remove)
      Creates a specific request for users sync job.
      Parameters:
      jobId - the ID of the request.
      disable - true if the sync should also sync disabled users, or false otherwise
      remove - true if the sync should also sync removed users, or false otherwise

  • Method Details

    • shouldDisable

      public boolean shouldDisable()
      Returns:
      true if disabled users from Entra ID should be synced, or false otherwise.

    • shouldRemove

      public boolean shouldRemove()
      Returns:
      true if removed users from Entra ID should be synced, or false otherwise.