com.google.android.vending.expansion.downloader

Class DownloaderClientMarshaller

java.lang.Object

com.google.android.vending.expansion.downloader.DownloaderClientMarshaller

public class DownloaderClientMarshaller
extends Object

This class binds the service API to your application client. It contains the IDownloaderClient proxy, which is used to call functions in your client as well as the Stub, which is used to call functions in the client implementation of IDownloaderClient.

The IPC is implemented using an Android Messenger and a service Binder. The connect method should be called whenever the client wants to bind to the service. It opens up a service connection that ends up calling the onServiceConnected client API that passes the service messenger in. If the client wants to be notified by the service, it is responsible for then passing its messenger to the service in a separate call.

Critical methods are startDownloadServiceIfRequired(android.content.Context, android.app.PendingIntent, java.lang.Class<?>) and CreateStub(com.google.android.vending.expansion.downloader.IDownloaderClient, java.lang.Class<?>).

When your application first starts, you should first check whether your app's expansion files are already on the device. If not, you should then call startDownloadServiceIfRequired(android.content.Context, android.app.PendingIntent, java.lang.Class<?>), which starts your DownloaderService to download the expansion files if necessary. The method returns a value indicating whether download is required or not.

If a download is required, startDownloadServiceIfRequired(android.content.Context, android.app.PendingIntent, java.lang.Class<?>) begins the download through the specified service and you should then call CreateStub(com.google.android.vending.expansion.downloader.IDownloaderClient, java.lang.Class<?>) to instantiate a member IStub object that you need in order to receive calls through your IDownloaderClient interface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOWNLOAD_REQUIRED
static int	LVL_CHECK_REQUIRED
static int	MSG_ONDOWNLOADPROGRESS
static int	MSG_ONDOWNLOADSTATE_CHANGED
static int	MSG_ONSERVICECONNECTED
static int	NO_DOWNLOAD_REQUIRED
static String	PARAM_MESSENGER
static String	PARAM_NEW_STATE
static String	PARAM_PROGRESS

Constructor Summary

Constructors

Constructor and Description
DownloaderClientMarshaller()

Method Summary

Methods

Modifier and Type	Method and Description
static IDownloaderClient	CreateProxy(android.os.Messenger msg) Returns a proxy that will marshal calls to IDownloaderClient methods
static IStub	CreateStub(IDownloaderClient itf, Class<?> downloaderService) Returns a stub object that, when connected, will listen for marshaled IDownloaderClient methods and translate them into calls to the supplied interface.
static int	startDownloadServiceIfRequired(android.content.Context context, android.content.Intent notificationClient, Class<?> serviceClass) This version assumes that the intent contains the pending intent as a parameter.
static int	startDownloadServiceIfRequired(android.content.Context context, android.app.PendingIntent notificationClient, Class<?> serviceClass) Starts the download if necessary.

Methods inherited from class java.lang.Object

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

Field Detail

MSG_ONDOWNLOADSTATE_CHANGED

public static final int MSG_ONDOWNLOADSTATE_CHANGED

See Also:

Constant Field Values

MSG_ONDOWNLOADPROGRESS

public static final int MSG_ONDOWNLOADPROGRESS

See Also:

Constant Field Values

MSG_ONSERVICECONNECTED

public static final int MSG_ONSERVICECONNECTED

See Also:

Constant Field Values

PARAM_NEW_STATE

public static final String PARAM_NEW_STATE

See Also:

Constant Field Values

PARAM_PROGRESS

public static final String PARAM_PROGRESS

See Also:

Constant Field Values

PARAM_MESSENGER

public static final String PARAM_MESSENGER

See Also:

Constant Field Values

NO_DOWNLOAD_REQUIRED

public static final int NO_DOWNLOAD_REQUIRED

See Also:

Constant Field Values

LVL_CHECK_REQUIRED

public static final int LVL_CHECK_REQUIRED

See Also:

Constant Field Values

DOWNLOAD_REQUIRED

public static final int DOWNLOAD_REQUIRED

See Also:

Constant Field Values

Constructor Detail

DownloaderClientMarshaller

public DownloaderClientMarshaller()

Method Detail

CreateProxy

public static IDownloaderClient CreateProxy(android.os.Messenger msg)

Returns a proxy that will marshal calls to IDownloaderClient methods

Parameters:

msg -

Returns:

CreateStub

public static IStub CreateStub(IDownloaderClient itf,
               Class<?> downloaderService)

Returns a stub object that, when connected, will listen for marshaled IDownloaderClient methods and translate them into calls to the supplied interface.

Parameters:

itf - An implementation of IDownloaderClient that will be called when remote method calls are unmarshaled.

downloaderService - The class for your implementation of DownloaderService.

Returns:

The IStub that allows you to connect to the service such that your IDownloaderClient receives status updates.

startDownloadServiceIfRequired

public static int startDownloadServiceIfRequired(android.content.Context context,
                                 android.app.PendingIntent notificationClient,
                                 Class<?> serviceClass)
                                          throws android.content.pm.PackageManager.NameNotFoundException

Starts the download if necessary. This function starts a flow that does ` many things. 1) Checks to see if the APK version has been checked and the metadata database updated 2) If the APK version does not match, checks the new LVL status to see if a new download is required 3) If the APK version does match, then checks to see if the download(s) have been completed 4) If the downloads have been completed, returns NO_DOWNLOAD_REQUIRED The idea is that this can be called during the startup of an application to quickly ascertain if the application needs to wait to hear about any updated APK expansion files. Note that this does mean that the application MUST be run for the first time with a network connection, even if Market delivers all of the files.

Parameters:

context - Your application Context.

notificationClient - A PendingIntent to start the Activity in your application that shows the download progress and which will also start the application when download completes.

serviceClass - the class of your imp.DownloaderService implementation

Returns:

whether the service was started and the reason for starting the service. Either NO_DOWNLOAD_REQUIRED, LVL_CHECK_REQUIRED, or DOWNLOAD_REQUIRED.

Throws:

android.content.pm.PackageManager.NameNotFoundException

startDownloadServiceIfRequired

public static int startDownloadServiceIfRequired(android.content.Context context,
                                 android.content.Intent notificationClient,
                                 Class<?> serviceClass)
                                          throws android.content.pm.PackageManager.NameNotFoundException

This version assumes that the intent contains the pending intent as a parameter. This is used for responding to alarms.

The pending intent must be in an extra with the key DownloaderService.EXTRA_PENDING_INTENT.

Parameters:

context -

notificationClient -

serviceClass - the class of the service to start

Returns:

Throws:

android.content.pm.PackageManager.NameNotFoundException