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

Class AbstractAuthorizationResponseAction

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
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
Direct Known Subclasses:
AbstractHttpOAuthAction, ValidateOAuthAccessTokenResponse
public abstract class AbstractAuthorizationResponseAction extends net.shibboleth.idp.profile.AbstractProfileAction
Abstract class for actions based on the AuthenticationResponse located under the InOutOperationContext.getInboundMessageContext().

Also makes available the OpenID Provider metadata context.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private com.nimbusds.openid.connect.sdk.AuthenticationSuccessResponse
    authnResponse
    OIDC authentication response from upstream OP.
    private final org.slf4j.Logger
    log
    Class logger.
    private net.shibboleth.oidc.metadata.context.OIDCProviderMetadataContext
    providerMetadataContext
    OIDC Metadata context.
    private Function<org.opensaml.profile.context.ProfileRequestContext,net.shibboleth.oidc.metadata.context.OIDCProviderMetadataContext>
    providerMetadataLookupStrategy
    Lookup strategy to locate the OP metadata to use.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    AbstractAuthorizationResponseAction()
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    doPreExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
     
    protected com.nimbusds.openid.connect.sdk.AuthenticationSuccessResponse
    getAuthenticationResponse()
    Returns the authentication response from the upstream OP.
    protected net.shibboleth.oidc.metadata.context.OIDCProviderMetadataContext
    getProviderMetadataContext()
    Returns the OIDC provider metadata context.
    void
    setProviderMetadataLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,net.shibboleth.oidc.metadata.context.OIDCProviderMetadataContext> strategy)
    Set the lookup strategy to locate the OpenID providers metadata.

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

    • providerMetadataLookupStrategy

      @Nonnull private Function<org.opensaml.profile.context.ProfileRequestContext,net.shibboleth.oidc.metadata.context.OIDCProviderMetadataContext> providerMetadataLookupStrategy
      Lookup strategy to locate the OP metadata to use.

    • authnResponse

      @Nullable private com.nimbusds.openid.connect.sdk.AuthenticationSuccessResponse authnResponse
      OIDC authentication response from upstream OP.

    • providerMetadataContext

      @Nullable private net.shibboleth.oidc.metadata.context.OIDCProviderMetadataContext providerMetadataContext
      OIDC Metadata context.

  • Constructor Details

    • AbstractAuthorizationResponseAction

      protected AbstractAuthorizationResponseAction()
      Constructor.

  • Method Details

    • setProviderMetadataLookupStrategy

      public void setProviderMetadataLookupStrategy(@Nonnull Function<org.opensaml.profile.context.ProfileRequestContext,net.shibboleth.oidc.metadata.context.OIDCProviderMetadataContext> strategy)
      Set the lookup strategy to locate the OpenID providers metadata.
      Parameters:
      strategy - the strategy.

    • getAuthenticationResponse

      @Nullable protected com.nimbusds.openid.connect.sdk.AuthenticationSuccessResponse getAuthenticationResponse()
      Returns the authentication response from the upstream OP. Should never be null after doPreExecute(ProfileRequestContext) has been called.
      Returns:
      the authentication response.

    • getProviderMetadataContext

      @Nullable protected net.shibboleth.oidc.metadata.context.OIDCProviderMetadataContext getProviderMetadataContext()
      Returns the OIDC provider metadata context. Should never be null after doPreExecute(ProfileRequestContext) has been called.
      Returns:
      The provider metadata context.

    • doPreExecute

      protected boolean doPreExecute(@Nonnull org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
      Overrides:
      doPreExecute in class org.opensaml.profile.action.AbstractConditionalProfileAction