Package net.openid.appauth

Class RegistrationRequest.Builder

java.lang.Object

net.openid.appauth.RegistrationRequest.Builder

Enclosing class:

RegistrationRequest

public static final class RegistrationRequest.Builder
extends Object

Creates instances of RegistrationRequest.

Constructor Summary

Constructors

Constructor	Description
Builder(AuthorizationServiceConfiguration configuration, List<Uri> redirectUri)	Creates a registration request builder with the specified mandatory properties.

Method Summary

Modifier and Type	Method	Description
RegistrationRequest	build()	Constructs the registration request.
RegistrationRequest.Builder	setAdditionalParameters(Map<String,String> additionalParameters)	Specifies additional parameters.
RegistrationRequest.Builder	setConfiguration(AuthorizationServiceConfiguration configuration)	Specifies the authorization service configuration for the request, which must not be null or empty.
RegistrationRequest.Builder	setGrantTypeValues(String... grantTypeValues)	Specifies the grant types.
RegistrationRequest.Builder	setGrantTypeValues(List<String> grantTypeValues)	Specifies the grant types.
RegistrationRequest.Builder	setJwks(JSONObject jwks)	Specifies the client’s JSON Web Key Set.
RegistrationRequest.Builder	setJwksUri(Uri jwksUri)	Specifies the URL for the Client’s JSON Web Key Set.
RegistrationRequest.Builder	setRedirectUriValues(Uri... redirectUriValues)	Specifies the redirect URI’s.
RegistrationRequest.Builder	setRedirectUriValues(List<Uri> redirectUriValues)	Specifies the redirect URI’s.
RegistrationRequest.Builder	setResponseTypeValues(String... responseTypeValues)	Specifies the response types.
RegistrationRequest.Builder	setResponseTypeValues(List<String> responseTypeValues)	Specifies the response types.
RegistrationRequest.Builder	setSubjectType(String subjectType)	Specifies the subject types.
RegistrationRequest.Builder	setTokenEndpointAuthenticationMethod(String tokenEndpointAuthenticationMethod)	Specifies the client authentication method to use at the token endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@NonNull
               AuthorizationServiceConfiguration configuration,
               @NonNull
               List<Uri> redirectUri)

Creates a registration request builder with the specified mandatory properties.

Method Detail

setConfiguration

@NonNull
public RegistrationRequest.Builder setConfiguration(@NonNull
                                                    AuthorizationServiceConfiguration configuration)

Specifies the authorization service configuration for the request, which must not be null or empty.

setRedirectUriValues

@NonNull
public RegistrationRequest.Builder setRedirectUriValues(@NonNull
                                                        Uri... redirectUriValues)

Specifies the redirect URI’s.

See Also:

"The OAuth 2.0 Authorization Framework" (RFC 6749), Section 3.1.2

setRedirectUriValues

@NonNull
public RegistrationRequest.Builder setRedirectUriValues(@NonNull
                                                        List<Uri> redirectUriValues)

Specifies the redirect URI’s.

See Also:

“The OAuth 2.0 Authorization Framework (RFC 6749), Section 3.1.2 https://tools.ietf.org/html/rfc6749#section-3.1.2”

setResponseTypeValues

@NonNull
public RegistrationRequest.Builder setResponseTypeValues(@Nullable
                                                         String... responseTypeValues)

Specifies the response types.

See Also:

“OpenID Connect Core 1.0, Section 3 https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3”

setResponseTypeValues

@NonNull
public RegistrationRequest.Builder setResponseTypeValues(@Nullable
                                                         List<String> responseTypeValues)

Specifies the response types.

See Also:

“OpenID Connect Core 1.0, Section X https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.X”

setGrantTypeValues

@NonNull
public RegistrationRequest.Builder setGrantTypeValues(@Nullable
                                                      String... grantTypeValues)

Specifies the grant types.

See Also:

“OpenID Connect Dynamic Client Registration 1.0, Section 2 https://openid.net/specs/openid-connect-discovery-1_0.html#rfc.section.2”

setGrantTypeValues

@NonNull
public RegistrationRequest.Builder setGrantTypeValues(@Nullable
                                                      List<String> grantTypeValues)

Specifies the grant types.

See Also:

“OpenID Connect Dynamic Client Registration 1.0, Section 2 https://openid.net/specs/openid-connect-discovery-1_0.html#rfc.section.2”

setSubjectType

@NonNull
public RegistrationRequest.Builder setSubjectType(@Nullable
                                                  String subjectType)

Specifies the subject types.

See Also:

“OpenID Connect Core 1.0, Section 8 https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.8”

setJwksUri

@NonNull
public RegistrationRequest.Builder setJwksUri(@Nullable
                                              Uri jwksUri)

Specifies the URL for the Client’s JSON Web Key Set.

See Also:

“OpenID Connect Dynamic Client Registration 1.0, Client Metadata https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata”

setJwks

@NonNull
public RegistrationRequest.Builder setJwks(@Nullable
                                           JSONObject jwks)

Specifies the client’s JSON Web Key Set.

See Also:

“OpenID Connect Dynamic Client Registration 1.0, Client Metadata https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata”

setTokenEndpointAuthenticationMethod

@NonNull
public RegistrationRequest.Builder setTokenEndpointAuthenticationMethod(@Nullable
                                                                        String tokenEndpointAuthenticationMethod)

Specifies the client authentication method to use at the token endpoint.

See Also:

“OpenID Connect Core 1.0, Section 9 https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.9”

setAdditionalParameters

@NonNull
public RegistrationRequest.Builder setAdditionalParameters(@Nullable
                                                           Map<String,String> additionalParameters)

Specifies additional parameters.

Replaces any previously provided set of parameters. Parameter keys and values cannot be null or empty.

build

@NonNull
public RegistrationRequest build()

Constructs the registration request.

At a minimum, the redirect URI must have been set before calling this method.