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

Class StoreClientInformation

java.lang.Object

net.shibboleth.utilities.java.support.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.StoreClientInformation

All Implemented Interfaces:

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

public class StoreClientInformation
extends net.shibboleth.idp.profile.AbstractProfileAction

An action that stores the ClientInformation from the OIDCClientRegistrationResponseContext to the associated ClientInformationManager.

Field Summary

Fields

Modifier and Type	Field	Description
private net.shibboleth.oidc.metadata.ClientInformationManager	clientInformationManager	The client information manager used for storing the information.
private org.slf4j.Logger	log	Class logger.
private Function<MessageContext,OIDCClientRegistrationResponseContext>	oidcResponseContextLookupStrategy	Strategy used to locate the OIDCClientRegistrationResponseContext associated with a given MessageContext.
private Function<ProfileRequestContext,OIDCClientRegistrationTokenClaimsContext>	registrationTokenContextLookupStrategy	Strategy used to locate the OIDCClientRegistrationTokenClaimsContext associated with the request.
private OIDCClientRegistrationTokenClaimsContext	registrationTokenCtx	The OIDCClientRegistrationTokenClaimsContext from which to optionally obtain client ID.
private Function<ProfileRequestContext,Duration>	registrationValidityPeriodStrategy	Strategy to obtain registration validity period policy.
private com.nimbusds.openid.connect.sdk.rp.OIDCClientInformationResponse	response	The response message.

Constructor Summary

Constructors

Constructor	Description
StoreClientInformation()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
net.shibboleth.oidc.metadata.ClientInformationManager	getClientInformationManager()	Get the client information manager used for storing the information.
void	setClientInformationManager(net.shibboleth.oidc.metadata.ClientInformationManager manager)	Set the client information manager used for storing the information.
void	setOidcResponseContextLookupStrategy(Function<MessageContext,OIDCClientRegistrationResponseContext> strategy)	Set the strategy used to locate the OIDCClientRegistrationResponseContext associated with a given MessageContext.
void	setRegistrationTokenContextLookupStrategy(Function<ProfileRequestContext,OIDCClientRegistrationTokenClaimsContext> strategy)	Set the strategy used to locate the OIDCClientRegistrationTokenClaimsContext associated with a given request.
void	setRegistrationValidityPeriodStrategy(Function<ProfileRequestContext,Duration> strategy)	Set strategy function to obtain registration validity period.

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

doExecute, execute, getMessage, getMessage, getMessage, 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, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, 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.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

clientInformationManager

@Nullable
private net.shibboleth.oidc.metadata.ClientInformationManager clientInformationManager

The client information manager used for storing the information.

registrationValidityPeriodStrategy

@Nullable
private Function<ProfileRequestContext,Duration> registrationValidityPeriodStrategy

Strategy to obtain registration validity period policy.

registrationTokenContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCClientRegistrationTokenClaimsContext> registrationTokenContextLookupStrategy

Strategy used to locate the OIDCClientRegistrationTokenClaimsContext associated with the request.

registrationTokenCtx

@Nullable
private OIDCClientRegistrationTokenClaimsContext registrationTokenCtx

The OIDCClientRegistrationTokenClaimsContext from which to optionally obtain client ID.

response

@Nullable
private com.nimbusds.openid.connect.sdk.rp.OIDCClientInformationResponse response

The response message.

oidcResponseContextLookupStrategy

@Nonnull
private Function<MessageContext,OIDCClientRegistrationResponseContext> oidcResponseContextLookupStrategy

Strategy used to locate the OIDCClientRegistrationResponseContext associated with a given MessageContext.

Constructor Detail

StoreClientInformation

public StoreClientInformation()

Constructor.

Method Detail

setRegistrationValidityPeriodStrategy

public void setRegistrationValidityPeriodStrategy(@Nullable
                                                  Function<ProfileRequestContext,Duration> strategy)

Set strategy function to obtain registration validity period.

Parameters:

strategy - The strategy function.

getClientInformationManager

@NonnullAfterInit
public net.shibboleth.oidc.metadata.ClientInformationManager getClientInformationManager()

Get the client information manager used for storing the information.

Returns:

The client information manager used for storing the information

setClientInformationManager

public void setClientInformationManager(@Nonnull
                                        net.shibboleth.oidc.metadata.ClientInformationManager manager)

Set the client information manager used for storing the information.

Parameters:

manager - The client information manager used for storing the information.

setOidcResponseContextLookupStrategy

public void setOidcResponseContextLookupStrategy(@Nonnull
                                                 Function<MessageContext,OIDCClientRegistrationResponseContext> strategy)

Set the strategy used to locate the OIDCClientRegistrationResponseContext associated with a given MessageContext.

Parameters:

strategy - strategy used to locate the OIDCClientRegistrationResponseContext associated with a given MessageContext

setRegistrationTokenContextLookupStrategy

public void setRegistrationTokenContextLookupStrategy(@Nonnull
                                                      Function<ProfileRequestContext,OIDCClientRegistrationTokenClaimsContext> strategy)

Set the strategy used to locate the OIDCClientRegistrationTokenClaimsContext associated with a given request.

Parameters:

strategy - lookup strategy

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
                               ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
                         ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction