Package org.apache.jackrabbit.oak.spi.security.authentication.external.impl.monitor

Interface ExternalIdentityMonitor

All Superinterfaces:

Monitor<ExternalIdentityMonitor>

All Known Implementing Classes:

ExternalIdentityMonitorImpl

public interface ExternalIdentityMonitor
extends Monitor<ExternalIdentityMonitor>

Field Summary

Fields

Modifier and Type	Field	Description
static ExternalIdentityMonitor	NOOP

Method Summary

Modifier and Type	Method	Description
default void	doneSyncExternalIdentity(long timeTakenNanos, @NotNull SyncResult result, int retryCount)	Mark the successful completion of SyncContext.sync(ExternalIdentity).
default void	doneSyncId(long timeTakenNanos, @NotNull SyncResult result)	Mark the successful completion of SyncContext.sync(String).
default @NotNull java.lang.Class<ExternalIdentityMonitor>	getMonitorClass()
default @NotNull java.util.Map<java.lang.Object,java.lang.Object>	getMonitorProperties()
default void	syncFailed(@NotNull SyncException syncException)	Mark the failure of a sync operation that resulted in the given SyncException.

Field Detail

NOOP

static final ExternalIdentityMonitor NOOP

Method Detail

doneSyncExternalIdentity

default void doneSyncExternalIdentity(long timeTakenNanos,
                                      @NotNull
                                      @NotNull SyncResult result,
                                      int retryCount)

Mark the successful completion of SyncContext.sync(ExternalIdentity).

Parameters:

timeTakenNanos - Time in nanoseconds spend to complete SyncContext.sync(ExternalIdentity)

result - The result of the sync operation.

retryCount - The number of retries needed to complete the sync.

doneSyncId

default void doneSyncId(long timeTakenNanos,
                        @NotNull
                        @NotNull SyncResult result)

Mark the successful completion of SyncContext.sync(String).

Parameters:

timeTakenNanos - Time in nanoseconds spend to complete SyncContext.sync(String)

result - The result of the sync operation.

syncFailed

default void syncFailed(@NotNull
                        @NotNull SyncException syncException)

Mark the failure of a sync operation that resulted in the given SyncException.

Parameters:

syncException - The sync exception.

getMonitorClass

@NotNull
default @NotNull java.lang.Class<ExternalIdentityMonitor> getMonitorClass()

Specified by:

getMonitorClass in interface Monitor<ExternalIdentityMonitor>

Returns:

The type to be passed to Whiteboard.register(Class, Object, Map)

getMonitorProperties

@NotNull
default @NotNull java.util.Map<java.lang.Object,java.lang.Object> getMonitorProperties()

Specified by:

getMonitorProperties in interface Monitor<ExternalIdentityMonitor>

Returns:

The properties to be passed to Whiteboard.register(Class, Object, Map)