org.pac4j.core.engine

Interface LogoutLogic<R,C extends WebContext>

All Known Implementing Classes:

DefaultLogoutLogic

public interface LogoutLogic<R,C extends WebContext>

Logout logic for the application and the identity provider.

Since:

1.9.0

Author:

Jerome Leleu

Method Summary

Modifier and Type	Method and Description
R	perform(C context, Config config, HttpActionAdapter<R,C> 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

R perform(C context,
          Config config,
          HttpActionAdapter<R,C> 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

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