Package org.pac4j.core.engine

Class DefaultCallbackLogic

java.lang.Object

org.pac4j.core.engine.AbstractExceptionAwareLogic

org.pac4j.core.engine.DefaultCallbackLogic

All Implemented Interfaces:

CallbackLogic

public class DefaultCallbackLogic
extends AbstractExceptionAwareLogic
implements CallbackLogic

Default callback logic:

The credentials are extracted from the current request to fetch the user profile (from the identity provider) which is then saved in the web session. Finally, the user is redirected back to the originally requested url (or to the defaultUrl).

Since:

1.9.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
static final DefaultCallbackLogic	INSTANCE	Constant INSTANCE

Constructor Summary

Constructors

Constructor	Description
DefaultCallbackLogic()

Method Summary

Modifier and Type	Method	Description
Object	perform(Config config, String inputDefaultUrl, Boolean inputRenewSession, String defaultClient, FrameworkParameters parameters)	Perform the callback logic.
protected HttpAction	redirectToOriginallyRequestedUrl(CallContext ctx, String defaultUrl)	redirectToOriginallyRequestedUrl.
protected void	renewSession(CallContext ctx, Config config)	renewSession.
protected void	saveUserProfile(CallContext ctx, Config config, UserProfile profile, boolean saveProfileInSession, boolean multiProfile, boolean renewSession)	saveUserProfile.

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 DefaultCallbackLogic INSTANCE

Constant INSTANCE

Constructor Details

DefaultCallbackLogic

public DefaultCallbackLogic()

Method Details

perform

public Object perform(Config config,
 String inputDefaultUrl,
 Boolean inputRenewSession,
 String defaultClient,
 FrameworkParameters parameters)

Perform the callback logic.

Specified by:

perform in interface CallbackLogic

Parameters:

config - the security configuration

inputDefaultUrl - the default url

inputRenewSession - whether the session must be renewed

defaultClient - the default client

parameters - framework parameters

Returns:

the resulting action of the callback

saveUserProfile

protected void saveUserProfile(CallContext ctx,
 Config config,
 UserProfile profile,
 boolean saveProfileInSession,
 boolean multiProfile,
 boolean renewSession)

saveUserProfile.

Parameters:

ctx - a CallContext object

config - a Config object

profile - a UserProfile object

saveProfileInSession - a boolean

multiProfile - a boolean

renewSession - a boolean

renewSession

protected void renewSession(CallContext ctx,
 Config config)

renewSession.

Parameters:

ctx - a CallContext object

config - a Config object

redirectToOriginallyRequestedUrl

protected HttpAction redirectToOriginallyRequestedUrl(CallContext ctx,
 String defaultUrl)

redirectToOriginallyRequestedUrl.

Parameters:

ctx - a CallContext object

defaultUrl - a String object

Returns:

a HttpAction object