com.gsma.services.nfc

Class OffHostService

java.lang.Object

com.gsma.services.nfc.OffHostService

public class OffHostService
extends Object

This class handles "Off-Host" services.

Since:

TS.26 V6.0 (REQ_127)

Method Summary

Methods

Modifier and Type	Method and Description
void	commit() Make visible/permanent all pending changes: Which are initiated by methods NfcController.defineOffHostService(java.lang.String, java.lang.String) and NfcController.deleteOffHostService(com.gsma.services.nfc.OffHostService) On OffHostService and AidGroup objects
AidGroup	defineAidGroup(String description, String category) Create a new empty group of AIDs for the "Off-Host" service.
void	deleteAidGroup(AidGroup group) Delete an existing AID group from the "Off-Host" service.
AidGroup[]	getAidGroups() Return a list of the AID groups linked to the "Off-Host" service.
Drawable	getBanner() Return the banner linked to the "Off-Host" service.
String	getDescription() Return the description of the "Off-Host" service.
String	getLocation() Return the Secure Element name which holds the "Off-Host" service.
void	setBanner(Drawable banner) Set a banner for the "Off-Host" service.
void	setBanner(int resourceID) Set a banner for the "Off-Host" service.

Methods inherited from class java.lang.Object

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

Method Detail

getLocation

public String getLocation()

Return the Secure Element name which holds the "Off-Host" service.

Returns:

Secure Element name holding the "Off-Host" service

Since:

TS.26 V6.0

See Also:

SIM Alliance Open Mobile APIs for Secure Element name guidelines

getDescription

public String getDescription()

Return the description of the "Off-Host" service.

Returns:

The Description of the "Off-Host" service

Since:

TS.26 V6.0

setBanner

public void setBanner(int resourceID)
               throws Resources.NotFoundException

Set a banner for the "Off-Host" service.

Parameters:

resourceID - The desired resource identifier.
The value 0 is an invalid identifier

Throws:

Resources.NotFoundException - Indicate that the given resourceID does not exist.

Since:

TS.26 V8.0

setBanner

public void setBanner(Drawable banner)

Set a banner for the "Off-Host" service.

Parameters:

banner - A Drawable object representing the banner.
The Drawable object has to be created from a application resource provided

Throws:

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

Since:

TS.26 V6.0

getBanner

public Drawable getBanner()

Return the banner linked to the "Off-Host" service.

Returns:

Drawable object representing the banner or null if no banner has been set

Since:

TS.26 V6.0

defineAidGroup

public AidGroup defineAidGroup(String description,
                      String category)

Create a new empty group of AIDs for the "Off-Host" service.

Parameters:

description - Description of the group of AIDs

category - Category the "Off-Host" service belongs to:

• android.nfc.cardemulation.CardEmulation.CATEGORY_PAYMENT
• android.nfc.cardemulation.CardEmulation.CATEGORY_OTHER

Returns:

An instance of an AidGroup class

Throws:

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

Since:

TS.26 V6.0

deleteAidGroup

public void deleteAidGroup(AidGroup group)

Delete an existing AID group from the "Off-Host" service.

Parameters:

group - Instance of an AidGroup class to be deleted

Throws:

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

Since:

TS.26 V6.0

getAidGroups

public AidGroup[] getAidGroups()

Return a list of the AID groups linked to the "Off-Host" service.

Returns:

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

Since:

TS.26 V6.0

commit

public void commit()
            throws InsufficientResourcesException

Make visible/permanent all pending changes:

• Which are initiated by methods NfcController.defineOffHostService(java.lang.String, java.lang.String) and NfcController.deleteOffHostService(com.gsma.services.nfc.OffHostService)
• On OffHostService and AidGroup objects

Throws:

InsufficientResourcesException - Indicate that insufficient resources are available in the routing table. Any pending updates will be discarded.

Since:

TS.26 V6.0