com.scvngr.levelup.core.net

Class AbstractRequest

java.lang.Object

com.scvngr.levelup.core.net.AbstractRequest

All Implemented Interfaces:

Parcelable

Direct Known Subclasses:

LevelUpRequest

@Immutable
 @LevelUpApi(contract=PUBLIC)
public abstract class AbstractRequest
extends Object
implements Parcelable

Object which represents an HTTP request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractRequest.BadRequestException Exception that is thrown if a request is invalid at the time it it sent.

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

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

Field Summary

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
AbstractRequest(HttpMethod method, String url, Map<String,String> requestHeaders, Map<String,String> queryParams) Create a new AbstractRequest.
AbstractRequest(HttpMethod method, Uri url, Map<String,String> requestHeaders) Create a new AbstractRequest from an absolute URL.
AbstractRequest(Parcel in) Constructor for parceling.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object obj)
abstract int	getBodyLength(Context context)
HttpMethod	getMethod()
Map<String,String>	getQueryParams(Context context)
Map<String,String>	getRequestHeaders(Context context)
URL	getUrl(Context context)
String	getUrlString(Context context)
int	hashCode()
String	toString()
abstract 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 java.lang.Object

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

Constructor Detail

AbstractRequest

public AbstractRequest(HttpMethod method,
                       String url,
                       Map<String,String> requestHeaders,
                       Map<String,String> queryParams)

Create a new AbstractRequest.

Note that there are some representation invariants for the AbstractRequest object. For example, a HttpMethod.GET cannot contain a body.

Parameters:

method - the HttpMethod of the request type.

url - the URL to request (and to append query string parameters to).

requestHeaders - the headers to add to the request. This cannot contain null keys or null values.

queryParams - the query string parameters. This cannot contain null keys or null values.

AbstractRequest

public AbstractRequest(HttpMethod method,
                       Uri url,
                       Map<String,String> requestHeaders)
                throws IllegalArgumentException

Create a new AbstractRequest from an absolute URL.

Parameters:

method - the HttpMethod of the request type.

url - The URL to request. This can include query parameters.

requestHeaders - the headers to add to the request. This cannot contain null keys or null values.

Throws:

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

AbstractRequest

public AbstractRequest(Parcel in)

Constructor for parceling.

Parameters:

in - the parcel to read from

Method Detail

getRequestHeaders

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

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).

getQueryParams

public Map<String,String> getQueryParams(Context context)

Parameters:

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

Returns:

the parameters encoded in the query string. This has been wrapped in a call to Collections.unmodifiableMap(Map).

getUrlString

public String getUrlString(Context context)
                    throws AbstractRequest.BadRequestException

Parameters:

context - Application context.

Returns:

the base URL String.

Throws:

AbstractRequest.BadRequestException - if the request is invalid.

getUrl

public final URL getUrl(Context context)
                 throws AbstractRequest.BadRequestException

Parameters:

context - the context to use to get context dependent parameters

Returns:

the final URL to request, including query string parameters.

Throws:

AbstractRequest.BadRequestException - if the request is invalid.

getMethod

public final HttpMethod getMethod()

Returns:

the HttpMethod for the request

writeBodyToStream

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

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

Parameters:

context - the Application context.

stream - the OutputStream to write the POST body to.

Throws:

IOException - if writing to the OutputStream fails

getBodyLength

public abstract int getBodyLength(Context context)

Parameters:

context - the Application context.

Returns:

the length of the request body if there is one.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable