com.neovisionaries.android.oauth20

Class AuthorizationRequest

java.lang.Object

com.neovisionaries.android.oauth20.AuthorizationRequest

All Implemented Interfaces:

android.os.Parcelable

public class AuthorizationRequest
extends Object
implements android.os.Parcelable

OAuth 2.0 authorization request.

Since:

1.9

Author:

Takahiko Kawasaki

See Also:

RFC 6749 (OAuth 2.0), 3.1. Authorization Endpoint, RFC 6749 (OAuth 2.0), 4.1.1. Authorization Request, RFC 6749 (OAuth 2.0), 4.2.1. Authorization Request

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<AuthorizationRequest>	CREATOR CREATER required by Parcelable interface.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
AuthorizationRequest() The default constructor.

Method Summary

Modifier and Type	Method and Description
AuthorizationRequest	addParameter(String name, String value) Add an extra parameter to the authorization request.
AuthorizationRequest	addScopes(String... scopes) Add scopes, which are elements in the value of scope parameter (OPTIONAL parameter).
int	describeContents()
String	getClientId() Get the client ID (= the value of client_id parameter (REQUIRED parameter)).
URL	getEndpoint() Get the authorization endpoint.
Map<String,String>	getExtraParameters() Get extra parameters added to the authorization request.
URL	getRedirectUri() Get the redirect URI (= the value of redirect_uri parameter (OPTIONAL parameter)).
ResponseType	getResponseType() Get the response type (= the value of response_type parameter (REQUIRED parameter)).
char	getScopeDelimiter() Get the delimiter for scopes.
Set<String>	getScopeSet() Get the scopes, which are elements in the value of scope parameter (OPTIONAL parameter).
String	getState() Get the state (= the value of state parameter (RECOMMENDED parameter)).
AuthorizationRequest	removeParameter(String name) Remove an extra parameter from the authorization request.
AuthorizationRequest	removeScopes(String... scopes) Remove scopes, which are elements in the value of scope parameter (OPTIONAL parameter).
AuthorizationRequest	setClientId(String clientId) Set the client ID (= the value of client_id parameter (REQUIRED parameter)).
AuthorizationRequest	setEndpoint(String endpoint) Set the authorization endpoint.
AuthorizationRequest	setEndpoint(URL endpoint) Set the authorization endpoint.
AuthorizationRequest	setExtraParameters(Map<String,String> parameters) Set extra parameters added to the authorization request.
AuthorizationRequest	setRedirectUri(String redirectUri) Set the redirect URI (= the value of redirect_uri parameter (OPTIONAL parameter)).
AuthorizationRequest	setRedirectUri(URL redirectUri) Set the redirect URI (= the value of redirect_uri parameter (OPTIONAL parameter)).
AuthorizationRequest	setResponseType(ResponseType responseType) Set the response type (= the value of response_type parameter (REQUIRED parameter)).
AuthorizationRequest	setScopeDelimiter(char delimiter) Set the delimiter for scopes.
AuthorizationRequest	setScopeSet(Set<String> scopeSet) Set the scopes, which are elements in the value of scope parameter (OPTIONAL parameter).
AuthorizationRequest	setState(String state) Set the state (= the value of state parameter (RECOMMENDED parameter)).
URL	toURL() Convert this authorization request to a URL.
void	writeToParcel(android.os.Parcel out, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<AuthorizationRequest> CREATOR

CREATER required by Parcelable interface.

Constructor Detail

AuthorizationRequest

public AuthorizationRequest()

The default constructor.

Method Detail

getEndpoint

public URL getEndpoint()

Get the authorization endpoint.

Returns:

The authorization endpoint.

See Also:

RFC 6749 (OAuth 2.0), 3.1. Authorization Endpoint

setEndpoint

public AuthorizationRequest setEndpoint(URL endpoint)

Set the authorization endpoint.

Parameters:

endpoint - The authorization endpoint.

Returns:

this object.

Throws:

IllegalArgumentException - The endpoint includes a fragment component. It is prohibited by the specification.

See Also:

RFC 6749 (OAuth 2.0), 3.1. Authorization Endpoint

setEndpoint

public AuthorizationRequest setEndpoint(String endpoint)

Set the authorization endpoint.

Parameters:

endpoint - The authorization endpoint.

Returns:

this object.

Throws:

IllegalArgumentException - The given endpoint is not a valid URL, or it includes a fragment component.

Since:

1.10

See Also:

RFC 6749 (OAuth 2.0), 3.1. Authorization Endpoint

getResponseType

public ResponseType getResponseType()

Get the response type (= the value of response_type parameter (REQUIRED parameter)).

Returns:

The response type.

See Also:

RFC 6749 (OAuth 2.0), 3.1.1. Response Type

setResponseType

public AuthorizationRequest setResponseType(ResponseType responseType)

Set the response type (= the value of response_type parameter (REQUIRED parameter)).

Parameters:

responseType - The response type.

Returns:

this object.

See Also:

RFC 6749 (OAuth 2.0), 3.1.1. Response Type

getClientId

public String getClientId()

Get the client ID (= the value of client_id parameter (REQUIRED parameter)).

Returns:

The client ID.

setClientId

public AuthorizationRequest setClientId(String clientId)

Set the client ID (= the value of client_id parameter (REQUIRED parameter)).

Parameters:

clientId - The client ID.

Returns:

this object.

getRedirectUri

public URL getRedirectUri()

Get the redirect URI (= the value of redirect_uri parameter (OPTIONAL parameter)).

Returns:

The redirect URI.

See Also:

RFC 6749 (OAuth 2.0), 3.1.2. Redirection Endpoint

setRedirectUri

public AuthorizationRequest setRedirectUri(URL redirectUri)

Set the redirect URI (= the value of redirect_uri parameter (OPTIONAL parameter)).

RFC 6749 (OAuth 2.0), 3.1.2. Redirection Endpoint says "The redirection endpoint URI MUST be an absolute URI", so this method accepts the parameter value as URL.

Parameters:

redirectUri - The redirect URI.

Returns:

this object.

Throws:

IllegalArgumentException - The redirect URI failed to be converted into a URL, or it includes a fragment component.

See Also:

RFC 6749 (OAuth 2.0), 3.1.2. Redirection Endpoint

setRedirectUri

public AuthorizationRequest setRedirectUri(String redirectUri)

Set the redirect URI (= the value of redirect_uri parameter (OPTIONAL parameter)).

RFC 6749 (OAuth 2.0), 3.1.2. Redirection Endpoint says "The redirection endpoint URI MUST be an absolute URI".

Parameters:

redirectUri - The redirect URI.

Returns:

this object.

Throws:

IllegalArgumentException - The redirect URI includes a fragment component. It is prohibited by the specification.

Since:

1.10

See Also:

RFC 6749 (OAuth 2.0), 3.1.2. Redirection Endpoint

getScopeSet

public Set<String> getScopeSet()

Get the scopes, which are elements in the value of scope parameter (OPTIONAL parameter).

Returns:

The scopes.

setScopeSet

public AuthorizationRequest setScopeSet(Set<String> scopeSet)

Set the scopes, which are elements in the value of scope parameter (OPTIONAL parameter).

Scopes must comply with the specification shown below. Otherwise, IllegalArgumentException is thrown.

 scope-token = 1*( %x21 / %x23-5B / %x5D-7E )
 

null and an empty value do not raise IllegalArgumentException and are just ignored.

Parameters:

scopeSet - Scopes to be set.

Returns:

this object.

Throws:

IllegalArgumentException - There is a scope which does not comply with the specification.

See Also:

RFC 6749 (OAuth 2.0), 3.3. Access Token Scope

addScopes

public AuthorizationRequest addScopes(String... scopes)

Add scopes, which are elements in the value of scope parameter (OPTIONAL parameter).

Scopes must comply with the specification shown below. Otherwise, IllegalArgumentException is thrown.

 scope-token = 1*( %x21 / %x23-5B / %x5D-7E )
 

null and an empty value do not raise IllegalArgumentException and are just ignored.

Parameters:

scopes - Scopes to be added.

Returns:

this object.

Throws:

IllegalArgumentException - There is a scope which does not comply with the specification.

See Also:

RFC 6749 (OAuth 2.0), 3.3. Access Token Scope

removeScopes

public AuthorizationRequest removeScopes(String... scopes)

Remove scopes, which are elements in the value of scope parameter (OPTIONAL parameter).

Parameters:

scopes - Scopes to be removed.

Returns:

this object.

See Also:

RFC 6749 (OAuth 2.0), 3.3. Access Token Scope

getState

public String getState()

Get the state (= the value of state parameter (RECOMMENDED parameter)).

Returns:

The value of state parameter.

setState

public AuthorizationRequest setState(String state)

Set the state (= the value of state parameter (RECOMMENDED parameter)).

Parameters:

state - The value of state parameter.

Returns:

this object.

getExtraParameters

public Map<String,String> getExtraParameters()

Get extra parameters added to the authorization request.

Returns:

Extra parameters.

setExtraParameters

public AuthorizationRequest setExtraParameters(Map<String,String> parameters)

Set extra parameters added to the authorization request.

Parameters:

parameters - Extra parameters.

Returns:

this object.

addParameter

public AuthorizationRequest addParameter(String name,
                                         String value)

Add an extra parameter to the authorization request. For example, ("display", "touch") for Facebook.

Parameters:

name - Parameter name.

value - Parameter value.

Returns:

this object.

removeParameter

public AuthorizationRequest removeParameter(String name)

Remove an extra parameter from the authorization request.

Parameters:

name - Parameter name.

Returns:

this object.

getScopeDelimiter

public char getScopeDelimiter()

Get the delimiter for scopes. The default value is a space (0x20).

Returns:

The scope delimiter.

setScopeDelimiter

public AuthorizationRequest setScopeDelimiter(char delimiter)

Set the delimiter for scopes.

RFC 6749 (OAuth 2.0), 3.3. Access Token Scope says "The value of the scope parameter is expressed as a list of space-delimited, case-sensitive strings." However, Facebook does not comply with this specification and uses a comma (0x2C) as the delimiter. Therefore, for Facebook, setScopeDelimiter(',') needs to be called.

Parameters:

delimiter - The scope

Returns:

this object.

See Also:

RFC 6749 (OAuth 2.0), 3.3. Access Token Scope

toURL

public URL toURL()

Convert this authorization request to a URL.

Returns:

The URL that represents this authorization request.

Throws:

IllegalStateException -

• Endpoint is not set.
• Response type is not set.
• Client ID is not set.

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel out,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable