Package org.apache.jackrabbit.oak.spi.security.authentication.external.basic

Class DefaultSyncContext

java.lang.Object

org.apache.jackrabbit.oak.spi.security.authentication.external.basic.DefaultSyncContext

All Implemented Interfaces:

SyncContext

public class DefaultSyncContext
extends Object
implements SyncContext

Internal implementation of the sync context

Field Summary

Fields

Modifier and Type	Field	Description
static String	REP_EXTERNAL_ID	Name of the ExternalIdentity.getExternalId() property of a synchronized identity.
static String	REP_LAST_SYNCED	Name of the property that stores the time when an identity was synced.

Constructor Summary

Constructors

Constructor	Description
DefaultSyncContext(@NotNull DefaultSyncConfig config, @NotNull ExternalIdentityProvider idp, @NotNull UserManager userManager, @NotNull ValueFactory valueFactory)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this context and releases any resources bound to it.
static @Nullable DefaultSyncedIdentity	createSyncedIdentity(@Nullable Authorizable auth)	Creates a synced identity from the given authorizable.
static @Nullable ExternalIdentityRef	getIdentityRef(@Nullable Authorizable auth)	Retrieves the external identity ref from the authorizable
boolean	isForceGroupSync()	Defines if synchronization of groups always will perform, i.e.
boolean	isForceUserSync()	Defines if synchronization of users always will perform, i.e.
boolean	isKeepMissing()	Defines if synchronization keeps missing external identities on synchronization of authorizables.
static String	joinPaths(String... paths)	Deprecated. Since Oak 1.3.10.
@NotNull SyncContext	setForceGroupSync(boolean forceGroupSync)	See SyncContext.isForceGroupSync()
@NotNull SyncContext	setForceUserSync(boolean forceUserSync)	See SyncContext.isForceUserSync()
@NotNull SyncContext	setKeepMissing(boolean keepMissing)	See SyncContext.isKeepMissing()
@NotNull SyncResult	sync(@NotNull String id)	Synchronizes an authorizable with the corresponding external identity with the repository based on the respective configuration.
@NotNull SyncResult	sync(@NotNull ExternalIdentity identity)	Synchronizes an external identity with the repository based on the respective configuration.

Methods inherited from class java.lang.Object

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

Field Detail

REP_EXTERNAL_ID

public static final String REP_EXTERNAL_ID

Name of the ExternalIdentity.getExternalId() property of a synchronized identity.

See Also:

Constant Field Values

REP_LAST_SYNCED

public static final String REP_LAST_SYNCED

Name of the property that stores the time when an identity was synced.

See Also:

Constant Field Values

Constructor Detail

DefaultSyncContext

public DefaultSyncContext(@NotNull
                          @NotNull DefaultSyncConfig config,
                          @NotNull
                          @NotNull ExternalIdentityProvider idp,
                          @NotNull
                          @NotNull UserManager userManager,
                          @NotNull
                          @NotNull ValueFactory valueFactory)

Method Detail

createSyncedIdentity

@Nullable
public static @Nullable DefaultSyncedIdentity createSyncedIdentity(@Nullable
                                                                   @Nullable Authorizable auth)
                                                            throws RepositoryException

Creates a synced identity from the given authorizable.

Parameters:

auth - the authorizable

Returns:

the id

Throws:

RepositoryException - if an error occurs

getIdentityRef

@Nullable
public static @Nullable ExternalIdentityRef getIdentityRef(@Nullable
                                                           @Nullable Authorizable auth)
                                                    throws RepositoryException

Retrieves the external identity ref from the authorizable

Parameters:

auth - the authorizable

Returns:

the ref

Throws:

RepositoryException - if an error occurs

joinPaths

@Deprecated
public static String joinPaths(String... paths)

Deprecated.

Since Oak 1.3.10. Please use PathUtils.concatRelativePaths(String...) instead.

Robust relative path concatenation.

Parameters:

paths - relative paths

Returns:

the concatenated path

close

public void close()

Closes this context and releases any resources bound to it. Note that an implementation must not commit the Root passed during the creation call. This is the responsibility of the application.

Specified by:

close in interface SyncContext

isKeepMissing

public boolean isKeepMissing()

Defines if synchronization keeps missing external identities on synchronization of authorizables. Default is false.

Specified by:

isKeepMissing in interface SyncContext

Returns:

true if keep missing.

setKeepMissing

@NotNull
public @NotNull SyncContext setKeepMissing(boolean keepMissing)

See SyncContext.isKeepMissing()

Specified by:

setKeepMissing in interface SyncContext

isForceUserSync

public boolean isForceUserSync()

Defines if synchronization of users always will perform, i.e. ignores the last synced properties.

Specified by:

isForceUserSync in interface SyncContext

Returns:

true if forced syncing users

setForceUserSync

@NotNull
public @NotNull SyncContext setForceUserSync(boolean forceUserSync)

See SyncContext.isForceUserSync()

Specified by:

setForceUserSync in interface SyncContext

isForceGroupSync

public boolean isForceGroupSync()

Defines if synchronization of groups always will perform, i.e. ignores the last synced properties.

Specified by:

isForceGroupSync in interface SyncContext

Returns:

true if forced syncing groups

setForceGroupSync

@NotNull
public @NotNull SyncContext setForceGroupSync(boolean forceGroupSync)

Description copied from interface: SyncContext

See SyncContext.isForceGroupSync()

Specified by:

setForceGroupSync in interface SyncContext

sync

@NotNull
public @NotNull SyncResult sync(@NotNull
                                @NotNull ExternalIdentity identity)
                         throws SyncException

Synchronizes an external identity with the repository based on the respective configuration.

Specified by:

sync in interface SyncContext

Parameters:

identity - the identity to sync.

Returns:

the result of the operation

Throws:

SyncException - if an error occurs

sync

@NotNull
public @NotNull SyncResult sync(@NotNull
                                @NotNull String id)
                         throws SyncException

Synchronizes an authorizable with the corresponding external identity with the repository based on the respective configuration.

Specified by:

sync in interface SyncContext

Parameters:

id - the id of the authorizable

Returns:

the result of the operation

Throws:

SyncException - if an error occurs