com.nimbusds.openid.connect.sdk
Class ResolvedOIDCAuthorizationRequest

java.lang.Object
  com.nimbusds.openid.connect.sdk.ResolvedOIDCAuthorizationRequest

@Immutable
public final class ResolvedOIDCAuthorizationRequest
extends Object

Resolved OpenID Connect authorisation request. This class is immutable.

Version:

$version$ (2013-01-21)

Author:

Vladimir Dzhuvinov

Constructor Summary

ResolvedOIDCAuthorizationRequest(ResponseTypeSet rts, ClientID clientID, URL redirectURI, Nonce nonce, State state, Display display, Prompt prompt, com.nimbusds.jwt.JWT idTokenHint, String loginHint, IDTokenClaimsRequest idTokenClaims, UserInfoClaimsRequest userInfoClaims)
Creates a new resolved OpenID Connect authorisation request.

Method Summary

ClientID	getClientID() Gets the client identifier.
Display	getDisplay() Gets the requested display type.
IDTokenClaimsRequest	getIDTokenClaimsRequest() Gets the resolved ID Token claims request.
com.nimbusds.jwt.JWT	getIDTokenHint() Gets the ID Token hint.
String	getLoginHint() Gets the login hint.
Nonce	getNonce() Gets the nonce.
Prompt	getPrompt() Gets the requested prompt.
URL	getRedirectURI() Gets the redirection URI.
ResponseTypeSet	getResponseTypeSet() Gets the response type set.
State	getState() Gets the state.
UserInfoClaimsRequest	getUserInfoClaimsRequest() Gets the resolved UserInfo claims request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResolvedOIDCAuthorizationRequest

public ResolvedOIDCAuthorizationRequest(ResponseTypeSet rts,
                                        ClientID clientID,
                                        URL redirectURI,
                                        Nonce nonce,
                                        State state,
                                        Display display,
                                        Prompt prompt,
                                        com.nimbusds.jwt.JWT idTokenHint,
                                        String loginHint,
                                        IDTokenClaimsRequest idTokenClaims,
                                        UserInfoClaimsRequest userInfoClaims)

Creates a new resolved OpenID Connect authorisation request.

Parameters:

rts - The response type set. Corresponds to the response_type parameter. Must not be null.

clientID - The client identifier. Corresponds to the client_id parameter. Must not be null.

redirectURI - The redirection URI. Corresponds to the redirect_uri parameter. Must not be null.

nonce - The nonce. Corresponds to the nonce parameter. May be null for code flow.

state - The state. Corresponds to the recommended state parameter. null if not specified.

display - The requested display type. Corresponds to the optional display parameter which has a default value. Must not be null.

prompt - The requested prompt. Corresponds to the optional prompt parameter. null if not specified.

idTokenHint - The ID Token hint. Corresponds to the optional id_token_hint parameter. null if not specified.

loginHint - The login hint. Corresponds to the optional login_hint parameter. null if not specified.

idTokenClaims - The resolved ID Token claims request. If null an ID Token is not requested.

userInfoClaims - The resolved UserInfo claims request. If null UserInfo is not requested.

Method Detail

getResponseTypeSet

public ResponseTypeSet getResponseTypeSet()

Gets the response type set. Corresponds to the response_type parameter.

Returns:

The response type set.

getClientID

public ClientID getClientID()

Gets the client identifier. Corresponds to the client_id parameter.

Returns:

The client identifier.

getRedirectURI

public URL getRedirectURI()

Gets the redirection URI. Corresponds to the redirection_uri parameter.

Returns:

The redirection URI.

getNonce

public Nonce getNonce()

Gets the nonce. Corresponds to the nonce parameter.

Returns:

The nonce, null if not specified.

getState

public State getState()

Gets the state. Corresponds to the recommended state parameter.

Returns:

The state, null if not specified.

getDisplay

public Display getDisplay()

Gets the requested display type. Corresponds to the optional display parameter which has a default value.

Returns:

The requested display type.

getPrompt

public Prompt getPrompt()

Gets the requested prompt. Corresponds to the optional prompt parameter.

Returns:

The requested prompt, null if not specified.

getIDTokenHint

public com.nimbusds.jwt.JWT getIDTokenHint()

Gets the ID Token hint. Corresponds to the id_token_hint parameter.

Returns:

The ID Token hint, null if not specified.

getLoginHint

public String getLoginHint()

Gets the login hint. Corresponds to the login_hint parameter.

Returns:

The login hint, null if not specified.

getIDTokenClaimsRequest

public IDTokenClaimsRequest getIDTokenClaimsRequest()

Gets the resolved ID Token claims request.

Returns:

The ID Token claims request, null if an ID Token is not requested.

getUserInfoClaimsRequest

public UserInfoClaimsRequest getUserInfoClaimsRequest()

Gets the resolved UserInfo claims request.

Returns:

The UserInfo claims request, null if UserInfo is not requested.