Package com.digi.android.watchdog

Class ApplicationWatchdogManager

java.lang.Object

com.digi.android.watchdog.ApplicationWatchdogManager

public class ApplicationWatchdogManager
extends java.lang.Object

This class provides access to the application watchdog service.

It allows you to initialize the application watchdog service for your application in order to shut it down in case of failure. It also allows to execute a pending intent after application is terminated.

Unless noted, all application watchdog API methods require the com.digi.android.permission.WATCHDOG permission. If your application does not have this permission it will not be able to interact with the application watchdog API.

See Also:

SystemWatchdogManager

Field Summary

Fields

Modifier and Type	Field	Description
static long	MINIMUM_WATCHDOG_TIMEOUT	Minimum configurable timeout for the application watchdog service: milliseconds.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
long	getTimeout()	Returns the configured application watchdog service timeout for the calling application.
void	init(long timeout, android.app.PendingIntent pendingIntent)	Initializes the application watchdog service for the calling application with the given timeout (in milliseconds).
boolean	isRunning()	Returns whether the application watchdog service has been initialized for the calling application or not.
void	refresh()	Refreshes your application watchdog.
void	stop()	Stops the application watchdog service for the calling application.

Methods inherited from class java.lang.Object

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

Field Detail

MINIMUM_WATCHDOG_TIMEOUT

public static final long MINIMUM_WATCHDOG_TIMEOUT

Minimum configurable timeout for the application watchdog service: milliseconds.

See Also:

Constant Field Values

Constructor Detail

ApplicationWatchdogManager

public ApplicationWatchdogManager(android.content.Context context)

Class constructor. Instantiates a new ApplicationWatchdogManager for the given application.

The ApplicationWatchdogManager allows your application to interact with the application watchdog service.

Parameters:

context - Android application context for which the application watchdog manager will be instantiated.

Throws:

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

Method Detail

init

public void init(long timeout,
                 android.app.PendingIntent pendingIntent)

Initializes the application watchdog service for the calling application with the given timeout (in milliseconds).

This method registers the calling application to the application watchdog service in order to take specific actions on application failure. If the application fails to refresh the watchdog in the specified timeout, the application will be shut down and the given pending intent will be executed. This pending intent can be used to restart application when it fails.

Your application will be automatically removed from the application watchdog service once it is shut down due to failure. It is your responsibility to stop the application watchdog service on your application if it is manually terminated. The application watchdog service must be initialized again in your application once it is shut down and restarted.

You can remove your application from the application watchdog service using the stop() method.

Parameters:

timeout - Watchdog timeout in milliseconds.

pendingIntent - Pending intent to execute when application is shut down due to watchdog timeout. Can be null.

Throws:

java.lang.IllegalArgumentException - If timeout is not valid.

java.lang.UnsupportedOperationException - If the application watchdog service has been already initialized for the calling application.

See Also:

MINIMUM_WATCHDOG_TIMEOUT, getTimeout(), isRunning(), refresh(), stop()

getTimeout

public long getTimeout()

Returns the configured application watchdog service timeout for the calling application.

This method can only be called once the application watchdog service has been initialized for the calling application, otherwise an UnsupportedOperationException will be thrown.

Returns:

The configured watchdog service timeout for the calling application (in milliseconds).

Throws:

java.lang.UnsupportedOperationException - If the application watchdog service has not been initialized for the calling application.

See Also:

init(long, PendingIntent), isRunning(), refresh(), stop()

isRunning

public boolean isRunning()

Returns whether the application watchdog service has been initialized for the calling application or not.

Returns:

true if the application watchdog service has been initialized for the calling application, false otherwise.

See Also:

init(long, PendingIntent), getTimeout(), refresh(), stop()

stop

public void stop()

Stops the application watchdog service for the calling application.

Following this call, the application is no longer required to send refresh requests to the application watchdog service.

Throws:

java.lang.UnsupportedOperationException - If the application watchdog service has not been initialized for the calling application.

See Also:

init(long, PendingIntent), getTimeout(), isRunning(), refresh()

refresh

public void refresh()

Refreshes your application watchdog.

Throws:

java.lang.UnsupportedOperationException - If the application watchdog service has not been initialized for the calling application.

See Also:

init(long, PendingIntent), getTimeout(), isRunning(), stop()