Package org.pac4j.core.engine

Class DefaultLogoutLogic

java.lang.Object

org.pac4j.core.engine.AbstractExceptionAwareLogic

org.pac4j.core.engine.DefaultLogoutLogic

All Implemented Interfaces:

LogoutLogic

public class DefaultLogoutLogic
extends AbstractExceptionAwareLogic
implements LogoutLogic

Default logout logic.

Since:

1.9.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static final LogoutLogic	INSTANCE	Constant INSTANCE

Constructor Summary

Constructors

Constructor	Description
DefaultLogoutLogic()

Method Summary

Modifier and Type	Method	Description
protected String	enhanceRedirectUrl(CallContext ctx, Config config, Client client, String redirectUrl)	enhanceRedirectUrl.
Object	perform(Config config, String defaultUrl, String inputLogoutUrlPattern, Boolean inputLocalLogout, Boolean inputDestroySession, Boolean inputCentralLogout, FrameworkParameters parameters)	Perform the application logout logic.

Methods inherited from class org.pac4j.core.engine.AbstractExceptionAwareLogic

buildContext, handleException, runtimeException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INSTANCE

public static final LogoutLogic INSTANCE

Constant INSTANCE

Constructor Details

DefaultLogoutLogic

public DefaultLogoutLogic()

Method Details

perform

public Object perform(Config config,
 String defaultUrl,
 String inputLogoutUrlPattern,
 Boolean inputLocalLogout,
 Boolean inputDestroySession,
 Boolean inputCentralLogout,
 FrameworkParameters parameters)

Perform the application logout logic.

Specified by:

perform in interface LogoutLogic

Parameters:

config - the security configuration

defaultUrl - the default url

inputLogoutUrlPattern - the logout url pattern

inputLocalLogout - whether a local logout is required

inputDestroySession - whether the web session must be destroyed

inputCentralLogout - whether a central logout is required

parameters - framework parameters

Returns:

the resulting action for logout

enhanceRedirectUrl

protected String enhanceRedirectUrl(CallContext ctx,
 Config config,
 Client client,
 String redirectUrl)

enhanceRedirectUrl.

Parameters:

ctx - a CallContext object

config - a Config object

client - a Client object

redirectUrl - a String object

Returns:

a String object