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
Category: Signed static int EVENT_DEVICE_LOCK
          Indicates the device has been locked (either by the user or through the password timeout).
Category: Signed static int EVENT_IDLE_TIMEOUT
          Indicates the device has been idle for some set time (as configured by the user.
Category: Signed static int EVENT_IN_HOLSTER
          Indicates the user has placed the device in its holster.
Category: Signed static int EVENT_IT_POLICY_CHANGED
          Indicates that IT policy has changed.
Category: Signed static int EVENT_MEMORY_CLEANER
          Indicates the MemoryCleaner application is initiating this clean event.
Category: Signed static int EVENT_OTA_SYNC_TRANSACTION_STOPPED
          Indicates an OTA sync transaction operation has stopped within the last minute while the device was locked.
Category: Signed static int EVENT_PERSISTENT_CONTENT_CLEAN
          Indicates that all plaintext objects should be cleaned.
Category: Signed static int EVENT_POWER_DOWN
          Indicates a system power down is about to occur.
Category: Signed static int EVENT_PROGRAMMATIC_CLEAN
          Indicates a programmatic clean has been initiated.
Category: Signed static int EVENT_SYNC_START
          Indicates a synchronize operation between the desktop and device has begun.
Category: Signed static int EVENT_SYNC_STOPPED
          Indicates a synchronize operation between the desktop and device has ended.
Category: Signed static int EVENT_TIME_CHANGED
          Indicates the user has changed either the timezone or the time.
 
Method Summary
Category: Signed  boolean cleanNow(int event)
          Invoked when an event occurs that should trigger a clean of sensitive information.
Category: Signed  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





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.