Package net.openid.appauth

Class RegistrationResponse.Builder

java.lang.Object

net.openid.appauth.RegistrationResponse.Builder

Enclosing class:

RegistrationResponse

public static final class RegistrationResponse.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder(RegistrationRequest request)	Creates a token response associated with the specified request.

Method Summary

Modifier and Type	Method	Description
RegistrationResponse	build()	Creates the token response instance.
RegistrationResponse.Builder	fromResponseJson(JSONObject json)	Extracts token response fields from a JSON object.
RegistrationResponse.Builder	fromResponseJsonString(String jsonStr)	Extracts registration response fields from a JSON string.
RegistrationResponse.Builder	setAdditionalParameters(Map<String,String> additionalParameters)	Specifies the additional, non-standard parameters received as part of the response.
RegistrationResponse.Builder	setClientId(String clientId)	Specifies the client identifier.
RegistrationResponse.Builder	setClientIdIssuedAt(Long clientIdIssuedAt)	Specifies the timestamp for when the client identifier was issued.
RegistrationResponse.Builder	setClientSecret(String clientSecret)	Specifies the client secret.
RegistrationResponse.Builder	setClientSecretExpiresAt(Long clientSecretExpiresAt)	Specifies the expiration time of the client secret.
RegistrationResponse.Builder	setRegistrationAccessToken(String registrationAccessToken)	Specifies the registration access token.
RegistrationResponse.Builder	setRegistrationClientUri(Uri registrationClientUri)	Specifies the client configuration endpoint.
RegistrationResponse.Builder	setRequest(RegistrationRequest request)	Specifies the request associated with this response.
RegistrationResponse.Builder	setTokenEndpointAuthMethod(String tokenEndpointAuthMethod)	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
               RegistrationRequest request)

Creates a token response associated with the specified request.

Method Detail

setRequest

@NonNull
public RegistrationResponse.Builder setRequest(@NonNull
                                               RegistrationRequest request)

Specifies the request associated with this response.

Must not be null.

setClientId

public RegistrationResponse.Builder setClientId(@NonNull
                                                String clientId)

Specifies the client identifier.

See Also:

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

setClientIdIssuedAt

public RegistrationResponse.Builder setClientIdIssuedAt(@Nullable
                                                        Long clientIdIssuedAt)

Specifies the timestamp for when the client identifier was issued.

See Also:

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

setClientSecret

public RegistrationResponse.Builder setClientSecret(@Nullable
                                                    String clientSecret)

Specifies the client secret.

See Also:

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

setClientSecretExpiresAt

public RegistrationResponse.Builder setClientSecretExpiresAt(@Nullable
                                                             Long clientSecretExpiresAt)

Specifies the expiration time of the client secret.

See Also:

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

setRegistrationAccessToken

public RegistrationResponse.Builder setRegistrationAccessToken(@Nullable
                                                               String registrationAccessToken)

Specifies the registration access token.

See Also:

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

setTokenEndpointAuthMethod

public RegistrationResponse.Builder setTokenEndpointAuthMethod(@Nullable
                                                               String tokenEndpointAuthMethod)

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

setRegistrationClientUri

public RegistrationResponse.Builder setRegistrationClientUri(@Nullable
                                                             Uri registrationClientUri)

Specifies the client configuration endpoint.

See Also:

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

setAdditionalParameters

public RegistrationResponse.Builder setAdditionalParameters(Map<String,String> additionalParameters)

Specifies the additional, non-standard parameters received as part of the response.

build

public RegistrationResponse build()

Creates the token response instance.

fromResponseJsonString

@NonNull
public RegistrationResponse.Builder fromResponseJsonString(@NonNull
                                                           String jsonStr)
                                                    throws JSONException,
                                                           RegistrationResponse.MissingArgumentException

Extracts registration response fields from a JSON string.

Throws:

JSONException - if the JSON is malformed or has incorrect value types for fields.

RegistrationResponse.MissingArgumentException - if the JSON is missing fields required by the specification.

fromResponseJson

@NonNull
public RegistrationResponse.Builder fromResponseJson(@NonNull
                                                     JSONObject json)
                                              throws JSONException,
                                                     RegistrationResponse.MissingArgumentException

Extracts token response fields from a JSON object.

Throws:

JSONException - if the JSON is malformed or has incorrect value types for fields.

RegistrationResponse.MissingArgumentException - if the JSON is missing fields required by the specification.