com.scvngr.levelup.core.net

Class LevelUpRequest

java.lang.Object

com.scvngr.levelup.core.net.AbstractRequest

com.scvngr.levelup.core.net.LevelUpRequest

All Implemented Interfaces:

Parcelable

@LevelUpApi(contract=PUBLIC)
public class LevelUpRequest
extends AbstractRequest

Class representing a request to the LevelUp web service using the API v14 and above standards.

 1) All POST parameters will be in JSON.
 2) Any access token parameter will be passed in an authorization header.
 3) .json URLS will no longer be used, must set accepts header.

 

Nested Class Summary

Nested classes/interfaces inherited from class com.scvngr.levelup.core.net.AbstractRequest

AbstractRequest.BadRequestException

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

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_VERSION_CODE_V14 API version code for v14.
static String	API_VERSION_CODE_V15 API version code for v15.
static Parcelable.Creator<LevelUpRequest>	CREATOR Creator for parceling.
static String	HEADER_AUTHORIZATION Header key for the authorized user's access token.
static String	HEADER_LEVELUP_API_KEY Header key for sending the application's API key for LevelUp.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
LevelUpRequest(Context context, HttpMethod method, String apiVersion, String endpoint, Map<String,String> queryParams, Map<String,String> headers, RequestBody body, AccessTokenRetriever retriever) Creates a new LevelUpRequest.
LevelUpRequest(Context context, HttpMethod method, String apiVersion, String endpoint, Map<String,String> queryParams, RequestBody body) Creates a new LevelUpRequest.
LevelUpRequest(Context context, HttpMethod method, String apiVersion, String endpoint, Map<String,String> queryParams, RequestBody body, AccessTokenRetriever retriever) Creates a new LevelUpRequest.
LevelUpRequest(Context context, HttpMethod method, Uri url, RequestBody body, AccessTokenRetriever retriever) Creates a new LevelUpRequest.
LevelUpRequest(Parcel in) Constructor for parceling.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object obj)
AccessToken	getAccessToken(Context context)
String	getBody(Context context)
int	getBodyLength(Context context)
static String	getFullUrl(Context context, String apiVersion, String endpoint) Gets the full endpoint URL.
Map<String,String>	getRequestHeaders(Context context)
int	hashCode()
String	toString()
void	writeBodyToStream(Context context, OutputStream stream) Subclasses must implement this write the POST body (if it has one) to the OutputStream passed.
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class com.scvngr.levelup.core.net.AbstractRequest

getMethod, getQueryParams, getUrl, getUrlString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

API_VERSION_CODE_V14

public static final String API_VERSION_CODE_V14

API version code for v14.

See Also:

Constant Field Values

API_VERSION_CODE_V15

public static final String API_VERSION_CODE_V15

API version code for v15.

See Also:

Constant Field Values

CREATOR

public static final Parcelable.Creator<LevelUpRequest> CREATOR

Creator for parceling.

HEADER_AUTHORIZATION

public static final String HEADER_AUTHORIZATION

Header key for the authorized user's access token.

See Also:

Constant Field Values

HEADER_LEVELUP_API_KEY

public static final String HEADER_LEVELUP_API_KEY

Header key for sending the application's API key for LevelUp.

See Also:

Constant Field Values

Constructor Detail

LevelUpRequest

public LevelUpRequest(Context context,
                      HttpMethod method,
                      String apiVersion,
                      String endpoint,
                      Map<String,String> queryParams,
                      RequestBody body)

Creates a new LevelUpRequest. This variant of the constructor is only for non-authenticated requests.

Parameters:

context - the Application context.

method - the HttpMethod for this request.

apiVersion - the version of the LevelUp web service API to hit.

endpoint - the API endpoint to request.

queryParams - the query string parameters.

body - the request body to POST/PUT.

LevelUpRequest

public LevelUpRequest(Context context,
                      HttpMethod method,
                      String apiVersion,
                      String endpoint,
                      Map<String,String> queryParams,
                      RequestBody body,
                      AccessTokenRetriever retriever)

Creates a new LevelUpRequest. This variant of the constructor takes the optional AccessTokenRetriever for authenticated requests.

Parameters:

context - the Application context.

method - the HttpMethod for this request.

apiVersion - the version of the LevelUp web service API to hit.

endpoint - the API endpoint to request.

queryParams - the query string parameters.

body - the request body to POST/PUT.

retriever - implementation of AccessTokenRetriever to use to try to append the access token to this request.

LevelUpRequest

public LevelUpRequest(Context context,
                      HttpMethod method,
                      String apiVersion,
                      String endpoint,
                      Map<String,String> queryParams,
                      Map<String,String> headers,
                      RequestBody body,
                      AccessTokenRetriever retriever)

Creates a new LevelUpRequest. This variant of the constructor takes the optional AccessTokenRetriever for authenticated requests.

Parameters:

context - the Application context.

method - the HttpMethod for this request.

apiVersion - the version of the LevelUp web service API to hit.

endpoint - the API endpoint to request.

queryParams - the query string parameters.

headers - allows for specifying request headers.

body - the request body to POST/PUT.

retriever - implementation of AccessTokenRetriever to use to try to append the access token to this request.

LevelUpRequest

public LevelUpRequest(Context context,
                      HttpMethod method,
                      Uri url,
                      RequestBody body,
                      AccessTokenRetriever retriever)
               throws IllegalArgumentException

Creates a new LevelUpRequest. This variant of the constructor takes a Uri which must be the complete URL of the request.

Parameters:

context - the Application context.

method - the HttpMethod for this request.

url - the request URL. This can include query parameters.

body - the request body to POST/PUT.

retriever - implementation of AccessTokenRetriever to use to try to append the access token to this request.

Throws:

IllegalArgumentException - if the URI passed in isn't an absolute URL.

LevelUpRequest

public LevelUpRequest(Parcel in)

Constructor for parceling.

Parameters:

in - the parcel to read from.

Method Detail

getFullUrl

public static String getFullUrl(Context context,
                                String apiVersion,
                                String endpoint)

Gets the full endpoint URL.

Parameters:

context - Application context.

apiVersion - the version of the API to hit.

endpoint - the endpoint to hit.

Returns:

the full URL to the endpoint passed.

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

Overrides:

describeContents in class AbstractRequest

getAccessToken

public final AccessToken getAccessToken(Context context)

Parameters:

context - the Application context.

Returns:

the User's AccessToken.

getBody

public final String getBody(Context context)

Parameters:

context - the context to use to get context dependent parameters

Returns:

the body of the request

getBodyLength

public final int getBodyLength(Context context)

Specified by:

getBodyLength in class AbstractRequest

Parameters:

context - the Application context.

Returns:

the length of the request body if there is one.

getRequestHeaders

public final Map<String,String> getRequestHeaders(Context context)

Overrides:

getRequestHeaders in class AbstractRequest

Parameters:

context - the context to use to get context dependent headers.

Returns:

the HTTP headers for this request. This has been wrapped in a call to Collections.unmodifiableMap(Map).

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractRequest

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRequest

toString

public String toString()

Overrides:

toString in class AbstractRequest

writeBodyToStream

public void writeBodyToStream(Context context,
                              OutputStream stream)
                       throws IOException

Description copied from class: AbstractRequest

Subclasses must implement this write the POST body (if it has one) to the OutputStream passed.

Specified by:

writeBodyToStream in class AbstractRequest

Parameters:

context - the Application context.

stream - the OutputStream to write the POST body to.

Throws:

IOException - if writing to the OutputStream fails

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

Overrides:

writeToParcel in class AbstractRequest