Package com.batch.android

Class BatchWebservice

java.lang.Object

com.batch.android.core.Webservice

com.batch.android.BatchWebservice

Direct Known Subclasses:

InboxFetchWebserviceClient, InboxSyncWebserviceClient, LocalCampaignsWebservice

public abstract class BatchWebservice
extends Webservice

Batch webservice that extends Webservice and can access SystemParameterHelper.
Contains common methods to all webservices

Nested Class Summary

Nested classes/interfaces inherited from class com.batch.android.core.Webservice

Webservice.RequestType, Webservice.WebserviceError

Field Summary

Fields

Modifier and Type	Field	Description
protected WebserviceErrorCause	lastFailureCause	Cause of the last try failure
protected int	retryCount	Number of retry done for this query

Fields inherited from class com.batch.android.core.Webservice

applicationContext, headers, isDowngradedCipher

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BatchWebservice(android.content.Context context, Webservice.RequestType type, java.lang.String baseURLFormat, java.lang.String... parameters)

Method Summary

Modifier and Type	Method	Description
protected void	addDefaultHeaders()	Add default headers to the WS request
protected PostDataProvider<JSONObject>	getPostDataProvider()	Return the POST body you want to add to the request
protected abstract java.lang.String	getPropertyParameterKey()	Get property parameter key to add parameter to the get chain
protected void	handleParameters(JSONObject body)	Read parameters from ws response
protected void	handleServerID(JSONObject body)	Read server id from ws response
protected void	onRetry(WebserviceErrorCause cause)	Called when a retry is made after a failure Nothing done here, but child may want to override it

Methods inherited from class com.batch.android.core.Webservice

addBatchApiKey, addDefaultParameters, addGetParameter, addHeaders, addParameters, addRequestSignatures, buildConnection, buildParameters, buildURL, canBypassOptOut, encode, executeRequest, formatDate, getBasicJsonResponseBody, getCryptorModeParameterKey, getCryptorTypeParameterKey, getHeaders, getParameters, getPostCryptorTypeParameterKey, getReadCryptorTypeParameterKey, getResponseErrorCause, getSignatureBody, getSpecificConnectTimeoutKey, getSpecificReadTimeoutKey, getSpecificRetryCountKey, getStandardResponseBodyIfValid, getURLSorterPatternParameterKey, isResponseValid

Methods inherited from class java.lang.Object

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

Field Detail

retryCount

protected int retryCount

Number of retry done for this query

lastFailureCause

protected WebserviceErrorCause lastFailureCause

Cause of the last try failure

Constructor Detail

BatchWebservice

protected BatchWebservice(android.content.Context context,
                          Webservice.RequestType type,
                          java.lang.String baseURLFormat,
                          java.lang.String... parameters)
                   throws java.net.MalformedURLException

Parameters:

context -

baseURLFormat - an url to format with api key (ex : http://sample.com/%s/sample)

Throws:

java.net.MalformedURLException

Method Detail

addDefaultHeaders

protected void addDefaultHeaders()

Description copied from class: Webservice

Add default headers to the WS request

Overrides:

addDefaultHeaders in class Webservice

getPostDataProvider

protected PostDataProvider<JSONObject> getPostDataProvider()

Description copied from class: Webservice

Return the POST body you want to add to the request

Specified by:

getPostDataProvider in class Webservice

Returns:

the post data provider if any, null otherwise

onRetry

protected void onRetry(WebserviceErrorCause cause)

Description copied from class: Webservice

Called when a retry is made after a failure
Nothing done here, but child may want to override it

Overrides:

onRetry in class Webservice

getPropertyParameterKey

protected abstract java.lang.String getPropertyParameterKey()

Get property parameter key to add parameter to the get chain

Returns:

property key or null if no property is wanted for this webservice

handleParameters

protected void handleParameters(JSONObject body)

Read parameters from ws response

Parameters:

body -

handleServerID

protected void handleServerID(JSONObject body)

Read server id from ws response

Parameters:

body -