Package ch.ivyteam.ivy.security.synch

Class UserSynchResult

java.lang.Object
ch.ivyteam.ivy.security.synch.UserSynchResult
public final class UserSynchResult extends Object
Contains the result of a user synchronization. It provides the final synchronization status, statistics, error information and the updated user.
Since:
8.0.2
API:
This is a public API.

  • Method Details

    • getStatus

      public UserSynchResult.SynchStatus getStatus()
      Returns:
      The final synchronization status.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getSynchStatistics

      public UpdateEvent getSynchStatistics()
      Returns:
      The synchronization statistic
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getUser

      public IUser getUser()
      Returns:
      The synchronized user if found or null.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getError

      public Throwable getError()
      Returns:
      The last thrown exception in case of UserSynchResult.SynchStatus.ERROR or null.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getSynchLog

      public String getSynchLog()
      Returns:
      The synchronization log
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.