net.openid.appauth

Class RegistrationRequest

java.lang.Object

net.openid.appauth.RegistrationRequest

public class RegistrationRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegistrationRequest.Builder Creates instances of RegistrationRequest.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,java.lang.String>	additionalParameters Additional parameters to be passed as part of the request.
static java.lang.String	APPLICATION_TYPE_NATIVE OpenID Connect ‘application_type’.
java.lang.String	applicationType The application type to register, will always be ‘native’.
AuthorizationServiceConfiguration	configuration The service’s configuration.
java.util.List<java.lang.String>	grantTypes The grant types to use.
java.util.List<android.net.Uri>	redirectUris The client’s redirect URI’s.
java.util.List<java.lang.String>	responseTypes The response types to use.
static java.lang.String	SUBJECT_TYPE_PAIRWISE Instructs the authorization server to generate a pairwise subject identifier.
static java.lang.String	SUBJECT_TYPE_PUBLIC Instructs the authorization server to generate a public subject identifier.
java.lang.String	subjectType The subject type to use.
java.lang.String	tokenEndpointAuthenticationMethod The client authentication method to use at the token endpoint.

Method Summary

Modifier and Type	Method and Description
static RegistrationRequest	jsonDeserialize(org.json.JSONObject json) Reads a registration request from a JSON string representation produced by jsonSerialize().
static RegistrationRequest	jsonDeserialize(java.lang.String jsonStr) Reads a registration request from a JSON string representation produced by jsonSerializeString().
org.json.JSONObject	jsonSerialize() Produces a JSON representation of the registration request for persistent storage or local transmission (e.g.
java.lang.String	jsonSerializeString() Produces a JSON string representation of the registration request for persistent storage or local transmission (e.g.
java.lang.String	toJsonString() Converts the registration request to JSON for transmission to an authorization service.

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_TYPE_NATIVE

public static final java.lang.String APPLICATION_TYPE_NATIVE

OpenID Connect ‘application_type’.

See Also:

Constant Field Values

SUBJECT_TYPE_PAIRWISE

public static final java.lang.String SUBJECT_TYPE_PAIRWISE

Instructs the authorization server to generate a pairwise subject identifier.

See Also:

OpenID Connect Core 1.0, Section 8, Constant Field Values

SUBJECT_TYPE_PUBLIC

public static final java.lang.String SUBJECT_TYPE_PUBLIC

Instructs the authorization server to generate a public subject identifier.

See Also:

OpenID Connect Core 1.0, Section 8, Constant Field Values

configuration

@NonNull
public final AuthorizationServiceConfiguration configuration

The service’s configuration. This configuration specifies how to connect to a particular OAuth provider. Configurations may be created manually, or via an OpenID Connect Discovery Document.

redirectUris

@NonNull
public final java.util.List<android.net.Uri> redirectUris

The client’s redirect URI’s.

See Also:

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

applicationType

@NonNull
public final java.lang.String applicationType

The application type to register, will always be ‘native’.

responseTypes

@Nullable
public final java.util.List<java.lang.String> responseTypes

The response types to use.

See Also:

OpenID Connect Core 1.0, Section 3

grantTypes

@Nullable
public final java.util.List<java.lang.String> grantTypes

The grant types to use.

See Also:

OpenID Connect Dynamic Client Registration 1.0, Section 2

subjectType

@Nullable
public final java.lang.String subjectType

The subject type to use.

See Also:

OpenID Connect Core 1.0, Section 8

tokenEndpointAuthenticationMethod

@Nullable
public final java.lang.String tokenEndpointAuthenticationMethod

The client authentication method to use at the token endpoint.

See Also:

OpenID Connect Core 1.0, Section 9

additionalParameters

@NonNull
public final java.util.Map<java.lang.String,java.lang.String> additionalParameters

Additional parameters to be passed as part of the request.

Method Detail

toJsonString

@NonNull
public java.lang.String toJsonString()

Converts the registration request to JSON for transmission to an authorization service. For local persistence and transmission, use jsonSerialize().

jsonSerialize

@NonNull
public org.json.JSONObject jsonSerialize()

Produces a JSON representation of the registration request for persistent storage or local transmission (e.g. between activities).

jsonSerializeString

@NonNull
public java.lang.String jsonSerializeString()

Produces a JSON string representation of the registration request for persistent storage or local transmission (e.g. between activities). This method is just a convenience wrapper for jsonSerialize(), converting the JSON object to its string form.

jsonDeserialize

public static RegistrationRequest jsonDeserialize(@NonNull
                                                  org.json.JSONObject json)
                                           throws org.json.JSONException

Reads a registration request from a JSON string representation produced by jsonSerialize().

Throws:

org.json.JSONException - if the provided JSON does not match the expected structure.

jsonDeserialize

public static RegistrationRequest jsonDeserialize(@NonNull
                                                  java.lang.String jsonStr)
                                           throws org.json.JSONException

Reads a registration request from a JSON string representation produced by jsonSerializeString(). This method is just a convenience wrapper for jsonDeserialize(JSONObject), converting the JSON string to its JSON object form.

Throws:

org.json.JSONException - if the provided JSON does not match the expected structure.