org.simalliance.openmobileapi

Class SEService

java.lang.Object

org.simalliance.openmobileapi.SEService

public class SEService
extends java.lang.Object

The SEService realises the communication to available Secure Elements on the device. This is the entry point of this API. It is used to connect to the infrastructure and get access to a list of Secure Element Readers.

See Also:

SIMalliance Open Mobile API v3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SEService.CallBack Interface to receive call-backs when the service is connected.

Constructor Summary

Constructors

Constructor and Description
SEService(Context context, SEService.CallBack listener) Establishes a new connection that can be used to connect to all the Secure Elements available in the system.

Method Summary

Methods

Modifier and Type	Method and Description
Reader[]	getReaders() Returns the list of available Secure Element readers.
java.lang.String	getVersion() Returns the version of the OpenMobile API specification this implementation is based on.
boolean	isConnected() Tells whether or not the service is connected.
void	shutdown() Releases all Secure Elements resources allocated by this SEService (including any binding to an underlying service).

Methods inherited from class java.lang.Object

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

Constructor Detail

SEService

public SEService(Context context,
         SEService.CallBack listener)

Establishes a new connection that can be used to connect to all the Secure Elements available in the system. The connection process can be quite long, so it happens in an asynchronous way. It is usable only if the specified listener is called or if isConnected() returns true.
The call-back object passed as a parameter will have its serviceConnected() method called when the connection actually happen.

Parameters:

context - the context of the calling application. Cannot be null.

listener - a SEService.CallBack object. Can be null.

Method Detail

isConnected

public boolean isConnected()

Tells whether or not the service is connected.

Returns:

true if the service is connected.

getReaders

public Reader[] getReaders()
                    throws java.lang.IllegalStateException,
                           java.lang.NullPointerException

Returns the list of available Secure Element readers. There must be no duplicated objects in the returned list. All available readers shall be listed even if no card is inserted.

Returns:

The readers list, as an array of Readers. If there are no readers the returned array is of length 0.

Throws:

java.lang.NullPointerException - if context is NULL

java.lang.IllegalStateException - if the SEService object is not connected

shutdown

public void shutdown()

Releases all Secure Elements resources allocated by this SEService (including any binding to an underlying service). As a result isConnected() will return false after shutdown() was called. After this method call, the SEService object is not connected. It is recommended to call this method in the termination method of the calling application (or part of this application) which is bound to this SEService.

getVersion

public java.lang.String getVersion()

Returns the version of the OpenMobile API specification this implementation is based on.

Returns:

String containing the OpenMobile API version (e.g. "3.0").