OIDCAuthenticationRequest (Shibboleth IdP :: Plugins :: OIDC Common :: Profile Configuration API 2.1.0 API)

java.lang.Object
- net.shibboleth.oidc.profile.core.OAuthAuthorizationRequest
- - net.shibboleth.oidc.profile.core.OIDCAuthenticationRequest

```
public class OIDCAuthenticationRequest
extends OAuthAuthorizationRequest
```
OpenID Connect Authentication Request. Extends the OAuth 2.0 authorization request.
This class is mutable and not thread-safe.

Field Summary

Fields
Modifier and Type	Field	Description
`private static String`	`DEFAULT_OPENID_SCOPE`	The default OpenID scope.
`private com.nimbusds.jwt.JWT`	`requestObject`	The request object.
`private URI`	`requestURI`	The request URI.

Constructor Summary

Constructors
Constructor Description

OIDCAuthenticationRequest(com.nimbusds.oauth2.sdk.id.ClientID id)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`com.nimbusds.jwt.JWT`	`getRequestObject()`	Get the request object.
`URI`	`getRequestURI()`	Get the URI to fetch the request object from.
`void`	`setRequestObject(com.nimbusds.jwt.JWT object)`	Set the request object.
`void`	`setRequestURI(URI uri)`	Set the URI to fetch the request object from.

Methods inherited from class net.shibboleth.oidc.profile.core.OAuthAuthorizationRequest
getAcrs, getClientID, getDisplay, getEndpointURI, getMaxAge, getNonce, getPrompt, getRedirectURI, getResponseMode, getResponseType, getScope, getState, setAcrs, setDisplay, setEndpointURI, setMaxAge, setNonce, setPrompt, setRedirectURI, setResponseMode, setResponseType, setState

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_OPENID_SCOPE
```
@Nonnull
@NotEmpty
private static final String DEFAULT_OPENID_SCOPE
```
    The default OpenID scope.
    
    See Also:
    
    Constant Field Values
  - requestObject
```
@Nullable
private com.nimbusds.jwt.JWT requestObject
```
    The request object. Optional.
  - requestURI
```
@Nullable
private URI requestURI
```
    The request URI. Optional.
- Constructor Detail
  - OIDCAuthenticationRequest
```
public OIDCAuthenticationRequest(@Nonnull
                                 com.nimbusds.oauth2.sdk.id.ClientID id)
```
    Constructor.
    
    Parameters:
    
    id - the clientID.
- Method Detail
  - getRequestObject
```
@Nullable
public com.nimbusds.jwt.JWT getRequestObject()
```
    Get the request object.
    
    Returns:
    
    Returns the request object.
  - setRequestObject
```
public void setRequestObject(@Nullable
                             com.nimbusds.jwt.JWT object)
```
    Set the request object.
    
    Parameters:
    
    object - The request object to set.
  - getRequestURI
```
@Nullable
public URI getRequestURI()
```
    Get the URI to fetch the request object from.
    
    Returns:
    
    Returns the requestURI.
  - setRequestURI
```
public void setRequestURI(@Nullable
                          URI uri)
```
    Set the URI to fetch the request object from.
    
    Parameters:
    
    uri - The requestURI to set.