Package org.pac4j.core.engine

Interface LogoutLogic

  • All Known Implementing Classes:
    DefaultLogoutLogic
    Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    @FunctionalInterface
public interface LogoutLogic
    Logout logic for the application and the identity provider.
    Since:
    1.9.0
    Author:
    Jerome Leleu

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Object perform​(WebContext context, SessionStore sessionStore, Config config, HttpActionAdapter httpActionAdapter, java.lang.String defaultUrl, java.lang.String logoutUrlPattern, java.lang.Boolean localLogout, java.lang.Boolean destroySession, java.lang.Boolean centralLogout)
      Perform the application logout logic.

    • Method Detail

      • perform

        java.lang.Object perform​(WebContext context,
                         SessionStore sessionStore,
                         Config config,
                         HttpActionAdapter httpActionAdapter,
                         java.lang.String defaultUrl,
                         java.lang.String logoutUrlPattern,
                         java.lang.Boolean localLogout,
                         java.lang.Boolean destroySession,
                         java.lang.Boolean centralLogout)
        Perform the application logout logic.
        Parameters:
        context - the web context
        sessionStore - the session store
        config - the security configuration
        httpActionAdapter - the HTTP action adapter
        defaultUrl - the default url
        logoutUrlPattern - the logout url pattern
        localLogout - whether a local logout is required
        destroySession - whether the web session must be destroyed
        centralLogout - whether a central logout is required
        Returns:
        the resulting action for logout