net.openid.appauth

Class AuthorizationService

java.lang.Object

net.openid.appauth.AuthorizationService

public class AuthorizationService
extends Object

Dispatches requests to an OAuth2 authorization service. Note that instances of this class must be manually disposed when no longer required, to avoid leaks (see dispose().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AuthorizationService.TokenResponseCallback Callback interface for token endpoint requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCOPE_ADDRESS Scope value which requests access to the address claim.
static String	SCOPE_EMAIL Scope value which requests access to the email and email_verified claims.
static String	SCOPE_OPENID Scope value which requests access to the end-user's stable identifier.
static String	SCOPE_PROFILE Scope value which requests access to the end-user's default profile claims.

Constructor Summary

Constructors

Constructor and Description
AuthorizationService(Context context) Creates an AuthorizationService instance based on the provided configuration.

Method Summary

Modifier and Type	Method and Description
CustomTabsIntent.Builder	createCustomTabsIntentBuilder() Creates a custom tab builder, that will use a tab session from an existing connection to a web browser, if available.
void	dispose() Disposes state that will not normally be handled by garbage collection.
void	performAuthorizationRequest(AuthorizationRequest request, PendingIntent resultHandlerIntent) Sends an authorization request to the authorization service, using a custom tab.
void	performAuthorizationRequest(AuthorizationRequest request, PendingIntent resultHandlerIntent, CustomTabsIntent customTabsIntent) Sends an authorization request to the authorization service, using a custom tab.
void	performTokenRequest(TokenRequest request, AuthorizationService.TokenResponseCallback callback) Sends a request to the authorization service to exchange a code granted as part of an authorization request for a token.

Methods inherited from class java.lang.Object

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

Field Detail

SCOPE_OPENID

public static final String SCOPE_OPENID

Scope value which requests access to the end-user's stable identifier.

See Also:

"Requesting Claims using Scope Values", OpenID Connect Core 1.0 Specification, Section 5.4, Constant Field Values

SCOPE_PROFILE

public static final String SCOPE_PROFILE

Scope value which requests access to the end-user's default profile claims.

See Also:

"Requesting Claims using Scope Values", OpenID Connect Core 1.0 Specification, Section 5.4, Constant Field Values

SCOPE_EMAIL

public static final String SCOPE_EMAIL

Scope value which requests access to the email and email_verified claims.

See Also:

"Requesting Claims using Scope Values", OpenID Connect Core 1.0 Specification, Section 5.4, Constant Field Values

SCOPE_ADDRESS

public static final String SCOPE_ADDRESS

Scope value which requests access to the address claim.

See Also:

"Requesting Claims using Scope Values", OpenID Connect Core 1.0 Specification, Section 5.4, Constant Field Values

Constructor Detail

AuthorizationService

public AuthorizationService(@NonNull
                            Context context)

Creates an AuthorizationService instance based on the provided configuration. Note that instances of this class must be manually disposed when no longer required, to avoid leaks (see dispose().

Method Detail

createCustomTabsIntentBuilder

public CustomTabsIntent.Builder createCustomTabsIntentBuilder()

Creates a custom tab builder, that will use a tab session from an existing connection to a web browser, if available.

performAuthorizationRequest

public void performAuthorizationRequest(@NonNull
                                        AuthorizationRequest request,
                                        @NonNull
                                        PendingIntent resultHandlerIntent)

Sends an authorization request to the authorization service, using a custom tab. The parameters of this request are determined by both the authorization service configuration and the provided request object. Upon completion of this request, the provided result handler intent will be invoked.

performAuthorizationRequest

public void performAuthorizationRequest(@NonNull
                                        AuthorizationRequest request,
                                        @NonNull
                                        PendingIntent resultHandlerIntent,
                                        @NonNull
                                        CustomTabsIntent customTabsIntent)

Sends an authorization request to the authorization service, using a custom tab. The parameters of this request are determined by both the authorization service configuration and the provided request object. Upon completion of this request, the provided result handler intent will be invoked.

Parameters:

customTabsIntent - The intent that will be used to start the custom tab. It is recommended that this intent be created with the help of createCustomTabsIntentBuilder(), which will ensure that a warmed-up version of the browser will be used, minimizing latency.

performTokenRequest

public void performTokenRequest(@NonNull
                                TokenRequest request,
                                @NonNull
                                AuthorizationService.TokenResponseCallback callback)

Sends a request to the authorization service to exchange a code granted as part of an authorization request for a token. The result of this request will be sent to the provided callback handler.

dispose

public void dispose()

Disposes state that will not normally be handled by garbage collection. This should be called when the authorization service is no longer required, including when any owning activity is paused or destroyed (i.e. in Activity.onStop()).