org.djodjo.comm.jus.request

Class JsonRequest<T>

java.lang.Object

org.djodjo.comm.jus.Request<T>

org.djodjo.comm.jus.request.JsonRequest<T>

Type Parameters:

T - JSON type of response expected

All Implemented Interfaces:

java.lang.Comparable<Request<T>>

Direct Known Subclasses:

JsonArrayRequest, JsonObjectRequest

public abstract class JsonRequest<T>
extends Request<T>

A request for retrieving a T type response body at a given URL that also optionally sends along a JSON body in the request specified.

Nested Class Summary

Nested classes/interfaces inherited from class org.djodjo.comm.jus.Request

Request.Method, Request.Priority

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	PROTOCOL_CHARSET Default charset for JSON request.

Constructor Summary

Constructors

Constructor and Description
JsonRequest(int method, java.lang.String url, java.lang.String requestBody, Response.Listener<T> listener, Response.ErrorListener errorListener)
JsonRequest(java.lang.String url, java.lang.String requestBody, Response.Listener<T> listener, Response.ErrorListener errorListener) Deprecated. Use #JsonRequest(int, String, String, Listener, ErrorListener).

Method Summary

Methods

Modifier and Type	Method and Description
protected void	deliverResponse(T response) Subclasses must implement this to perform delivery of the parsed response to their listeners.
byte[]	getBody() Returns the raw POST or PUT body to be sent.
java.lang.String	getBodyContentType() Returns the content type of the POST or PUT body.
abstract Response<T>	parseNetworkResponse(NetworkResponse response) Subclasses must implement this to parse the raw network response and return an appropriate response type.

Methods inherited from class org.djodjo.comm.jus.Request

addMarker, cancel, compareTo, deliverError, finish, getCacheEntry, getCacheKey, getErrorListener, getHeaders, getMethod, getParams, getParamsEncoding, getPostBody, getPostBodyContentType, getPostParams, getPostParamsEncoding, getPriority, getRetryPolicy, getSequence, getTag, getTimeoutMs, getTrafficStatsTag, getUrl, hasHadResponseDelivered, isCanceled, markDelivered, parseNetworkError, setCacheEntry, setRequestQueue, setRetryPolicy, setSequence, setShouldCache, setTag, shouldCache, toString

Methods inherited from class java.lang.Object

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

Field Detail

PROTOCOL_CHARSET

protected static final java.lang.String PROTOCOL_CHARSET

Default charset for JSON request.

See Also:

Constant Field Values

Constructor Detail

JsonRequest

public JsonRequest(java.lang.String url,
           java.lang.String requestBody,
           Response.Listener<T> listener,
           Response.ErrorListener errorListener)

Deprecated. Use #JsonRequest(int, String, String, Listener, ErrorListener).

Deprecated constructor for a JsonRequest which defaults to GET unless Request.getPostBody() or Request.getPostParams() is overridden (which defaults to POST).

JsonRequest

public JsonRequest(int method,
           java.lang.String url,
           java.lang.String requestBody,
           Response.Listener<T> listener,
           Response.ErrorListener errorListener)

Method Detail

deliverResponse

protected void deliverResponse(T response)

Description copied from class: Request

Subclasses must implement this to perform delivery of the parsed response to their listeners. The given response is guaranteed to be non-null; responses that fail to parse are not delivered.

Specified by:

deliverResponse in class Request<T>

Parameters:

response - The parsed response returned by Request.parseNetworkResponse(NetworkResponse)

parseNetworkResponse

public abstract Response<T> parseNetworkResponse(NetworkResponse response)

Description copied from class: Request

Subclasses must implement this to parse the raw network response and return an appropriate response type. This method will be called from a worker thread. The response will not be delivered if you return null.

Specified by:

parseNetworkResponse in class Request<T>

Parameters:

response - Response from the network

Returns:

The parsed response, or null in the case of an error

getBodyContentType

public java.lang.String getBodyContentType()

Description copied from class: Request

Returns the content type of the POST or PUT body.

Overrides:

getBodyContentType in class Request<T>

getBody

public byte[] getBody()

Description copied from class: Request

Returns the raw POST or PUT body to be sent.

By default, the body consists of the request parameters in application/x-www-form-urlencoded format. When overriding this method, consider overriding Request.getBodyContentType() as well to match the new body format.

Overrides:

getBody in class Request<T>