Package net.shibboleth.oidc.profile.messaging.handler.impl

Class AddStateHandler

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler

net.shibboleth.oidc.profile.messaging.handler.impl.AbstractAuthenticationRequestParameterValueMessageHandler<StateToken>

net.shibboleth.oidc.profile.messaging.handler.impl.AddStateHandler

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

public class AddStateHandler
extends AbstractAuthenticationRequestParameterValueMessageHandler<StateToken>

Add an OAuth 2.0 / OpenID Connect state value to the authentication request URL and the request object claims (if present).

The state parameter helps prevent cross-site request forgery (CSRF) attacks and can be used by clients to maintain request and response state.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Logger.
private static final String	STATE_CLAIM	The 'state' claim name.

Fields inherited from class net.shibboleth.oidc.profile.messaging.handler.impl.AbstractAuthenticationRequestParameterValueMessageHandler

PRC_LOOKUP

Constructor Summary

Constructors

Constructor	Description
AddStateHandler()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInvoke(MessageContext messageContext)

Methods inherited from class net.shibboleth.oidc.profile.messaging.handler.impl.AbstractAuthenticationRequestParameterValueMessageHandler

doPreInvoke, getAuthenticationRequest, getParameterValue, getProviderMetadata, setAuthenticationRequestLookupStrategy, setParameterValueLookupStrategy, setProviderMetadataLookupStrategy

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, isPreInvokeCalled, setActivationCondition

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

STATE_CLAIM

@Nonnull
private static final String STATE_CLAIM

The 'state' claim name.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Logger.

Constructor Details

AddStateHandler

public AddStateHandler()

Constructor.

Method Details

doInvoke

protected void doInvoke(@Nonnull
 MessageContext messageContext)
                 throws MessageHandlerException

Specified by:

doInvoke in class AbstractMessageHandler

Throws:

MessageHandlerException