Package net.shibboleth.idp.plugin.oidc.op.logout.profile.impl

Class AbstractOIDCRpInitiatedLogoutAction

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.plugin.oidc.op.profile.impl.AbstractOIDCRequestAction<LogoutRequest>

net.shibboleth.idp.plugin.oidc.op.logout.profile.impl.AbstractOIDCRpInitiatedLogoutAction

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, org.springframework.beans.factory.Aware, org.springframework.context.MessageSource, org.springframework.context.MessageSourceAware, org.springframework.webflow.execution.Action

Direct Known Subclasses:

FormRpInitiatedLogoutResponse, PopulateRpInitiatedLogoutContext, ProcessRpInitiatedLogoutRequest, ValidateIdTokenHint, ValidatePostLogoutRedirectURI

public class AbstractOIDCRpInitiatedLogoutAction
extends AbstractOIDCRequestAction<LogoutRequest>

An abstract action for OIDC logout actions dealing with OIDC RP-initiated logout.

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	log	Class logger.
private OIDCMetadataContext	oidcMetadataContext	OIDC metadata context.
private Function<ProfileRequestContext,OIDCMetadataContext>	oidcMetadataCtxLookupStrategy	Strategy function to lookup the OIDCMetadataContext.
private Function<ProfileRequestContext,OIDCRpInitiatedLogoutContext>	oidcRpInitatedLogoutCtxLookupStrategy	Strategy function to lookup the OIDCRpInitiatedLogoutContext.
private OIDCRpInitiatedLogoutContext	rpInitiatedLogoutContext	RP-initiated OIDC logout context.

Constructor Summary

Constructors

Constructor	Description
AbstractOIDCRpInitiatedLogoutAction()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
LogoutRequest	getLogoutRequest()	Returns OIDC RP-initiated logout request.
OIDCMetadataContext	getMetadataContext()	Returns the OIDC Metadata context.
OIDCRpInitiatedLogoutContext	getRpInitiatedLogoutContext()	Get the RP-initiated OIDC logout context.
void	setOIDCMetadataContextLookupStrategy(Function<ProfileRequestContext,OIDCMetadataContext> strategy)	Set the mechanism to lookup the OIDCMetadataContext from the ProfileRequestContext.
void	setOIDCRpInitatedLogoutCtxLookupStrategy(Function<ProfileRequestContext,OIDCRpInitiatedLogoutContext> strategy)	Set the mechanism to lookup the OIDCRpInitiatedLogoutContext.

Methods inherited from class net.shibboleth.idp.plugin.oidc.op.profile.impl.AbstractOIDCRequestAction

getRequest

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doExecute, doPostExecute, doPostExecute, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, doInitialize, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Field Details

log

@Nonnull
private static final org.slf4j.Logger log

Class logger.

oidcMetadataCtxLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCMetadataContext> oidcMetadataCtxLookupStrategy

Strategy function to lookup the OIDCMetadataContext.

oidcRpInitatedLogoutCtxLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCRpInitiatedLogoutContext> oidcRpInitatedLogoutCtxLookupStrategy

Strategy function to lookup the OIDCRpInitiatedLogoutContext.

oidcMetadataContext

@Nullable
private OIDCMetadataContext oidcMetadataContext

OIDC metadata context.

rpInitiatedLogoutContext

@Nullable
private OIDCRpInitiatedLogoutContext rpInitiatedLogoutContext

RP-initiated OIDC logout context.

Constructor Details

AbstractOIDCRpInitiatedLogoutAction

public AbstractOIDCRpInitiatedLogoutAction()

Constructor.

Method Details

setOIDCRpInitatedLogoutCtxLookupStrategy

public void setOIDCRpInitatedLogoutCtxLookupStrategy(@Nonnull
 Function<ProfileRequestContext,OIDCRpInitiatedLogoutContext> strategy)

Set the mechanism to lookup the OIDCRpInitiatedLogoutContext.

Parameters:

strategy - What to set.

setOIDCMetadataContextLookupStrategy

public void setOIDCMetadataContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,OIDCMetadataContext> strategy)

Set the mechanism to lookup the OIDCMetadataContext from the ProfileRequestContext.

Parameters:

strategy - What to set.

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractOIDCRequestAction<LogoutRequest>

getMetadataContext

public OIDCMetadataContext getMetadataContext()

Returns the OIDC Metadata context.

Returns:

The OIDC Metadata context.

getRpInitiatedLogoutContext

@Nullable
public OIDCRpInitiatedLogoutContext getRpInitiatedLogoutContext()

Get the RP-initiated OIDC logout context.

Returns:

The RP-initiated OIDC logout context.

getLogoutRequest

public LogoutRequest getLogoutRequest()

Returns OIDC RP-initiated logout request.

Returns:

request