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

Interface LoginModuleMonitor

All Superinterfaces:

Monitor<LoginModuleMonitor>

All Known Implementing Classes:

LoginModuleMonitorImpl, LoginModuleStats

@ProviderType
public interface LoginModuleMonitor
extends Monitor<LoginModuleMonitor>

Field Summary

Fields

Modifier and Type	Field	Description
static LoginModuleMonitor	NOOP

Method Summary

Modifier and Type	Method	Description
default @NotNull Class<LoginModuleMonitor>	getMonitorClass()
default @NotNull Map<Object,Object>	getMonitorProperties()
void	loginError()	Event to be called in the case there is an error in the login chain.
default void	loginFailed(@NotNull LoginException loginException, @Nullable Credentials credentials)	Marks a failed login attempt for the given Credentials that resulted in the given LoginException.
default void	principalsCollected(long timeTakenNanos, int numberOfPrincipals)	Record the time taken to collect the given number of principals during the commit phase of a given LoginModule.

Field Detail

NOOP

static final LoginModuleMonitor NOOP

Method Detail

loginError

void loginError()

Event to be called in the case there is an error in the login chain. This is not covering failed logins, but actual operational errors that probably need to be investigated. Any triggered event should have a corresponding error logged to make this investigation possible.

See Also:

loginFailed(LoginException, Credentials)

loginFailed

default void loginFailed(@NotNull
                         @NotNull LoginException loginException,
                         @Nullable
                         @Nullable Credentials credentials)

Marks a failed login attempt for the given Credentials that resulted in the given LoginException.

Parameters:

loginException - The LoginException raised by the failed login attempt.

credentials - The credentials used for login.

principalsCollected

default void principalsCollected(long timeTakenNanos,
                                 int numberOfPrincipals)

Record the time taken to collect the given number of principals during the commit phase of a given LoginModule.

Parameters:

timeTakenNanos - The time in nanoseconds

numberOfPrincipals - The number of principals that were collected.

getMonitorClass

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

Specified by:

getMonitorClass in interface Monitor<LoginModuleMonitor>

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<LoginModuleMonitor>

Returns:

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