org.pac4j.core.engine

Class DefaultApplicationLogoutLogic<R,C extends WebContext>

java.lang.Object

org.pac4j.core.engine.DefaultApplicationLogoutLogic<R,C>

All Implemented Interfaces:

ApplicationLogoutLogic<R,C>

public class DefaultApplicationLogoutLogic<R,C extends WebContext>
extends Object
implements ApplicationLogoutLogic<R,C>

Default application logout logic:

After logout, the user is redirected to the url defined by the url request parameter if it matches the logoutUrlPattern. Or the user is redirected to the defaultUrl if it is defined. Otherwise, a blank page is displayed.

Since:

1.9.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
DefaultApplicationLogoutLogic()

Method Summary

Modifier and Type	Method and Description
protected ProfileManager	getProfileManager(C context) Given a webcontext generate a profileManager for it.
java.util.function.Function<C,ProfileManager>	getProfileManagerFactory()
boolean	isKillSession()
R	perform(C context, Config config, HttpActionAdapter<R,C> httpActionAdapter, String defaultUrl, String inputLogoutUrlPattern) Perform the application logout logic.
protected void	postLogout(C context) Specific post logout action.
void	setKillSession(boolean killSession)
void	setProfileManagerFactory(java.util.function.Function<C,ProfileManager> factory)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected org.slf4j.Logger logger

Constructor Detail

DefaultApplicationLogoutLogic

public DefaultApplicationLogoutLogic()

Method Detail

perform

public R perform(C context,
                 Config config,
                 HttpActionAdapter<R,C> httpActionAdapter,
                 String defaultUrl,
                 String inputLogoutUrlPattern)

Description copied from interface: ApplicationLogoutLogic

Perform the application logout logic.

Specified by:

perform in interface ApplicationLogoutLogic<R,C extends WebContext>

Parameters:

context - the web context

config - the security configuration

httpActionAdapter - the HTTP action adapter

defaultUrl - the default url

inputLogoutUrlPattern - the logout url pattern

Returns:

the resulting action for logout

postLogout

protected void postLogout(C context)

Specific post logout action.

Parameters:

context - the web context

getProfileManager

protected ProfileManager getProfileManager(C context)

Given a webcontext generate a profileManager for it. Can be overridden for custom profile manager implementations

Parameters:

context - the web context

Returns:

profile manager implementation built from the context

isKillSession

public boolean isKillSession()

setKillSession

public void setKillSession(boolean killSession)

getProfileManagerFactory

public java.util.function.Function<C,ProfileManager> getProfileManagerFactory()

setProfileManagerFactory

public void setProfileManagerFactory(java.util.function.Function<C,ProfileManager> factory)