MemoryCleanerListener (BlackBerry JDE 6.0.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.rim.device.api.memorycleaner
Interface MemoryCleanerListener

All Known Implementing Classes:: LDAPPasswordCache

public interface MemoryCleanerListener

Describes functionality for listeners wanting to be notified of events that should trigger a clean of sensitive information.

Implementors of this interface must register with MemoryCleanerDaemon.addListener(net.rim.device.api.memorycleaner.MemoryCleanerListener) to receive events. Thereafter, when a clean event occurs, all registers cleaners will have their MemoryCleanerListener.cleanNow(int) methods invoked.

Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

Field Summary
	`static int`	`EVENT_DEVICE_LOCK` Indicates the device has been locked (either by the user or through the password timeout).
	`static int`	`EVENT_IDLE_TIMEOUT` Indicates the device has been idle for some set time (as configured by the user.
	`static int`	`EVENT_IN_HOLSTER` Indicates the user has placed the device in its holster.
	`static int`	`EVENT_IT_POLICY_CHANGED` Indicates that IT policy has changed.
	`static int`	`EVENT_MEMORY_CLEANER` Indicates the MemoryCleaner application is initiating this clean event.
	`static int`	`EVENT_OTA_SYNC_TRANSACTION_STOPPED` Indicates an OTA sync transaction operation has stopped within the last minute while the device was locked.
	`static int`	`EVENT_PERSISTENT_CONTENT_CLEAN` Indicates that all plaintext objects should be cleaned.
	`static int`	`EVENT_POWER_DOWN` Indicates a system power down is about to occur.
	`static int`	`EVENT_PROGRAMMATIC_CLEAN` Indicates a programmatic clean has been initiated.
	`static int`	`EVENT_SYNC_START` Indicates a synchronize operation between the desktop and device has begun.
	`static int`	`EVENT_SYNC_STOPPED` Indicates a synchronize operation between the desktop and device has ended.
	`static int`	`EVENT_TIME_CHANGED` Indicates the user has changed either the timezone or the time.

Method Summary
	`boolean`	`cleanNow(int event)` Invoked when an event occurs that should trigger a clean of sensitive information.
	`String`	`getDescription()` Invoked when the memory cleaner application must display a string about the type of listener being cleaned.

Field Detail

EVENT_IN_HOLSTER

static final int EVENT_IN_HOLSTER

Indicates the user has placed the device in its holster.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_IDLE_TIMEOUT

static final int EVENT_IDLE_TIMEOUT

Indicates the device has been idle for some set time (as configured by the user.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_SYNC_START

static final int EVENT_SYNC_START

Indicates a synchronize operation between the desktop and device has begun.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_SYNC_STOPPED

static final int EVENT_SYNC_STOPPED

Indicates a synchronize operation between the desktop and device has ended.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_MEMORY_CLEANER

static final int EVENT_MEMORY_CLEANER

Indicates the MemoryCleaner application is initiating this clean event.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_TIME_CHANGED

static final int EVENT_TIME_CHANGED

Indicates the user has changed either the timezone or the time.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_DEVICE_LOCK

static final int EVENT_DEVICE_LOCK

Indicates the device has been locked (either by the user or through the password timeout).

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_PROGRAMMATIC_CLEAN

static final int EVENT_PROGRAMMATIC_CLEAN

Indicates a programmatic clean has been initiated.

A programmatic clean occurs when someone invokes MemoryCleanerDaemon.cleanAll().

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_POWER_DOWN

static final int EVENT_POWER_DOWN

Indicates a system power down is about to occur.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_OTA_SYNC_TRANSACTION_STOPPED

static final int EVENT_OTA_SYNC_TRANSACTION_STOPPED

Indicates an OTA sync transaction operation has stopped within the last minute while the device was locked.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

EVENT_PERSISTENT_CONTENT_CLEAN

static final int EVENT_PERSISTENT_CONTENT_CLEAN

Indicates that all plaintext objects should be cleaned.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.2

EVENT_IT_POLICY_CHANGED

static final int EVENT_IT_POLICY_CHANGED

Indicates that IT policy has changed.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.2

Method Detail

cleanNow

boolean cleanNow(int event)

Invoked when an event occurs that should trigger a clean of sensitive information.

Parameters:: event - Constant describing the specific event (one of the defined EVENT_* fields in this class).
Returns:: True if any objects were released (hence requiring a GC); otherwise, false.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0

getDescription

String getDescription()

Invoked when the memory cleaner application must display a string about the type of listener being cleaned.

Returns:: A textual description the MemoryCleaner application can show to the user; if null, it will not be shown in the memory cleaner application but it will still be called to clean.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 4.0.0