net.rim.device.api.io.nfc.se
Class SecureElementManager

java.lang.Object
  extended by net.rim.device.api.io.nfc.se.SecureElementManager

public class SecureElementManager
extends Object

Provides access to SecureElement objects. A BlackBerry® device can have both an embedded secure element and a SIM-based secure element.

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 7.0.0

Method Summary
Category: Signed static SecureElementManager getInstance()
          Retrieves the system instance of the SecureElementManager.
Category: Signed  SecureElement getSecureElement(int seType)
          Retrieves a specific type of secure element: either embedded or SIM-based.
Category: Signed  SecureElement[] getSecureElements()
          Retrieves the list of secure elements available on the BlackBerry device.
Category: Signed  boolean isCardEmulationEnabledWhenInactive()
          Indicates whether Secure Element card emulation is enabled when the device is inactive (backlight is off, device is locked or in standby mode).
Category: Signed  boolean isCardEmulationEnabledWhenPowerOff()
          Indicates whether Secure Element card emulation is enabled when the device is powered off, or the battery is dead or removed.
Category: Signed  void setCardEmulationEnabledWhenInactive(boolean enabled)
          Sets whether card emulation should be enabled when the device is inactive (backlight is off, device is locked or in standby mode).
Category: Signed  void setCardEmulationEnabledWhenPowerOff(boolean enabled)
          Sets whether card emulation should be enabled when the device is powered off, or the battery is dead or removed.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Method Detail

getInstance

public static SecureElementManager getInstance()
Retrieves the system instance of the SecureElementManager.

Returns:
The system instance of the SecureElementManager.
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 7.0.0

getSecureElements

public SecureElement[] getSecureElements()
                                  throws NFCException
Retrieves the list of secure elements available on the BlackBerry device.

Returns:
An array of SecureElement objects available on the device, or null if none are available.
Throws:
NFCException - If the supported secure elements cannot be determined.
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 7.0.0

getSecureElement

public SecureElement getSecureElement(int seType)
                               throws NFCException
Retrieves a specific type of secure element: either embedded or SIM-based.

Parameters:
seType - Type of the secure element to retrieve. Valid values are SecureElement.SIM and SecureElement.EMBEDDED.
Returns:
Either an embedded or SIM-based SecureElement. Returns null if no secure element of the type specified is present.
Throws:
NFCException - If there was a problem determining support for the requested SecureElement.
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 7.0.0

isCardEmulationEnabledWhenInactive

public boolean isCardEmulationEnabledWhenInactive()
                                           throws NFCException
Indicates whether Secure Element card emulation is enabled when the device is inactive (backlight is off, device is locked or in standby mode).

Returns:
true if card emulation is available when the device is inactive, otherwise false.
Throws:
NFCException - If the setting cannot be determined.
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 7.0.0

setCardEmulationEnabledWhenInactive

public void setCardEmulationEnabledWhenInactive(boolean enabled)
                                         throws NFCException
Sets whether card emulation should be enabled when the device is inactive (backlight is off, device is locked or in standby mode).

Parameters:
enabled - true if card emulation should be possible in this state, otherwise false.
Throws:
NFCException - If this setting cannot be updated.
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 7.0.0

isCardEmulationEnabledWhenPowerOff

public boolean isCardEmulationEnabledWhenPowerOff()
                                           throws NFCException
Indicates whether Secure Element card emulation is enabled when the device is powered off, or the battery is dead or removed.

Returns:
true if card emulation is available when the device is powered off, or the battery is dead or removed.
Throws:
NFCException - If the setting cannot be determined.
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 7.0.0

setCardEmulationEnabledWhenPowerOff

public void setCardEmulationEnabledWhenPowerOff(boolean enabled)
                                         throws NFCException
Sets whether card emulation should be enabled when the device is powered off, or the battery is dead or removed.

Parameters:
enabled - true if card emulation should be possible in this state, otherwise false.
Throws:
NFCException - If this setting cannot be updated
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 7.0.0





Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal