com.nimbusds.openid.connect.sdk

Class AuthenticationRequest.Builder

java.lang.Object

com.nimbusds.openid.connect.sdk.AuthenticationRequest.Builder

Enclosing class:

AuthenticationRequest

public static class AuthenticationRequest.Builder
extends Object

Builder for constructing OpenID Connect authentication requests.

Constructor Summary

Constructors

Constructor and Description
Builder(ResponseType rt, Scope scope, ClientID clientID, URI redirectURI) Creates a new OpenID Connect authentication request builder.

Method Summary

Modifier and Type	Method and Description
AuthenticationRequest.Builder	acrValues(List<ACR> acrValues) Sets the requested Authentication Context Class Reference values.
AuthenticationRequest	build() Builds a new authentication request.
AuthenticationRequest.Builder	claims(ClaimsRequest claims) Sets the individual claims to be returned.
AuthenticationRequest.Builder	claimsLocales(List<com.nimbusds.langtag.LangTag> claimsLocales) Sets the end-user's preferred languages and scripts for the claims being returned, ordered by preference.
AuthenticationRequest.Builder	codeChallenge(CodeChallenge codeChallenge, CodeChallengeMethod codeChallengeMethod) Deprecated.
AuthenticationRequest.Builder	codeChallenge(CodeVerifier codeVerifier, CodeChallengeMethod codeChallengeMethod) Sets the code challenge for Proof Key for Code Exchange (PKCE) by public OAuth clients.
AuthenticationRequest.Builder	customParameter(String name, String value) Sets the specified additional custom parameter.
AuthenticationRequest.Builder	display(Display display) Sets the requested display type.
AuthenticationRequest.Builder	endpointURI(URI uri) Sets the URI of the endpoint (HTTP or HTTPS) for which the request is intended.
AuthenticationRequest.Builder	idTokenHint(com.nimbusds.jwt.JWT idTokenHint) Sets the ID Token hint.
AuthenticationRequest.Builder	loginHint(String loginHint) Sets the login hint.
AuthenticationRequest.Builder	maxAge(int maxAge) Sets the required maximum authentication age.
AuthenticationRequest.Builder	nonce(Nonce nonce) Sets the nonce.
AuthenticationRequest.Builder	prompt(Prompt prompt) Sets the requested prompt.
AuthenticationRequest.Builder	requestObject(com.nimbusds.jwt.JWT requestObject) Sets the request object.
AuthenticationRequest.Builder	requestURI(URI requestURI) Sets the request object URI.
AuthenticationRequest.Builder	responseMode(ResponseMode rm) Sets the response mode.
AuthenticationRequest.Builder	state(State state) Sets the state.
AuthenticationRequest.Builder	uiLocales(List<com.nimbusds.langtag.LangTag> uiLocales) Sets the end-user's preferred languages and scripts for the user interface, ordered by preference.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(ResponseType rt,
               Scope scope,
               ClientID clientID,
               URI redirectURI)

Creates a new OpenID Connect authentication request builder.

Parameters:

rt - The response type. Corresponds to the response_type parameter. Must specify a valid OpenID Connect response type. Must not be null.

scope - The request scope. Corresponds to the scope parameter. Must contain an openid value. 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 unless set by means of the optional request_object / request_uri parameter.

Method Detail

state

public AuthenticationRequest.Builder state(State state)

Sets the state. Corresponds to the recommended state parameter.

Parameters:

state - The state, null if not specified.

Returns:

This builder.

endpointURI

public AuthenticationRequest.Builder endpointURI(URI uri)

Sets the URI of the endpoint (HTTP or HTTPS) for which the request is intended.

Parameters:

uri - The endpoint URI, null if not specified.

Returns:

This builder.

nonce

public AuthenticationRequest.Builder nonce(Nonce nonce)

Sets the nonce. Corresponds to the conditionally optional nonce parameter.

Parameters:

nonce - The nonce, null if not specified.

display

public AuthenticationRequest.Builder display(Display display)

Sets the requested display type. Corresponds to the optional display parameter.

Parameters:

display - The requested display type, null if not specified.

prompt

public AuthenticationRequest.Builder prompt(Prompt prompt)

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

Parameters:

prompt - The requested prompt, null if not specified.

maxAge

public AuthenticationRequest.Builder maxAge(int maxAge)

Sets the required maximum authentication age. Corresponds to the optional max_age parameter.

Parameters:

maxAge - The maximum authentication age, in seconds; 0 if not specified.

uiLocales

public AuthenticationRequest.Builder uiLocales(List<com.nimbusds.langtag.LangTag> uiLocales)

Sets the end-user's preferred languages and scripts for the user interface, ordered by preference. Corresponds to the optional ui_locales parameter.

Parameters:

uiLocales - The preferred UI locales, null if not specified.

claimsLocales

public AuthenticationRequest.Builder claimsLocales(List<com.nimbusds.langtag.LangTag> claimsLocales)

Sets the end-user's preferred languages and scripts for the claims being returned, ordered by preference. Corresponds to the optional claims_locales parameter.

Parameters:

claimsLocales - The preferred claims locales, null if not specified.

idTokenHint

public AuthenticationRequest.Builder idTokenHint(com.nimbusds.jwt.JWT idTokenHint)

Sets the ID Token hint. Corresponds to the conditionally optional id_token_hint parameter.

Parameters:

idTokenHint - The ID Token hint, null if not specified.

loginHint

public AuthenticationRequest.Builder loginHint(String loginHint)

Sets the login hint. Corresponds to the optional login_hint parameter.

Parameters:

loginHint - The login hint, null if not specified.

acrValues

public AuthenticationRequest.Builder acrValues(List<ACR> acrValues)

Sets the requested Authentication Context Class Reference values. Corresponds to the optional acr_values parameter.

Parameters:

acrValues - The requested ACR values, null if not specified.

claims

public AuthenticationRequest.Builder claims(ClaimsRequest claims)

Sets the individual claims to be returned. Corresponds to the optional claims parameter.

Parameters:

claims - The individual claims to be returned, null if not specified.

requestObject

public AuthenticationRequest.Builder requestObject(com.nimbusds.jwt.JWT requestObject)

Sets the request object. Corresponds to the optional request parameter. Must not be specified together with a request object URI.

Returns:

The request object, null if not specified.

requestURI

public AuthenticationRequest.Builder requestURI(URI requestURI)

Sets the request object URI. Corresponds to the optional request_uri parameter. Must not be specified together with a request object.

Parameters:

requestURI - The request object URI, null if not specified.

responseMode

public AuthenticationRequest.Builder responseMode(ResponseMode rm)

Sets the response mode. Corresponds to the optional response_mode parameter. Use of this parameter is not recommended unless a non-default response mode is requested (e.g. form_post).

Parameters:

rm - The response mode, null if not specified.

Returns:

This builder.

codeChallenge

@Deprecated
public AuthenticationRequest.Builder codeChallenge(CodeChallenge codeChallenge,
                                                               CodeChallengeMethod codeChallengeMethod)

Deprecated.

Sets the code challenge for Proof Key for Code Exchange (PKCE) by public OAuth clients.

Parameters:

codeChallenge - The code challenge, null if not specified.

codeChallengeMethod - The code challenge method, null if not specified.

Returns:

This builder.

codeChallenge

public AuthenticationRequest.Builder codeChallenge(CodeVerifier codeVerifier,
                                                   CodeChallengeMethod codeChallengeMethod)

Sets the code challenge for Proof Key for Code Exchange (PKCE) by public OAuth clients.

Parameters:

codeVerifier - The code verifier to use to compute the code challenge, null if PKCE is not specified.

codeChallengeMethod - The code challenge method, null if not specified. Defaults to CodeChallengeMethod.PLAIN if a code verifier is specified.

Returns:

This builder.

customParameter

public AuthenticationRequest.Builder customParameter(String name,
                                                     String value)

Sets the specified additional custom parameter.

Parameters:

name - The parameter name. Must not be null.

value - The parameter value, null if not specified.

Returns:

This builder.

build

public AuthenticationRequest build()

Builds a new authentication request.

Returns:

The authentication request.