com.gsma.services.nfc

Class NfcController

java.lang.Object

com.gsma.services.nfc.NfcController

public class NfcController
extends Object

This class handles the NFC Controller.

Since:

TS.26 V4.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NfcController.Callbacks This interface provide callback methods for NfcController class.

Method Summary

Methods

Modifier and Type	Method and Description
OffHostService	defineOffHostService(String description, String SEName) Create a new "Off-Host" service.
void	deleteOffHostService(OffHostService service) Delete an existing dynamically created "Off-Host" service.
void	disableCardEmulationMode(NfcController.Callbacks cb) Deprecated. When NFC controller supports HCE and Application ID (AID) routing
void	enableCardEmulationMode(NfcController.Callbacks cb) Deprecated. When NFC controller supports HCE and Application ID (AID) routing
void	enableNfcController(NfcController.Callbacks cb) Asks the system to enable the NFC Controller.
static void	getDefaultController(Context context, NfcController.Callbacks cb) Helper for getting an instance of the NFC Controller.
OffHostService	getDefaultOffHostService() Return the "Off-Host" service related to the current selected "Tap&Pay" menu entry.
OffHostService[]	getOffHostServices() Return the list of "Off-Host" services belonging to the calling application (defined through the Manifest or created dynamically).
boolean	isCardEmulationEnabled() Check if the Card Emulation mode is enabled or disabled.
boolean	isEnabled() Check if the NFC Controller is enabled or disabled.

Methods inherited from class java.lang.Object

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

Method Detail

getDefaultController

public static void getDefaultController(Context context,
                        NfcController.Callbacks cb)

Helper for getting an instance of the NFC Controller.

Parameters:

context - Calling application's context

cb - Callback interface

Since:

TS.26 V4.1

isEnabled

public boolean isEnabled()

Check if the NFC Controller is enabled or disabled.

Returns:

true if the NFC adapter is enabled; false otherwise

Since:

TS.26 V4.1 (REQ_093)

enableNfcController

public void enableNfcController(NfcController.Callbacks cb)

Asks the system to enable the NFC Controller. User input is required to enable NFC.
A question will be asked if the user wants to enable NFC or not.
This question shall be generated within the OS context.

Parameters:

cb - Callback interface

Since:

TS.26 V4.1 (REQ_093)

isCardEmulationEnabled

public boolean isCardEmulationEnabled()

Check if the Card Emulation mode is enabled or disabled.

Returns:

true if the Card Emulation mode is enabled; false otherwise

Since:

TS.26 V4.1 (REQ_126)

enableCardEmulationMode

public void enableCardEmulationMode(NfcController.Callbacks cb)

Deprecated. When NFC controller supports HCE and Application ID (AID) routing

Asks the system to enable the Card Emulation mode.
Change is not persistent and SHALL be overridden by the following events:

• Turning OFF and ON the NFC Controller
• Full power cycle of the handset

Parameters:

cb - Callback interface

Throws:

IllegalStateException - Indicate that NFC Controller is not enabled.

SecurityException - Application is not allowed to use this API.

• When UICC is the "active" SE,
  only applications signed with certificates stored in the UICC are granted to call this API.
• When eSE is the "active" SE,
  only applications signed with system certificates are granted to call this API.

Since:

TS.26 V4.1 (REQ_126)

disableCardEmulationMode

public void disableCardEmulationMode(NfcController.Callbacks cb)

Deprecated. When NFC controller supports HCE and Application ID (AID) routing

Asks the system to disable the Card Emulation mode.
Change is not persistent and SHALL be overridden by the following events:

• Turning OFF and ON the NFC Controller
• Full power cycle of the handset

Parameters:

cb - Callback interface

Throws:

SecurityException - Application is not allowed to use this API.

• When UICC is the "active" SE,
  only applications signed with certificates stored in the UICC are granted to call this API.
• When eSE is the "active" SE,
  only applications signed with system certificates are granted to call this API.

Since:

TS.26 V4.1 (REQ_126)

defineOffHostService

public OffHostService defineOffHostService(String description,
                                  String SEName)

Create a new "Off-Host" service. This creation, and any further modifications to the OffHostService, will only be applied when OffHostService.commit() is called.

Parameters:

description - Description of the "Off-Host" service

SEName - Secure Element name holding the "Off-Host" service

Returns:

An instance of an OffHostService class

Throws:

IllegalArgumentException - Method is invoked with null or an illegal argument.

UnsupportedOperationException - Indicate that Host Card Emulation (HCE) is not supported.

Since:

TS.26 V6.0 (REQ_127)

See Also:

SIM Alliance Open Mobile APIs for Secure Element name guidelines

deleteOffHostService

public void deleteOffHostService(OffHostService service)

Delete an existing dynamically created "Off-Host" service. Any changes to this object will only be applied when OffHostService.commit() is called.

Parameters:

service - Instance of an OffHostService class to be deleted

Throws:

IllegalArgumentException - Method is invoked with null or an illegal argument.

UnsupportedOperationException - Indicate that the service has been defined through the Manifest and cannot be deleted.

Since:

TS.26 V6.0 (REQ_127)

getOffHostServices

public OffHostService[] getOffHostServices()

Return the list of "Off-Host" services belonging to the calling application
(defined through the Manifest or created dynamically).

Returns:

A list of OffHostService instances or null if no such instance exists.

Since:

TS.26 V6.0 (REQ_127)

getDefaultOffHostService

public OffHostService getDefaultOffHostService()

Return the "Off-Host" service related to the current selected "Tap&Pay" menu entry.

Returns:

A OffHostService instance
or null if the "Tap&Pay" menu entry has not been created by the calling application.

Since:

TS.26 V6.0 (REQ_127)