com.sponsorpay.sdk.android.advertiser
Class AdvertiserCallbackSender

java.lang.Object
  
      com.sponsorpay.sdk.android.advertiser.AdvertiserCallbackSender

public class AdvertiserCallbackSender
extends 

Runs in the background the Advertiser Callback HTTP request.

Nested Class Summary

static interface

AdvertiserCallbackSender.APIResultListener Interface to be implemented by parties interested in the response from the SponsorPay server for the advertiser callback.

Field Summary

private static java.lang.String	API_PRODUCTION_RESOURCE_URL The API resource URL to contact when talking to the SponsorPay Advertiser API
private static java.lang.String	API_STAGING_RESOURCE_URL
private static java.lang.String	INSTALL_SUBID_KEY SubID URL parameter key
private java.util.Map<java.lang.String,java.lang.String>	mCustomParams Map of custom parameters to be sent in the callback request.
private HostInfo	mHostInfo Used to extract required information for the host application and device.
private HttpClient	mHttpClient The HTTP client employed to call the Sponsorpay API
private HttpUriRequest	mHttpRequest The HTTP request that will be executed to contact the API with the callback request
private HttpResponse	mHttpResponse The response returned by the SponsorPay API
private java.lang.String	mInstallSubId Install subID to report on the advertiser callback
private AdvertiserCallbackSender.APIResultListener	mListener Registered listener for the result of the advertiser callback request.
private boolean	mWasAlreadySuccessful True if the advertiser callback was sent and received a successful response in a previous invocation.
private static int	SUCCESFUL_HTTP_STATUS_CODE HTTP status code that the response should have in order to determine that the API has been contacted successfully.
private static java.lang.String	SUCCESSFUL_ANSWER_RECEIVED_KEY The key for encoding the parameter corresponding to whether a previous invocation of the advertiser callback had received a successful response.

Constructor Summary

AdvertiserCallbackSender(HostInfo hostInfo, AdvertiserCallbackSender.APIResultListener listener)
Constructor.

Method Summary

private java.lang.String	buildUrl()
protected java.lang.Boolean	doInBackground(java.lang.String... params) Method overridden from AsyncTask.
protected void	onPostExecute(java.lang.Boolean requestWasSuccessful) This method is called by the Android AsyncTask implementation in the UI thread (or the thread which invoked trigger()) when #doInBackground(AdvertiserHostInfo...) returns.
void	setCustomParams(java.util.Map<java.lang.String,java.lang.String> customParams) Sets the map of custom parameters to be sent in the callback request.
void	setInstallSubId(java.lang.String subIdValue) Sets the install subID to report on the advertiser callback.
void	setWasAlreadySuccessful(boolean value) Sets whether a previous invocation of the advertiser callback had received a successful response.
void	trigger() Triggers the callback request that contacts the Sponsorpay Advertiser API.

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESFUL_HTTP_STATUS_CODE

private static final int SUCCESFUL_HTTP_STATUS_CODE

HTTP status code that the response should have in order to determine that the API has been contacted successfully.

See Also:

Constant Field Values

API_PRODUCTION_RESOURCE_URL

private static final java.lang.String API_PRODUCTION_RESOURCE_URL

The API resource URL to contact when talking to the SponsorPay Advertiser API

See Also:

Constant Field Values

API_STAGING_RESOURCE_URL

private static final java.lang.String API_STAGING_RESOURCE_URL

See Also:

Constant Field Values

SUCCESSFUL_ANSWER_RECEIVED_KEY

private static final java.lang.String SUCCESSFUL_ANSWER_RECEIVED_KEY

The key for encoding the parameter corresponding to whether a previous invocation of the advertiser callback had received a successful response.

See Also:

Constant Field Values

INSTALL_SUBID_KEY

private static final java.lang.String INSTALL_SUBID_KEY

SubID URL parameter key

See Also:

Constant Field Values

mHttpRequest

private HttpUriRequest mHttpRequest

The HTTP request that will be executed to contact the API with the callback request

mHttpResponse

private HttpResponse mHttpResponse

The response returned by the SponsorPay API

mHttpClient

private HttpClient mHttpClient

The HTTP client employed to call the Sponsorpay API

mWasAlreadySuccessful

private boolean mWasAlreadySuccessful

True if the advertiser callback was sent and received a successful response in a previous invocation.

mInstallSubId

private java.lang.String mInstallSubId

Install subID to report on the advertiser callback

mCustomParams

private java.util.Map<java.lang.String,java.lang.String> mCustomParams

Map of custom parameters to be sent in the callback request.

mListener

private AdvertiserCallbackSender.APIResultListener mListener

Registered listener for the result of the advertiser callback request.

mHostInfo

private HostInfo mHostInfo

Used to extract required information for the host application and device. This data will be sent on the callback request.

Constructor Detail

AdvertiserCallbackSender

public AdvertiserCallbackSender(HostInfo hostInfo,
                                AdvertiserCallbackSender.APIResultListener listener)

Constructor. Sets the request callback listener and stores the host information.

See AdvertiserHostInfo and AdvertiserCallbackSender.APIResultListener.

Parameters:

hostInfo - the host information for the given device

listener - the callback listener

Method Detail

setCustomParams

public void setCustomParams(java.util.Map<java.lang.String,java.lang.String> customParams)

Sets the map of custom parameters to be sent in the callback request.

setInstallSubId

public void setInstallSubId(java.lang.String subIdValue)

Sets the install subID to report on the advertiser callback.

Parameters:

subIdValue - The install subID received on the app instalation.

setWasAlreadySuccessful

public void setWasAlreadySuccessful(boolean value)

Sets whether a previous invocation of the advertiser callback had received a successful response.

trigger

public void trigger()

Triggers the callback request that contacts the Sponsorpay Advertiser API. If and when a succesful response is received from the server, the AdvertiserCallbackSender.APIResultListener registered through the constructor #AsyncAPICaller(AdvertiserHostInfo, APIResultListener) will be notified.

buildUrl

private java.lang.String buildUrl()

doInBackground

protected java.lang.Boolean doInBackground(java.lang.String... params)

Method overridden from AsyncTask. Executed on a background thread, runs the API contact request.

Encodes the host information in the request URL, runs the request, waits for the response, parses its status code and lets the UI thread receive the result and notify the registered AdvertiserCallbackSender.APIResultListener.

Parameters:

params - Only one parameter of type String containing the request URL is expected.

Returns:

True for a successful request, false otherwise. This value will be communicated to the UI thread by the Android AsyncTask implementation.

onPostExecute

protected void onPostExecute(java.lang.Boolean requestWasSuccessful)

This method is called by the Android AsyncTask implementation in the UI thread (or the thread which invoked trigger()) when #doInBackground(AdvertiserHostInfo...) returns. It will invoke the registered AdvertiserCallbackSender.APIResultListener

Parameters:

requestWasSuccessful - true if the response has a successful status code (equal to SUCCESFUL_HTTP_STATUS_CODE). false otherwise.