Package com.illumon.iris.auth

Interface AuthHookModule

All Known Implementing Classes:
AuthHookModule.Null
public interface AuthHookModule
This interface allows you to run actions after useful authentication server operations; for example you may use an AuthHookModule to perform post-login refresh of ACL entries. Implementations must implement a Constructor which takes a Logger.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    AuthHookModule.Null
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    onLogin(UserContext userContext)
    Called after a client successfully logs in to the authentication server.
    void
    onLogout(UserContext userContext)
    Called after a client logs out from the authentication server (i.e.
    void
    onReload()
    Called after the authentication server configuration is reloaded.
    void
    onTokenCreate(UserContext authenticatedContext, String service)
    Called after an authentication token is created.
    void
    onTokenVerify(UserContext authenticatedContext, String service)
    Called after an authentication token is verified
    void
    onTokenVerifyFailure(UserContext authenticatedContext, String service)
    Called after an authentication token fails verification

  • Method Details

    • onLogin

      void onLogin(UserContext userContext)
      Called after a client successfully logs in to the authentication server.
      Parameters:
      userContext - the userContext of the login

    • onLogout

      void onLogout(UserContext userContext)
      Called after a client logs out from the authentication server (i.e. disconnects).
      Parameters:
      userContext - the userContext of the terminating connection

    • onTokenCreate

      void onTokenCreate(UserContext authenticatedContext, String service)
      Called after an authentication token is created.
      Parameters:
      authenticatedContext - the context of the user creating the token
      service - the service the user is creating a token for

    • onTokenVerify

      void onTokenVerify(UserContext authenticatedContext, String service)
      Called after an authentication token is verified
      Parameters:
      authenticatedContext - the context of the verified token
      service - the service for which the token is valid

    • onTokenVerifyFailure

      void onTokenVerifyFailure(UserContext authenticatedContext, String service)
      Called after an authentication token fails verification
      Parameters:
      authenticatedContext - the context of the verified token
      service - the service for which the token is valid

    • onReload

      void onReload()
      Called after the authentication server configuration is reloaded.