Request

java.lang.Object
- com.android.volley.Request<T>

Type Parameters:

T - The type of parsed response this request expects.

All Implemented Interfaces:

java.lang.Comparable<Request<T>>

Direct Known Subclasses:

ClearCacheRequest, GsonRequest, ImageRequest, JsonRequest, StringRequest
```
public abstract class Request<T>
extends java.lang.Object
implements java.lang.Comparable<Request<T>>
```
Base class for all network requests.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Request.Method
Supported request methods.

static class Request.Priority
Priority values.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Request.Method` Supported request methods.
`static class`	`Request.Priority` Priority values.

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.lang.String`	`DEFAULT_PARAMS_ENCODING` Default encoding for POST or PUT parameters.
`private Cache.Entry`	`mCacheEntry` When a request can be retrieved from cache but must be refreshed from the network, the cache entry will be stored here so that in the event of a "Not Modified" response, we can be sure it hasn't been evicted from cache.
`private boolean`	`mCanceled` Whether or not this request has been canceled.
`private int`	`mDefaultTrafficStatsTag` Default tag for `android.net.TrafficStats`.
`private Response.ErrorListener`	`mErrorListener` Listener interface for errors.
`private VolleyLog.MarkerLog`	`mEventLog` An event log tracing the lifetime of this request; for debugging.
`private int`	`mMethod` Request method of this request.
`private long`	`mRequestBirthTime`
`private RequestQueue`	`mRequestQueue` The request queue this request is associated with.
`private boolean`	`mResponseDelivered` Whether or not a response has been delivered for this request yet.
`private RetryPolicy`	`mRetryPolicy` The retry policy for this request.
`private java.lang.Integer`	`mSequence` Sequence number of this request, used to enforce FIFO ordering.
`private boolean`	`mShouldCache` Whether or not responses to this request should be cached.
`private java.lang.Object`	`mTag` An opaque token tagging this request; used for bulk cancellation.
`private java.lang.String`	`mUrl` URL of this request.
`private static long`	`SLOW_REQUEST_THRESHOLD_MS` Threshold at which we should log the request (even when debug logging is not enabled).

Constructor Summary

Constructors
Constructor and Description
`Request(int method, java.lang.String url, Response.ErrorListener listener)` Creates a new request with the given method (one of the values from `Request.Method`), URL, and error listener.
`Request(java.lang.String url, Response.ErrorListener listener)` Deprecated. Use `Request(int, String, com.android.volley.Response.ErrorListener)`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addMarker(java.lang.String tag)` Adds an event to this request's event log; for debugging.
`void`	`cancel()` Mark this request as canceled.
`int`	`compareTo(Request<T> other)` Our comparator sorts from high to low priority, and secondarily by sequence number to provide FIFO ordering.
`void`	`deliverError(VolleyError error)` Delivers error message to the ErrorListener that the Request was initialized with.
`protected abstract void`	`deliverResponse(T response)` Subclasses must implement this to perform delivery of the parsed response to their listeners.
`private byte[]`	`encodeParameters(java.util.Map<java.lang.String,java.lang.String> params, java.lang.String paramsEncoding)` Converts `params` into an application/x-www-form-urlencoded encoded string.
`private static int`	`findDefaultTrafficStatsTag(java.lang.String url)`
`(package private) void`	`finish(java.lang.String tag)` Notifies the request queue that this request has finished (successfully or with error).
`byte[]`	`getBody()` Returns the raw POST or PUT body to be sent.
`java.lang.String`	`getBodyContentType()`
`Cache.Entry`	`getCacheEntry()` Returns the annotated cache entry, or null if there isn't one.
`java.lang.String`	`getCacheKey()` Returns the cache key for this request.
`java.util.Map<java.lang.String,java.lang.String>`	`getHeaders()` Returns a list of extra HTTP headers to go along with this request.
`int`	`getMethod()` Return the method for this request.
`protected java.util.Map<java.lang.String,java.lang.String>`	`getParams()` Returns a Map of parameters to be used for a POST or PUT request.
`protected java.lang.String`	`getParamsEncoding()` Returns which encoding should be used when converting POST or PUT parameters returned by `getParams()` into a raw POST or PUT body.
`byte[]`	`getPostBody()` Deprecated. Use `getBody()` instead.
`java.lang.String`	`getPostBodyContentType()` Deprecated. Use `getBodyContentType()` instead.
`protected java.util.Map<java.lang.String,java.lang.String>`	`getPostParams()` Deprecated. Use `getParams()` instead.
`protected java.lang.String`	`getPostParamsEncoding()` Deprecated. Use `getParamsEncoding()` instead.
`Request.Priority`	`getPriority()` Returns the `Request.Priority` of this request; `Request.Priority.NORMAL` by default.
`RetryPolicy`	`getRetryPolicy()` Returns the retry policy that should be used for this request.
`int`	`getSequence()` Returns the sequence number of this request.
`java.lang.Object`	`getTag()` Returns this request's tag.
`int`	`getTimeoutMs()` Returns the socket timeout in milliseconds per retry attempt.
`int`	`getTrafficStatsTag()`
`java.lang.String`	`getUrl()` Returns the URL of this request.
`boolean`	`hasHadResponseDelivered()` Returns true if this request has had a response delivered for it.
`boolean`	`isCanceled()` Returns true if this request has been canceled.
`void`	`markDelivered()` Mark this request as having a response delivered on it.
`protected VolleyError`	`parseNetworkError(VolleyError volleyError)` Subclasses can override this method to parse 'networkError' and return a more specific error.
`protected abstract Response<T>`	`parseNetworkResponse(NetworkResponse response)` Subclasses must implement this to parse the raw network response and return an appropriate response type.
`Request<?>`	`setCacheEntry(Cache.Entry entry)` Annotates this request with an entry retrieved for it from cache.
`Request<?>`	`setRequestQueue(RequestQueue requestQueue)` Associates this request with the given queue.
`Request<?>`	`setRetryPolicy(RetryPolicy retryPolicy)` Sets the retry policy for this request.
`Request<?>`	`setSequence(int sequence)` Sets the sequence number of this request.
`Request<?>`	`setShouldCache(boolean shouldCache)` Set whether or not responses to this request should be cached.
`Request<?>`	`setTag(java.lang.Object tag)` Set a tag on this request.
`boolean`	`shouldCache()` Returns true if responses to this request should be cached.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_PARAMS_ENCODING
```
private static final java.lang.String DEFAULT_PARAMS_ENCODING
```
    Default encoding for POST or PUT parameters. See getParamsEncoding().
    
    See Also:
    
    Constant Field Values
  - mEventLog
```
private final VolleyLog.MarkerLog mEventLog
```
    An event log tracing the lifetime of this request; for debugging.
  - mMethod
```
private final int mMethod
```
    Request method of this request. Currently supports GET, POST, PUT, DELETE, HEAD, OPTIONS, TRACE, and PATCH.
  - mUrl
```
private final java.lang.String mUrl
```
    URL of this request.
  - mDefaultTrafficStatsTag
```
private final int mDefaultTrafficStatsTag
```
    Default tag for android.net.TrafficStats.
  - mErrorListener
```
private final Response.ErrorListener mErrorListener
```
    Listener interface for errors.
  - mSequence
```
private java.lang.Integer mSequence
```
    Sequence number of this request, used to enforce FIFO ordering.
  - mRequestQueue
```
private RequestQueue mRequestQueue
```
    The request queue this request is associated with.
  - mShouldCache
```
private boolean mShouldCache
```
    Whether or not responses to this request should be cached.
  - mCanceled
```
private boolean mCanceled
```
    Whether or not this request has been canceled.
  - mResponseDelivered
```
private boolean mResponseDelivered
```
    Whether or not a response has been delivered for this request yet.
  - mRequestBirthTime
```
private long mRequestBirthTime
```
  - SLOW_REQUEST_THRESHOLD_MS
```
private static final long SLOW_REQUEST_THRESHOLD_MS
```
    Threshold at which we should log the request (even when debug logging is not enabled).
    
    See Also:
    
    Constant Field Values
  - mRetryPolicy
```
private RetryPolicy mRetryPolicy
```
    The retry policy for this request.
  - mCacheEntry
```
private Cache.Entry mCacheEntry
```
    When a request can be retrieved from cache but must be refreshed from the network, the cache entry will be stored here so that in the event of a "Not Modified" response, we can be sure it hasn't been evicted from cache.
  - mTag
```
private java.lang.Object mTag
```
    An opaque token tagging this request; used for bulk cancellation.
- Constructor Detail
  - Request
```
@Deprecated
public Request(java.lang.String url,
                            Response.ErrorListener listener)
```
    Deprecated. Use Request(int, String, com.android.volley.Response.ErrorListener).
    
    Creates a new request with the given URL and error listener. Note that the normal response listener is not provided here as delivery of responses is provided by subclasses, who have a better idea of how to deliver an already-parsed response.
  - Request
```
public Request(int method,
               java.lang.String url,
               Response.ErrorListener listener)
```
    Creates a new request with the given method (one of the values from Request.Method), URL, and error listener. Note that the normal response listener is not provided here as delivery of responses is provided by subclasses, who have a better idea of how to deliver an already-parsed response.
- Method Detail
  - getMethod
```
public int getMethod()
```
    Return the method for this request. Can be one of the values in Request.Method.
  - setTag
```
public Request<?> setTag(java.lang.Object tag)
```
    Set a tag on this request. Can be used to cancel all requests with this tag by RequestQueue.cancelAll(Object).
    
    Returns:
    
    This Request object to allow for chaining.
  - getTag
```
public java.lang.Object getTag()
```
    Returns this request's tag.
    
    See Also:
    
    setTag(Object)
  - getTrafficStatsTag
```
public int getTrafficStatsTag()
```
    Returns:
    
    A tag for use with android.net.TrafficStats#setThreadStatsTag(int)
  - findDefaultTrafficStatsTag
```
private static int findDefaultTrafficStatsTag(java.lang.String url)
```
    Returns:
    
    The hashcode of the URL's host component, or 0 if there is none.
  - setRetryPolicy
```
public Request<?> setRetryPolicy(RetryPolicy retryPolicy)
```
    Sets the retry policy for this request.
    
    Returns:
    
    This Request object to allow for chaining.
  - addMarker
```
public void addMarker(java.lang.String tag)
```
    Adds an event to this request's event log; for debugging.
  - finish
```
void finish(java.lang.String tag)
```
    Notifies the request queue that this request has finished (successfully or with error).
    Also dumps all events from this request's event log; for debugging.
  - setRequestQueue
```
public Request<?> setRequestQueue(RequestQueue requestQueue)
```
    Associates this request with the given queue. The request queue will be notified when this request has finished.
    
    Returns:
    
    This Request object to allow for chaining.
  - setSequence
```
public final Request<?> setSequence(int sequence)
```
    Sets the sequence number of this request. Used by RequestQueue.
    
    Returns:
    
    This Request object to allow for chaining.
  - getSequence
```
public final int getSequence()
```
    Returns the sequence number of this request.
  - getUrl
```
public java.lang.String getUrl()
```
    Returns the URL of this request.
  - getCacheKey
```
public java.lang.String getCacheKey()
```
    Returns the cache key for this request. By default, this is the URL.
  - setCacheEntry
```
public Request<?> setCacheEntry(Cache.Entry entry)
```
    Annotates this request with an entry retrieved for it from cache. Used for cache coherency support.
    
    Returns:
    
    This Request object to allow for chaining.
  - getCacheEntry
```
public Cache.Entry getCacheEntry()
```
    Returns the annotated cache entry, or null if there isn't one.
  - cancel
```
public void cancel()
```
    Mark this request as canceled. No callback will be delivered.
  - isCanceled
```
public boolean isCanceled()
```
    Returns true if this request has been canceled.
  - getHeaders
```
public java.util.Map<java.lang.String,java.lang.String> getHeaders()
                                                            throws AuthFailureError
```
    Returns a list of extra HTTP headers to go along with this request. Can throw AuthFailureError as authentication may be required to provide these values.
    
    Throws:
    
    AuthFailureError - In the event of auth failure
  - getPostParams
```
@Deprecated
protected java.util.Map<java.lang.String,java.lang.String> getPostParams()
                                                                               throws AuthFailureError
```
    Deprecated. Use getParams() instead.
    
    Returns a Map of POST parameters to be used for this request, or null if a simple GET should be used. Can throw AuthFailureError as authentication may be required to provide these values.
    Note that only one of getPostParams() and getPostBody() can return a non-null value.
    
    Throws:
    
    AuthFailureError - In the event of auth failure
  - getPostParamsEncoding
```
@Deprecated
protected java.lang.String getPostParamsEncoding()
```
    Deprecated. Use getParamsEncoding() instead.
    Returns which encoding should be used when converting POST parameters returned by getPostParams() into a raw POST body.
    This controls both encodings:
    1. The string encoding used when converting parameter names and values into bytes prior to URL encoding them.
    2. The string encoding used when converting the URL encoded parameters into a raw byte array.
  - getPostBodyContentType
```
@Deprecated
public java.lang.String getPostBodyContentType()
```
    Deprecated. Use getBodyContentType() instead.
  - getPostBody
```
@Deprecated
public byte[] getPostBody()
                                throws AuthFailureError
```
    Deprecated. Use getBody() instead.
    
    Returns the raw POST body to be sent.
    
    Throws:
    
    AuthFailureError - In the event of auth failure
  - getParams
```
protected java.util.Map<java.lang.String,java.lang.String> getParams()
                                                              throws AuthFailureError
```
    Returns a Map of parameters to be used for a POST or PUT request. Can throw AuthFailureError as authentication may be required to provide these values.
    Note that you can directly override getBody() for custom data.
    
    Throws:
    
    AuthFailureError - in the event of auth failure
  - getParamsEncoding
```
protected java.lang.String getParamsEncoding()
```
    Returns which encoding should be used when converting POST or PUT parameters returned by getParams() into a raw POST or PUT body.
    This controls both encodings:
    1. The string encoding used when converting parameter names and values into bytes prior to URL encoding them.
    2. The string encoding used when converting the URL encoded parameters into a raw byte array.
  - getBodyContentType
```
public java.lang.String getBodyContentType()
```
  - getBody
```
public byte[] getBody()
               throws AuthFailureError
```
    Returns the raw POST or PUT body to be sent.
    
    Throws:
    
    AuthFailureError - in the event of auth failure
  - encodeParameters
```
private byte[] encodeParameters(java.util.Map<java.lang.String,java.lang.String> params,
                                java.lang.String paramsEncoding)
```
    Converts params into an application/x-www-form-urlencoded encoded string.
  - setShouldCache
```
public final Request<?> setShouldCache(boolean shouldCache)
```
    Set whether or not responses to this request should be cached.
    
    Returns:
    
    This Request object to allow for chaining.
  - shouldCache
```
public final boolean shouldCache()
```
    Returns true if responses to this request should be cached.
  - getPriority
```
public Request.Priority getPriority()
```
    Returns the Request.Priority of this request; Request.Priority.NORMAL by default.
  - getTimeoutMs
```
public final int getTimeoutMs()
```
    Returns the socket timeout in milliseconds per retry attempt. (This value can be changed per retry attempt if a backoff is specified via backoffTimeout()). If there are no retry attempts remaining, this will cause delivery of a TimeoutError error.
  - getRetryPolicy
```
public RetryPolicy getRetryPolicy()
```
    Returns the retry policy that should be used for this request.
  - markDelivered
```
public void markDelivered()
```
    Mark this request as having a response delivered on it. This can be used later in the request's lifetime for suppressing identical responses.
  - hasHadResponseDelivered
```
public boolean hasHadResponseDelivered()
```
    Returns true if this request has had a response delivered for it.
  - parseNetworkResponse
```
protected abstract Response<T> parseNetworkResponse(NetworkResponse response)
```
    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.
    
    Parameters:
    
    response - Response from the network
    
    Returns:
    
    The parsed response, or null in the case of an error
  - parseNetworkError
```
protected VolleyError parseNetworkError(VolleyError volleyError)
```
    Subclasses can override this method to parse 'networkError' and return a more specific error.
    The default implementation just returns the passed 'networkError'.
    
    Parameters:
    
    volleyError - the error retrieved from the network
    
    Returns:
    
    an NetworkError augmented with additional information
  - deliverResponse
```
protected abstract void deliverResponse(T response)
```
    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.
    
    Parameters:
    
    response - The parsed response returned by parseNetworkResponse(NetworkResponse)
  - deliverError
```
public void deliverError(VolleyError error)
```
    Delivers error message to the ErrorListener that the Request was initialized with.
    
    Parameters:
    
    error - Error details
  - compareTo
```
public int compareTo(Request<T> other)
```
    Our comparator sorts from high to low priority, and secondarily by sequence number to provide FIFO ordering.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Request<T>>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Request<T>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PARAMS_ENCODING

mEventLog

mMethod

mUrl

mDefaultTrafficStatsTag

mErrorListener

mSequence

mRequestQueue

mShouldCache

mCanceled

mResponseDelivered

mRequestBirthTime

SLOW_REQUEST_THRESHOLD_MS

mRetryPolicy

mCacheEntry

mTag

Constructor Detail

Request

Request

Method Detail

getMethod

setTag

getTag

getTrafficStatsTag

findDefaultTrafficStatsTag

setRetryPolicy

addMarker

finish

setRequestQueue

setSequence

getSequence

getUrl

getCacheKey

setCacheEntry

getCacheEntry

cancel

isCanceled

getHeaders

getPostParams

getPostParamsEncoding

getPostBodyContentType

getPostBody

getParams

getParamsEncoding

getBodyContentType

getBody

encodeParameters

setShouldCache

shouldCache

getPriority

getTimeoutMs

getRetryPolicy

markDelivered

hasHadResponseDelivered

parseNetworkResponse

parseNetworkError

deliverResponse

deliverError

compareTo

toString