Package com.batch.android.core

Class MessagePackWebservice

java.lang.Object

com.batch.android.core.Webservice

com.batch.android.core.MessagePackWebservice

All Implemented Interfaces:

TaskRunnable, java.lang.Runnable

public abstract class MessagePackWebservice
extends Webservice
implements TaskRunnable

Nested Class Summary

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

Webservice.RequestType, Webservice.WebserviceError

Field Summary

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

applicationContext, headers, isDowngradedCipher

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MessagePackWebservice(android.content.Context context, MessagePackPostDataProvider<?> dataProvider, java.lang.String urlPattern, java.lang.String... parameters)

Method Summary

Modifier and Type	Method	Description
protected static java.lang.String[]	addSchemaVersion(java.lang.String[] parameters)	Prepend the schema version into the url parameters Only used for display receipt
protected java.lang.String	getCryptorModeParameterKey()	Return the parameter key for the cryptor mode
protected java.lang.String	getCryptorTypeParameterKey()	Return the type of the get cryptor wanted for this webservice
protected java.util.Map<java.lang.String,java.lang.String>	getHeaders()	Return the specific header you want to add to the request You should override this method if you want to provide headers
protected java.lang.String	getPostCryptorTypeParameterKey()	Return the type of the post cryptor wanted for this webservice
protected MessagePackPostDataProvider<?>	getPostDataProvider()	Return the POST body you want to add to the request
protected java.lang.String	getReadCryptorTypeParameterKey()	Return the type of the read cryptor wanted for this webservice
protected java.lang.String	getSpecificConnectTimeoutKey()	Return the Parameters key to search specific connect timeout for this webservice
protected java.lang.String	getSpecificReadTimeoutKey()	Return the Parameters key to search specific read timeout for this webservice
protected java.lang.String	getSpecificRetryCountKey()	Return the Parameters key to search specific number of retry for this webservice
protected java.lang.String	getURLSorterPatternParameterKey()	Return the parameter key to get the URL sorter pattern

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

addBatchApiKey, addDefaultHeaders, addDefaultParameters, addGetParameter, addHeaders, addParameters, addRequestSignatures, buildConnection, buildParameters, buildURL, canBypassOptOut, encode, executeRequest, formatDate, getBasicJsonResponseBody, getParameters, getResponseErrorCause, getSignatureBody, getStandardResponseBodyIfValid, isResponseValid, onRetry

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Methods inherited from interface com.batch.android.core.TaskRunnable

getTaskIdentifier

Constructor Detail

MessagePackWebservice

protected MessagePackWebservice(android.content.Context context,
                                MessagePackPostDataProvider<?> dataProvider,
                                java.lang.String urlPattern,
                                java.lang.String... parameters)
                         throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

Method Detail

addSchemaVersion

protected static java.lang.String[] addSchemaVersion(java.lang.String[] parameters)

Prepend the schema version into the url parameters Only used for display receipt

Parameters:

parameters - parameters

Returns:

parameters

getHeaders

protected java.util.Map<java.lang.String,java.lang.String> getHeaders()

Description copied from class: Webservice

Return the specific header you want to add to the request
You should override this method if you want to provide headers

Overrides:

getHeaders in class Webservice

Returns:

Map of headers if any, null if you don't want any

getPostDataProvider

protected MessagePackPostDataProvider<?> 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

getPostCryptorTypeParameterKey

protected java.lang.String getPostCryptorTypeParameterKey()

Description copied from class: Webservice

Return the type of the post cryptor wanted for this webservice

Specified by:

getPostCryptorTypeParameterKey in class Webservice

Returns:

type or null if no encryption is wanted

getReadCryptorTypeParameterKey

protected java.lang.String getReadCryptorTypeParameterKey()

Description copied from class: Webservice

Return the type of the read cryptor wanted for this webservice

Specified by:

getReadCryptorTypeParameterKey in class Webservice

Returns:

type or null if no encryption is wanted

getURLSorterPatternParameterKey

protected java.lang.String getURLSorterPatternParameterKey()

Description copied from class: Webservice

Return the parameter key to get the URL sorter pattern

Specified by:

getURLSorterPatternParameterKey in class Webservice

Returns:

key of the parameter or null if no sortor is wanted

getCryptorTypeParameterKey

protected java.lang.String getCryptorTypeParameterKey()

Description copied from class: Webservice

Return the type of the get cryptor wanted for this webservice

Specified by:

getCryptorTypeParameterKey in class Webservice

Returns:

type or null if no encryption is wanted

getCryptorModeParameterKey

protected java.lang.String getCryptorModeParameterKey()

Description copied from class: Webservice

Return the parameter key for the cryptor mode

Specified by:

getCryptorModeParameterKey in class Webservice

Returns:

param key or null if no mode is provided (URLBuilder.CryptorMode.ALL will be used)

getSpecificConnectTimeoutKey

protected java.lang.String getSpecificConnectTimeoutKey()

Description copied from class: Webservice

Return the Parameters key to search specific connect timeout for this webservice

Specified by:

getSpecificConnectTimeoutKey in class Webservice

Returns:

key if we need specific value, null otherwise

getSpecificReadTimeoutKey

protected java.lang.String getSpecificReadTimeoutKey()

Description copied from class: Webservice

Return the Parameters key to search specific read timeout for this webservice

Specified by:

getSpecificReadTimeoutKey in class Webservice

Returns:

key if we need specific value, null otherwise

getSpecificRetryCountKey

protected java.lang.String getSpecificRetryCountKey()

Description copied from class: Webservice

Return the Parameters key to search specific number of retry for this webservice

Specified by:

getSpecificRetryCountKey in class Webservice

Returns:

key if we need specific value, null otherwise