@ProviderType public interface LoginModuleMonitor extends Monitor<LoginModuleMonitor>
Modifier and Type | Field and Description |
---|---|
static LoginModuleMonitor |
NOOP |
Modifier and Type | Method and Description |
---|---|
default @NotNull java.lang.Class<LoginModuleMonitor> |
getMonitorClass() |
default @NotNull java.util.Map<java.lang.Object,java.lang.Object> |
getMonitorProperties() |
void |
loginError()
Event to be called in the case there is an error in the login chain.
|
default void |
loginFailed(@NotNull javax.security.auth.login.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 . |
static final LoginModuleMonitor NOOP
void loginError()
loginFailed(LoginException, Credentials)
default void loginFailed(@NotNull @NotNull javax.security.auth.login.LoginException loginException, @Nullable @Nullable Credentials credentials)
Credentials
that resulted in the given LoginException
.loginException
- The LoginException
raised by the failed login attempt.credentials
- The credentials used for login.default void principalsCollected(long timeTakenNanos, int numberOfPrincipals)
LoginModule
.timeTakenNanos
- The time in nanosecondsnumberOfPrincipals
- The number of principals that were collected.@NotNull default @NotNull java.lang.Class<LoginModuleMonitor> getMonitorClass()
getMonitorClass
in interface Monitor<LoginModuleMonitor>
Whiteboard.register(Class, Object, Map)
@NotNull default @NotNull java.util.Map<java.lang.Object,java.lang.Object> getMonitorProperties()
getMonitorProperties
in interface Monitor<LoginModuleMonitor>
Whiteboard.register(Class, Object, Map)
Copyright © 2012–2022 The Apache Software Foundation. All rights reserved.