Package jetbrains.buildServer.users.sync

Class SyncHelper

java.lang.Object

jetbrains.buildServer.users.sync.SyncHelper

public class SyncHelper
extends Object

Author:

Maxim.Manuylov Date: 21.11.2014

Constructor Summary

Constructors

Constructor	Description
SyncHelper(SynchronizerInfo info, ActiveSynchronizersProvider provider, SynchronizerOptions options, SynchronizerStatistics statistics, Logger logger)

Method Summary

Modifier and Type	Method	Description
void	addError(String message)
void	addError(String message, Throwable e)
SynchronizerInfo	getInfo()
static String	getOwnerName(PropertyHolder item)
String	preparePropertyUpdate(SPropertyHolder item, String currentLocalValue, String currentRemoteValue, String propertyKey, boolean forceUpdateIfNeverSyncedBefore)	Decides whether to update a value for a user/group and updates previous remote value if needed.
boolean	tryToClaimOwnership(SPropertyHolder item)

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncHelper

public SyncHelper(@NotNull
                  SynchronizerInfo info,
                  @NotNull
                  ActiveSynchronizersProvider provider,
                  @NotNull
                  SynchronizerOptions options,
                  @NotNull
                  SynchronizerStatistics statistics,
                  @NotNull
                  Logger logger)

Method Detail

tryToClaimOwnership

public boolean tryToClaimOwnership(@NotNull
                                   SPropertyHolder item)

getOwnerName

@Nullable
public static String getOwnerName(@NotNull
                                  PropertyHolder item)

preparePropertyUpdate

@Nullable
public String preparePropertyUpdate(@NotNull
                                    SPropertyHolder item,
                                    @Nullable
                                    String currentLocalValue,
                                    @Nullable
                                    String currentRemoteValue,
                                    @NotNull
                                    String propertyKey,
                                    boolean forceUpdateIfNeverSyncedBefore)

Decides whether to update a value for a user/group and updates previous remote value if needed.

Parameters:

item - the user or user group

currentLocalValue - current value

currentRemoteValue - remote value

propertyKey - the key

forceUpdateIfNeverSyncedBefore - if property value never synced before, force its update with remote value (useful for newly created objects)

Returns:

null if no property update is necessary or the new value to update the property to

getInfo

@NotNull
public SynchronizerInfo getInfo()

addError

public void addError(@NotNull
                     String message)

addError

public void addError(@Nullable
                     String message,
                     @Nullable
                     Throwable e)