Package net.shibboleth.oidc.profile.core

Class OAuthAuthorizationRequest

java.lang.Object
net.shibboleth.oidc.profile.core.OAuthAuthorizationRequest
Direct Known Subclasses:
OIDCAuthenticationRequest
public class OAuthAuthorizationRequest extends Object
An OAuth 2.0 authorization request.

This class is mutable and not thread-safe.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final com.nimbusds.oauth2.sdk.id.ClientID
    clientID
    The client identifier.
    private com.nimbusds.oauth2.sdk.ResponseMode
    defaultResponseMode
    The default response mode for the given response_type.
    private URI
    endpointURI
    The request endpoint.
    private URI
    redirectURI
    The redirect URI to which the response will be sent.
    private com.nimbusds.oauth2.sdk.ResponseMode
    responseMode
    The response mode.
    private com.nimbusds.oauth2.sdk.ResponseType
    responseType
    The authorization processing flow to use.
    private final com.nimbusds.oauth2.sdk.Scope
    scope
    The requested scopes.
    private com.nimbusds.oauth2.sdk.id.State
    state
    The state.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OAuthAuthorizationRequest(com.nimbusds.oauth2.sdk.id.ClientID id)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.nimbusds.oauth2.sdk.id.ClientID
    getClientID()
    Get the client ID.
    com.nimbusds.oauth2.sdk.ResponseMode
    getDefaultResponseMode()
    Get the response_mode to use with this authentication request.
    URI
    getEndpointURI()
    Get the endpoint_uri.
    URI
    getRedirectURI()
    Get the redirect_uri.
    com.nimbusds.oauth2.sdk.ResponseMode
    getResponseMode()
    Get the response mode.
    com.nimbusds.oauth2.sdk.ResponseType
    getResponseType()
    Get the response type.
    com.nimbusds.oauth2.sdk.Scope
    getScope()
    Get the scope.
    com.nimbusds.oauth2.sdk.id.State
    getState()
    Get the state.
    void
    setDefaultResponseMode(com.nimbusds.oauth2.sdk.ResponseMode mode)
    Set the default response_mode for the given response_type.
    void
    setEndpointURI(URI uri)
    Set the endpoint_uri.
    void
    setRedirectURI(URI uri)
    Set the redirect_uri.
    void
    setResponseMode(com.nimbusds.oauth2.sdk.ResponseMode mode)
    Set the response mode to be used with the ongoing authentication request.
    void
    setResponseType(com.nimbusds.oauth2.sdk.ResponseType type)
    Set the response type.
    void
    setState(com.nimbusds.oauth2.sdk.id.State theState)
    Set the state.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • clientID

      @Nonnull private final com.nimbusds.oauth2.sdk.id.ClientID clientID
      The client identifier. Required.

    • state

      @Nullable private com.nimbusds.oauth2.sdk.id.State state
      The state.

    • redirectURI

      @Nullable private URI redirectURI
      The redirect URI to which the response will be sent.

    • responseType

      @Nullable private com.nimbusds.oauth2.sdk.ResponseType responseType
      The authorization processing flow to use.

    • endpointURI

      @Nullable private URI endpointURI
      The request endpoint.

    • scope

      @Nonnull private final com.nimbusds.oauth2.sdk.Scope scope
      The requested scopes.

    • responseMode

      @Nullable private com.nimbusds.oauth2.sdk.ResponseMode responseMode
      The response mode. Optional.

    • defaultResponseMode

      @Nullable private com.nimbusds.oauth2.sdk.ResponseMode defaultResponseMode
      The default response mode for the given response_type. Can be used to determine if the response_mode should be included in an authentication request.

  • Constructor Details

    • OAuthAuthorizationRequest

      public OAuthAuthorizationRequest(@Nonnull com.nimbusds.oauth2.sdk.id.ClientID id)
      Constructor.
      Parameters:
      id - the clientID. Never null.

  • Method Details

    • setDefaultResponseMode

      public void setDefaultResponseMode(@Nullable com.nimbusds.oauth2.sdk.ResponseMode mode)
      Set the default response_mode for the given response_type.
      Parameters:
      mode - the default response_mode for the given response_type
      Since:
      2.2.0

    • getDefaultResponseMode

      @Nullable public com.nimbusds.oauth2.sdk.ResponseMode getDefaultResponseMode()
      Get the response_mode to use with this authentication request.
      Returns:
      the default response_mode
      Since:
      2.2.0

    • getClientID

      @Nonnull public com.nimbusds.oauth2.sdk.id.ClientID getClientID()
      Get the client ID.
      Returns:
      the clientID.

    • getState

      @Nullable public com.nimbusds.oauth2.sdk.id.State getState()
      Get the state.
      Returns:
      the state.

    • setState

      public void setState(@Nullable com.nimbusds.oauth2.sdk.id.State theState)
      Set the state. Optional.
      Parameters:
      theState - The state to set.

    • getRedirectURI

      @Nullable public URI getRedirectURI()
      Get the redirect_uri.
      Returns:
      the redirectURI.

    • setRedirectURI

      public void setRedirectURI(@Nonnull URI uri)
      Set the redirect_uri.
      Parameters:
      uri - The redirect_uri to set.

    • getResponseType

      @Nullable public com.nimbusds.oauth2.sdk.ResponseType getResponseType()
      Get the response type.
      Returns:
      the responseType.

    • setResponseType

      public void setResponseType(@Nonnull com.nimbusds.oauth2.sdk.ResponseType type)
      Set the response type.
      Parameters:
      type - The responseType to set.

    • getEndpointURI

      @Nullable public URI getEndpointURI()
      Get the endpoint_uri.
      Returns:
      the endpoint_uri.

    • setEndpointURI

      public void setEndpointURI(@Nonnull URI uri)
      Set the endpoint_uri.
      Parameters:
      uri - The endpointURI to set.

    • getScope

      @Nonnull public com.nimbusds.oauth2.sdk.Scope getScope()
      Get the scope.
      Returns:
      the scope.

    • getResponseMode

      @Nullable public com.nimbusds.oauth2.sdk.ResponseMode getResponseMode()
      Get the response mode.
      Returns:
      the responseMode.

    • setResponseMode

      public void setResponseMode(@Nullable com.nimbusds.oauth2.sdk.ResponseMode mode)
      Set the response mode to be used with the ongoing authentication request. This can be null if the default response_mode is to be used by the OP.
      Parameters:
      mode - the response mode. null if default mode is to be used.