Package org.apache.jackrabbit.oak.security.user.monitor

Interface UserMonitor

All Superinterfaces:

Monitor<UserMonitor>

All Known Implementing Classes:

UserMonitorImpl

@ProviderType
public interface UserMonitor
extends Monitor<UserMonitor>

Field Summary

Fields

Modifier and Type	Field	Description
static UserMonitor	NOOP

Method Summary

Modifier and Type	Method	Description
default void	doneGetMembers(long timeTakenNanos, boolean declaredOnly)	Called to record the time it takes to compute the members of a group.
default void	doneMemberOf(long timeTakenNanos, boolean declaredOnly)	Called to record the time it takes to compute the group membership of a given user or group.
default void	doneUpdateMembers(long timeTakenNanos, long totalProcessed, long failed, boolean isRemove)	Called to record changes to members of a group.
default @NotNull Class<UserMonitor>	getMonitorClass()
default @NotNull Map<Object,Object>	getMonitorProperties()

Field Detail

NOOP

static final UserMonitor NOOP

Method Detail

doneGetMembers

default void doneGetMembers(long timeTakenNanos,
                            boolean declaredOnly)

Called to record the time it takes to compute the members of a group.

Parameters:

timeTakenNanos - The time in nanoseconds

declaredOnly - true if only declared members were retrieved; false if declared and inherited members were retrieved.

doneMemberOf

default void doneMemberOf(long timeTakenNanos,
                          boolean declaredOnly)

Called to record the time it takes to compute the group membership of a given user or group.

Parameters:

timeTakenNanos - The time in nanoseconds

declaredOnly - true if only declared membership was retrieved; false otherwise.

doneUpdateMembers

default void doneUpdateMembers(long timeTakenNanos,
                               long totalProcessed,
                               long failed,
                               boolean isRemove)

Called to record changes to members of a group.

Parameters:

timeTakenNanos - The time in nanoseconds

totalProcessed - The total number of processed members

failed - The number of unsuccessful updates (either members added or removed)

isRemove - true if members were being removed; false if added.

getMonitorClass

@NotNull
default @NotNull Class<UserMonitor> getMonitorClass()

Specified by:

getMonitorClass in interface Monitor<UserMonitor>

Returns:

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

getMonitorProperties

@NotNull
default @NotNull Map<Object,Object> getMonitorProperties()

Specified by:

getMonitorProperties in interface Monitor<UserMonitor>

Returns:

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