Package net.shibboleth.sp.oidc.profile.impl

Class ExchangeCodeForAccessToken

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.oidc.profile.impl.AbstractAuthorizationResponseAction
net.shibboleth.sp.oidc.profile.impl.AbstractHttpOAuthAction<com.nimbusds.oauth2.sdk.TokenResponse>
net.shibboleth.sp.oidc.profile.impl.ExchangeCodeForAccessToken
All Implemented Interfaces:
net.shibboleth.shared.component.Component, net.shibboleth.shared.component.DestructableComponent, net.shibboleth.shared.component.InitializableComponent, org.opensaml.profile.action.ProfileAction, Aware, MessageSource, MessageSourceAware, Action
public class ExchangeCodeForAccessToken extends AbstractHttpOAuthAction<com.nimbusds.oauth2.sdk.TokenResponse>
Action to exchange the authorization code in the authentication response for an OAuth access token which contains an OIDC id_token. Once obtained, adds the token to the AccessTokenResponseContext.
Event:
EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, OidcEventIds.INVALID_TOKEN
Postcondition:
Add the Access Token Response to the AccessTokenResponseContext.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final org.slf4j.Logger
    log
    Class logger.
    private Function<org.opensaml.profile.context.ProfileRequestContext,net.shibboleth.oidc.profile.context.AccessTokenResponseContext>
    tokenResponseContextLookupStrategy
    Strategy used to look up the AccessTokenResponseContext to set the parameters for.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExchangeCodeForAccessToken()
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
     
    void
    setTokenResponseContextLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,net.shibboleth.oidc.profile.context.AccessTokenResponseContext> strategy)
    Set the strategy used to look up a AccessTokenResponseContext.

    Methods inherited from class net.shibboleth.sp.oidc.profile.impl.AbstractHttpOAuthAction

    doInitialize, executeHttpRequest, getHttpRequestEncoderStrategy, getHttpResponseDecoderStrategy, handleRequest, setHttpClient, setHttpClientSecurityParameters, setHttpRequestEncoderStrategy, setHttpResponseDecoderStrategy

    Methods inherited from class net.shibboleth.sp.oidc.profile.impl.AbstractAuthorizationResponseAction

    doPreExecute, getAuthenticationResponse, getProviderMetadataContext, setProviderMetadataLookupStrategy

    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, 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 final org.slf4j.Logger log
      Class logger.

    • tokenResponseContextLookupStrategy

      @Nonnull private Function<org.opensaml.profile.context.ProfileRequestContext,net.shibboleth.oidc.profile.context.AccessTokenResponseContext> tokenResponseContextLookupStrategy
      Strategy used to look up the AccessTokenResponseContext to set the parameters for.

  • Constructor Details

    • ExchangeCodeForAccessToken

      public ExchangeCodeForAccessToken()
      Constructor.

  • Method Details

    • setTokenResponseContextLookupStrategy

      public void setTokenResponseContextLookupStrategy(@Nonnull Function<org.opensaml.profile.context.ProfileRequestContext,net.shibboleth.oidc.profile.context.AccessTokenResponseContext> strategy)
      Set the strategy used to look up a AccessTokenResponseContext.
      Parameters:
      strategy - lookup strategy

    • doExecute

      protected void doExecute(@Nonnull org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
      Overrides:
      doExecute in class org.opensaml.profile.action.AbstractProfileAction