Package net.shibboleth.sp.profile.impl

Class RevokeSession

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.sp.profile.AbstractAgentRequestAction

net.shibboleth.sp.profile.AbstractAgentAction

net.shibboleth.sp.profile.AbstractApplicationAction

net.shibboleth.sp.profile.impl.AbstractRevocationAction

net.shibboleth.sp.profile.impl.RevokeSession

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class RevokeSession
extends AbstractRevocationAction

A profile action to optionally record the revocation of a session in a revocation cache and signal back an administrative logout result to the Agent.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX

Precondition:

AgentRequestContext.getOutput().isstruct()

Postcondition:

optionally a revocation record is stored

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,EventContext>	eventContextLookupStrategy	Strategy function for access to EventContext to check.
private DDF	input	Input message.
static final String	LIFETIME	Input member for revocation lifetime.
private final org.slf4j.Logger	log	Class logger.
private Duration	maxStorageLifetime	Upper bound on agent-supplied storage lifetime.
private DDF	output	Cached output object.
static final String	STATUS	Output "status" member.
static final int	STATUS_FAILED	Failed "status" value.
static final int	STATUS_PARTIAL	Partial "status" value.
static final int	STATUS_SUCCESS	Success "status" value.

Fields inherited from class net.shibboleth.sp.profile.impl.AbstractRevocationAction

SESSION_ID, STORAGE_CONTEXT

Constructor Summary

Constructors

Constructor	Description
RevokeSession()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
private boolean	doRevocation(ProfileRequestContext profileRequestContext)	Store a revocation record if configured to do so.
private Long	getStorageLifetime()	Get Agent-supplied storage lifetime in seconds, bounded by configured maximum.
void	setEventContextLookupStrategy(Function<ProfileRequestContext,EventContext> strategy)	Set lookup strategy for EventContext to base resulting status on.
void	setMaxStorageTimeout(Duration timeout)	Sets the maximum storage life for revocation records that an Agent may request.

Methods inherited from class net.shibboleth.sp.profile.impl.AbstractRevocationAction

getSessionID, getStorageContext, getStorageService, setStorageService

Methods inherited from class net.shibboleth.sp.profile.AbstractApplicationAction

ensureApplication, getApplication

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentAction

ensureAgent, getAgent

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentRequestAction

ensureAgentRequestContext, getAgentRequestContext, setAgentRequestContextLookupStrategy

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

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

LIFETIME

@Nonnull
@NotEmpty
public static final String LIFETIME

Input member for revocation lifetime.

See Also:

• Constant Field Values

STATUS

@Nonnull
@NotEmpty
public static final String STATUS

Output "status" member.

See Also:

• Constant Field Values

STATUS_SUCCESS

public static final int STATUS_SUCCESS

Success "status" value.

See Also:

• Constant Field Values

STATUS_PARTIAL

public static final int STATUS_PARTIAL

Partial "status" value.

See Also:

• Constant Field Values

STATUS_FAILED

public static final int STATUS_FAILED

Failed "status" value.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

eventContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,EventContext> eventContextLookupStrategy

Strategy function for access to EventContext to check.

maxStorageLifetime

@Nonnull
private Duration maxStorageLifetime

Upper bound on agent-supplied storage lifetime.

input

@NonnullBeforeExec
private DDF input

Input message.

output

@NonnullBeforeExec
private DDF output

Cached output object.

Constructor Details

RevokeSession

public RevokeSession()

Constructor.

Method Details

setEventContextLookupStrategy

public void setEventContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,EventContext> strategy)

Set lookup strategy for EventContext to base resulting status on.

Parameters:

strategy - lookup strategy

setMaxStorageTimeout

public void setMaxStorageTimeout(@Nonnull @Positive
 Duration timeout)

Sets the maximum storage life for revocation records that an Agent may request.

Defaults to 1 day.

Parameters:

timeout - maximum storage lifetime

doPreExecute

protected boolean doPreExecute(ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractRevocationAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

doRevocation

private boolean doRevocation(@Nonnull
 ProfileRequestContext profileRequestContext)

Store a revocation record if configured to do so.

Parameters:

profileRequestContext - profile request context

Returns:

true iff revocation succeeded or was not configured

getStorageLifetime

@Nonnull
private Long getStorageLifetime()

Get Agent-supplied storage lifetime in seconds, bounded by configured maximum.

Returns:

effective lifetime in seconds