Package com.digi.android.firmwareupdate

Class FirmwareUpdateManager

java.lang.Object

com.digi.android.firmwareupdate.FirmwareUpdateManager

public class FirmwareUpdateManager
extends java.lang.Object

This class provides access to the firmware update service.

This manager allows applications to update the firmware of the device, install new applications and wipe data and cache partitions.

Unless noted, all firmware update API methods require the com.digi.android.permission.FIRMWARE_UPDATE permission. If your application does not have this permission it will not have access to any firmware update service feature.

Constructor Summary

Constructors

Constructor	Description
FirmwareUpdateManager(android.content.Context context)	Class constructor.

Method Summary

Modifier and Type	Method	Description
void	installApplication(java.lang.String applicationPath, boolean reboot)	Installs the given application.
void	installUpdatePackage(java.lang.String updatePackagePath, IFirmwareUpdateListener listener, boolean verify, java.lang.String deviceCertsZipFile)	Installs the given update package.
void	wipeCache()	Wipes the cache (/cache) partition.
void	wipeCache(java.lang.String reason)	Wipes the cache (/cache) partition.
void	wipeUserData()	Wipes the user data (/data) and cache (/cache) partitions.
void	wipeUserData(java.lang.String reason)	Wipes the user data (/data) and cache (/cache) partitions.
void	wipeUserData(java.lang.String reason, boolean shutdown)	Wipes the user data (/data) and cache (/cache) partitions.

Methods inherited from class java.lang.Object

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

Constructor Detail

FirmwareUpdateManager

public FirmwareUpdateManager(android.content.Context context)

Class constructor. Instantiates a new FirmwareUpdateManager using the given application context.

The FirmwareUpdateManager allows you to perform firmware update related operations.

Parameters:

context - Android application context.

Throws:

java.lang.NullPointerException - If context == null.

Method Detail

installUpdatePackage

public void installUpdatePackage(java.lang.String updatePackagePath,
                                 IFirmwareUpdateListener listener,
                                 boolean verify,
                                 java.lang.String deviceCertsZipFile)

Installs the given update package.

This method returns immediately. All the update process is executed on a new thread using the given listener as the communication interface.

If the update package is not located in the '/data' partition, the file is copied there before performing the update.

If the verification flag is set, the update package is verified before performing the update using the given certificates file or the system default one.

A reboot is performed in order to install the update package.

Parameters:

updatePackagePath - Full path of the update package to install.

listener - An object implementing the IFirmwareUpdateListener interface to receive firmware update progress information.

verify - true to verify the update package signature, false otherwise. Package signature will be verified using the provided certificates zip file if any. If not, the default system certificates file will be used.

deviceCertsZipFile - Full path to the zip file of certificates whose public keys will be accepted. Verification succeeds if the package is signed by the private key corresponding to any public key in this file. May be null to use the system default file, currently "/system/etc/security/otacerts.zip". This parameter only applies if verify == True

Throws:

java.lang.NullPointerException - If updatePackagePath == null or if (@code listener == null}.

See Also:

IFirmwareUpdateListener

wipeCache

public void wipeCache()
               throws java.io.IOException

Wipes the cache (/cache) partition.

A reboot is performed in order to wipe the partition.

Throws:

java.io.IOException - If there is any error preparing for the wipe.

See Also:

wipeCache(String), wipeUserData(), wipeUserData(String), wipeUserData(String, boolean)

wipeCache

public void wipeCache(java.lang.String reason)
               throws java.io.IOException

Wipes the cache (/cache) partition.

A reboot is performed in order to wipe the partition.

Parameters:

reason - Reason for the wipe if any, may be null.

Throws:

java.io.IOException - If there is any error preparing for the wipe.

See Also:

wipeCache(), wipeUserData(), wipeUserData(String), wipeUserData(String, boolean)

wipeUserData

public void wipeUserData()
                  throws java.io.IOException

Wipes the user data (/data) and cache (/cache) partitions.

A reboot is performed in order to wipe the partitions.

Throws:

java.io.IOException - If there is any error preparing for the wipe.

See Also:

wipeCache(), wipeCache(String), wipeUserData(String), wipeUserData(String, boolean)

wipeUserData

public void wipeUserData(java.lang.String reason)
                  throws java.io.IOException

Wipes the user data (/data) and cache (/cache) partitions.

A reboot is performed in order to wipe the partitions.

Parameters:

reason - Reason for the wipe if any, may be null.

Throws:

java.io.IOException - If there is any error preparing for the wipe.

See Also:

wipeCache(), wipeCache(String), wipeUserData(), wipeUserData(String, boolean)

wipeUserData

public void wipeUserData(java.lang.String reason,
                         boolean shutdown)
                  throws java.io.IOException

Wipes the user data (/data) and cache (/cache) partitions.

A reboot is performed in order to wipe the partitions.

Parameters:

reason - Reason for the wipe if any, may be null.

shutdown - true to shutdown the device instead of rebooting after performing the wipe, false otherwise.

Throws:

java.io.IOException - If there is any error preparing for the wipe.

See Also:

wipeCache(), wipeCache(String), wipeUserData(), wipeUserData(String)

installApplication

public void installApplication(java.lang.String applicationPath,
                               boolean reboot)
                        throws java.io.IOException

Installs the given application.

Parameters:

applicationPath - Full path of the application to install.

reboot - true to reboot the device after installing the application, false otherwise.

Throws:

java.io.IOException - If there is any error installing the application.

java.lang.NullPointerException - If applicationPath == null