SHOW Signed

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 cleanNow(int) methods invoked.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 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_DEVICE_LOCK

public static final int EVENT_DEVICE_LOCK
Indicates the device has been locked (either by the user or through the password timeout).
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

EVENT_IDLE_TIMEOUT

public static final int EVENT_IDLE_TIMEOUT
Indicates the device has been idle for some set time (as configured by the user.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

EVENT_IN_HOLSTER

public static final int EVENT_IN_HOLSTER
Indicates the user has placed the device in its holster.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

EVENT_IT_POLICY_CHANGED

public static final int EVENT_IT_POLICY_CHANGED
Indicates that IT policy has changed.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

EVENT_MEMORY_CLEANER

public static final int EVENT_MEMORY_CLEANER
Indicates the MemoryCleaner application is initiating this clean event.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

EVENT_OTA_SYNC_TRANSACTION_STOPPED

public 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.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

EVENT_PERSISTENT_CONTENT_CLEAN

public static final int EVENT_PERSISTENT_CONTENT_CLEAN
Indicates that all plaintext objects should be cleaned.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

EVENT_POWER_DOWN

public static final int EVENT_POWER_DOWN
Indicates a system power down is about to occur.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

EVENT_PROGRAMMATIC_CLEAN

public static final int EVENT_PROGRAMMATIC_CLEAN
Indicates a programmatic clean has been initiated.

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

Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

EVENT_SYNC_START

public static final int EVENT_SYNC_START
Indicates a synchronize operation between the desktop and device has begun.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

EVENT_SYNC_STOPPED

public static final int EVENT_SYNC_STOPPED
Indicates a synchronize operation between the desktop and device has ended.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

EVENT_TIME_CHANGED

public static final int EVENT_TIME_CHANGED
Indicates the user has changed either the timezone or the time.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Method Detail

cleanNow

public 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.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getDescription

public 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.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2007 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.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.