net.openid.appauth

Class EndSessionRequest

java.lang.Object

net.openid.appauth.EndSessionRequest

public class EndSessionRequest
extends java.lang.Object

An OpenID end session request.

NOTE: That is a draft implementation

See Also:

OpenID Connect Session Management 1.0 - draft 28, 5 RP-Initiated Logout

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
AuthorizationServiceConfiguration	configuration The service’s configuration.
java.lang.String	idToken An OpenID Connect ID Token.
android.net.Uri	redirectUri The client’s redirect URI.
java.lang.String	state An opaque value used by the client to maintain state between the request and callback.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getState() An opaque value used by the client to maintain state between the request and callback.
static EndSessionRequest	jsonDeserialize(org.json.JSONObject jsonObject) Reads an authorization request from a JSON string representation produced by jsonSerialize().
static EndSessionRequest	jsonDeserialize(java.lang.String jsonStr) Reads an authorization request from a JSON string representation produced by jsonSerializeString().
org.json.JSONObject	jsonSerialize() Produces a JSON representation of the end session request for persistent storage or local transmission (e.g.
java.lang.String	jsonSerializeString() Produces a JSON string representation of the request for persistent storage or local transmission (e.g.
android.net.Uri	toUri() Produces a request URI, that can be used to dispatch the request.

Methods inherited from class java.lang.Object

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

Field Detail

configuration

@NonNull
public final AuthorizationServiceConfiguration configuration

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

idToken

@NonNull
public final java.lang.String idToken

An OpenID Connect ID Token. Contains claims about the authentication of an End-User by an Authorization Server.

See Also:

OpenID Connect Session Management 1.0 - draft 28, 5 RP-Initiated Logout, OpenID Connect Core ID Token, Section 2

redirectUri

@NonNull
public final android.net.Uri redirectUri

The client’s redirect URI.

See Also:

OpenID Connect Session Management 1.0 - draft 28, 5.1. Redirection to RP After Logout

state

@NonNull
public final java.lang.String state

An opaque value used by the client to maintain state between the request and callback. If this value is not explicitly set, this library will automatically add state and perform appropriate validation of the state in the authorization response. It is recommended that the default implementation of this parameter be used wherever possible. Typically used to prevent CSRF attacks, as recommended in

See Also:

OpenID Connect Session Management 1.0 - draft 28, 5 RP-Initiated Logout, The OAuth 2.0 Authorization Framework (RFC 6749), Section 5.3.5

Method Detail

getState

@NonNull
public java.lang.String getState()

An opaque value used by the client to maintain state between the request and callback.

toUri

public android.net.Uri toUri()

Produces a request URI, that can be used to dispatch the request.

jsonSerialize

public org.json.JSONObject jsonSerialize()

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

jsonDeserialize

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

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

Throws:

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

jsonDeserialize

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

Reads an authorization 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.

jsonSerializeString

public java.lang.String jsonSerializeString()

Produces a JSON string representation of the 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.