Interface LogoutAware

All Known Implementing Classes:
AbstractAuthenticator, AbstractLdapRealm, ActiveDirectoryRealm, AuthenticatingRealm, AuthorizingRealm, CachingRealm, DefaultLdapRealm, IniRealm, JdbcRealm, JndiLdapRealm, ModularRealmAuthenticator, PropertiesRealm, SimpleAccountRealm, TextConfigurationRealm

public interface LogoutAware
An SPI interface allowing cleanup logic to be executed during logout of a previously authenticated Subject/user.

As it is an SPI interface, it is really intended for SPI implementers such as those implementing Realms.

All of Shiro's concrete Realm implementations implement this interface as a convenience for those wishing to subclass them.

Since:
0.9
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Callback triggered when a Subject logs out of the system.
  • Method Details

    • onLogout

      void onLogout(PrincipalCollection principals)
      Callback triggered when a Subject logs out of the system.
      Parameters:
      principals - the identifying principals of the Subject logging out.