net.sitecore.android.sdk.api

Class ScRequest<T extends ScResponse>

java.lang.Object

com.android.volley.Request<T>

net.sitecore.android.sdk.api.ScRequest<T>

Type Parameters:

T - response type.

All Implemented Interfaces:

java.lang.Comparable<Request<T>>

Direct Known Subclasses:

CreateItemRequest, DeleteItemsRequest, EditItemsRequest, ReadItemsRequest

public abstract class ScRequest<T extends ScResponse>
extends Request<T>

Base class for all sdk network requests.

Nested Class Summary

Nested classes/interfaces inherited from class com.android.volley.Request

Request.Method, Request.Priority

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	mBodyFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScRequest(int method, java.lang.String url, Response.Listener<T> successListener, Response.ErrorListener errorListener) Creates a new request with the given URL, error listener, success listener and method type.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(java.lang.String key, java.lang.String value) Adds header for request.
void	addOperationBeforeSuccessfulResponseSaved(android.content.ContentProviderOperation operation)
protected void	deliverResponse(T response) Subclasses must implement this to perform delivery of the parsed response to their listeners.
java.util.ArrayList<android.content.ContentProviderOperation>	getBeforeSaveContentProviderOperations()
byte[]	getBody() Encodes body to UTF-8 and converts it to bytes.
java.lang.String	getBodyContentType() Returns content type.
java.util.Map<java.lang.String,java.lang.String>	getHeaders() Returns request headers.
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 Response<T>	parseNetworkResponse(NetworkResponse response) Subclasses must implement this to parse the raw network response and return an appropriate response type.
protected abstract ScResponse	parseResponse(java.lang.String response)
java.lang.String	toString() Returns string representation of the ScRequest.

Methods inherited from class com.android.volley.Request

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

Methods inherited from class java.lang.Object

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

Field Detail

mBodyFields

protected java.util.Map<java.lang.String,java.lang.String> mBodyFields

Constructor Detail

ScRequest

protected ScRequest(int method,
         java.lang.String url,
         Response.Listener<T> successListener,
         Response.ErrorListener errorListener)

Creates a new request with the given URL, error listener, success listener and method type.

Parameters:

method - method type, one of the Method

url - endpoint url

successListener - success listener for request

errorListener - error listener for request

Method Detail

parseResponse

protected abstract ScResponse parseResponse(java.lang.String response)
                                     throws org.json.JSONException

Throws:

org.json.JSONException

addOperationBeforeSuccessfulResponseSaved

public void addOperationBeforeSuccessfulResponseSaved(android.content.ContentProviderOperation operation)

getBeforeSaveContentProviderOperations

public java.util.ArrayList<android.content.ContentProviderOperation> getBeforeSaveContentProviderOperations()

addHeader

public void addHeader(java.lang.String key,
             java.lang.String value)

Adds header for request.

Parameters:

key - header name

value - header value

See Also:

getHeaders()

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()
                                                            throws AuthFailureError

Returns request headers.

Overrides:

getHeaders in class Request<T extends ScResponse>

Returns:

Map of headers

Throws:

AuthFailureError - In the event of auth failure

See Also:

addHeader(String, String)

getBodyContentType

public java.lang.String getBodyContentType()

Returns content type.

Overrides:

getBodyContentType in class Request<T extends ScResponse>

Returns:

String content type.

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 extends ScResponse>

Parameters:

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

parseNetworkResponse

protected 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 extends ScResponse>

Parameters:

response - Response from the network

Returns:

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

getParams

protected java.util.Map<java.lang.String,java.lang.String> getParams()
                                                              throws AuthFailureError

Description copied from class: Request

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 Request.getBody() for custom data.

Overrides:

getParams in class Request<T extends ScResponse>

Throws:

AuthFailureError - in the event of auth failure

getBody

public byte[] getBody()
               throws AuthFailureError

Encodes body to UTF-8 and converts it to bytes.

Overrides:

getBody in class Request<T extends ScResponse>

Returns:

byte[] bytes or null if UnsupportedEncodingException happened.

Throws:

AuthFailureError

toString

public java.lang.String toString()

Returns string representation of the ScRequest.

Overrides:

toString in class Request<T extends ScResponse>

Returns:

the string representation of this ScRequest