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

Interface LoginModuleMonitor

All Superinterfaces:
org.apache.jackrabbit.oak.stats.Monitor<LoginModuleMonitor>
All Known Implementing Classes:
LoginModuleStats
@ProviderType public interface LoginModuleMonitor extends org.apache.jackrabbit.oak.stats.Monitor<LoginModuleMonitor>

  • Field Details

  • Method Details

    • 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

      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 org.apache.jackrabbit.oak.stats.Monitor<LoginModuleMonitor>

    • getMonitorProperties

      @NotNull default @NotNull Map<Object,Object> getMonitorProperties()
      Specified by:
      getMonitorProperties in interface org.apache.jackrabbit.oak.stats.Monitor<LoginModuleMonitor>