From 15e5cb568b07ed8c22616896e3a1a5305bb19b4d Mon Sep 17 00:00:00 2001 From: "Daniel.Albert@gi-de.com" Date: Thu, 11 Apr 2013 15:50:22 +0000 Subject: [PATCH] updated Javadoc for Scapi-3.0.0 --- doc/allclasses-frame.html | 4 +- doc/allclasses-noframe.html | 4 +- doc/constant-values.html | 8 +- doc/deprecated-list.html | 8 +- doc/help-doc.html | 8 +- doc/index-all.html | 247 ++++++++++++++++++ doc/index.html | 2 +- .../simalliance/openmobileapi/Channel.html | 8 +- doc/org/simalliance/openmobileapi/Reader.html | 8 +- .../openmobileapi/SEService.CallBack.html | 8 +- .../simalliance/openmobileapi/SEService.html | 8 +- .../simalliance/openmobileapi/Session.html | 156 +++++------ .../openmobileapi/class-use/Channel.html | 175 ------------- .../openmobileapi/class-use/Reader.html | 173 ------------ .../class-use/SEService.CallBack.html | 165 ------------ .../openmobileapi/class-use/SEService.html | 181 ------------- .../openmobileapi/class-use/Session.html | 173 ------------ .../openmobileapi/package-frame.html | 4 +- .../openmobileapi/package-summary.html | 8 +- .../openmobileapi/package-tree.html | 8 +- doc/overview-summary.html | 25 +- doc/overview-tree.html | 8 +- 22 files changed, 390 insertions(+), 999 deletions(-) create mode 100644 doc/index-all.html delete mode 100644 doc/org/simalliance/openmobileapi/class-use/Channel.html delete mode 100644 doc/org/simalliance/openmobileapi/class-use/Reader.html delete mode 100644 doc/org/simalliance/openmobileapi/class-use/SEService.CallBack.html delete mode 100644 doc/org/simalliance/openmobileapi/class-use/SEService.html delete mode 100644 doc/org/simalliance/openmobileapi/class-use/Session.html diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html index 54cf76b..9843451 100644 --- a/doc/allclasses-frame.html +++ b/doc/allclasses-frame.html @@ -2,12 +2,12 @@ - + All Classes - + diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html index 07ba192..926df82 100644 --- a/doc/allclasses-noframe.html +++ b/doc/allclasses-noframe.html @@ -2,12 +2,12 @@ - + All Classes - + diff --git a/doc/constant-values.html b/doc/constant-values.html index 32f61da..4fb4646 100644 --- a/doc/constant-values.html +++ b/doc/constant-values.html @@ -2,12 +2,12 @@ - + Constant Field Values - + @@ -109,7 +109,7 @@

-SmartCard API V2.4.0 +SmartCard API V3.0.0 @@ -139,6 +139,6 @@


-
SEEK for AndroidCopyright 2012, Giesecke & Devrient GmbH
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH
diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html index c8447ea..bef0427 100644 --- a/doc/deprecated-list.html +++ b/doc/deprecated-list.html @@ -2,12 +2,12 @@ - + Deprecated List - + @@ -109,7 +109,7 @@

-SmartCard API V2.4.0 +SmartCard API V3.0.0 @@ -139,6 +139,6 @@


-
SEEK for AndroidCopyright 2012, Giesecke & Devrient GmbH
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH
diff --git a/doc/help-doc.html b/doc/help-doc.html index 951ada5..993298e 100644 --- a/doc/help-doc.html +++ b/doc/help-doc.html @@ -2,12 +2,12 @@ - + API Help - + @@ -182,7 +182,7 @@

-SmartCard API V2.4.0 +SmartCard API V3.0.0 @@ -212,6 +212,6 @@


-
SEEK for AndroidCopyright 2012, Giesecke & Devrient GmbH
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH
diff --git a/doc/index-all.html b/doc/index-all.html new file mode 100644 index 0000000..7dc75c5 --- /dev/null +++ b/doc/index-all.html @@ -0,0 +1,247 @@ + + + + + + +Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +C G I O R S T
+

+C

+
+
Channel - Class in org.simalliance.openmobileapi
Instances of this class represent an ISO7816-4 channel opened to a secure + element.
close() - +Method in class org.simalliance.openmobileapi.Channel +
Closes this channel to the Secure Element. +
close() - +Method in class org.simalliance.openmobileapi.Session +
Close the connection with the Secure Element. +
closeChannels() - +Method in class org.simalliance.openmobileapi.Session +
Close any channel opened on this session. +
closeSessions() - +Method in class org.simalliance.openmobileapi.Reader +
Close all the sessions opened on this reader. +
+
+

+G

+
+
getATR() - +Method in class org.simalliance.openmobileapi.Session +
Get the Answer to Reset of this Secure Element. +
getName() - +Method in class org.simalliance.openmobileapi.Reader +
Return the user-friendly name of this reader. +
getReader() - +Method in class org.simalliance.openmobileapi.Session +
Get the reader that provides this session. +
getReaders() - +Method in class org.simalliance.openmobileapi.SEService +
Returns the list of available Secure Element readers. +
getSelectResponse() - +Method in class org.simalliance.openmobileapi.Channel +
Returns the data as received from the application select command inclusively the status word. +
getSEService() - +Method in class org.simalliance.openmobileapi.Reader +
Return the Secure Element service this reader is bound to. +
getSession() - +Method in class org.simalliance.openmobileapi.Channel +
Get the session that has opened this channel. +
+
+

+I

+
+
isBasicChannel() - +Method in class org.simalliance.openmobileapi.Channel +
Returns a boolean telling if this channel is the basic channel. +
isClosed() - +Method in class org.simalliance.openmobileapi.Channel +
Tells if this channel is closed. +
isClosed() - +Method in class org.simalliance.openmobileapi.Session +
Tells if this session is closed. +
isConnected() - +Method in class org.simalliance.openmobileapi.SEService +
Tells whether or not the service is connected. +
isSecureElementPresent() - +Method in class org.simalliance.openmobileapi.Reader +
Check if a Secure Element is present in this reader. +
+
+

+O

+
+
openBasicChannel(byte[]) - +Method in class org.simalliance.openmobileapi.Session +
Get an access to the basic channel, as defined in the ISO/IEC 7816-4 specification (the one that has + number 0). +
openLogicalChannel(byte[]) - +Method in class org.simalliance.openmobileapi.Session +
Open a logical channel with the Secure Element, selecting the Applet + represented by the given AID. +
openSession() - +Method in class org.simalliance.openmobileapi.Reader +
Connects to a secure element in this reader. +
org.simalliance.openmobileapi - package org.simalliance.openmobileapi
 
+
+

+R

+
+
Reader - Class in org.simalliance.openmobileapi
Instances of this class represent Secure Element Readers connected to this + device.
+
+

+S

+
+
serviceConnected(SEService) - +Method in interface org.simalliance.openmobileapi.SEService.CallBack +
Called by the framework when the service is connected. +
SEService - Class in org.simalliance.openmobileapi
The SEService realises the communication to available Secure Elements on the + device.
SEService(Context, SEService.CallBack) - +Constructor for class org.simalliance.openmobileapi.SEService +
Establishes a new connection that can be used to connect to all the + Secure Elements available in the system. +
SEService.CallBack - Interface in org.simalliance.openmobileapi
Interface to receive call-backs when the service is connected.
Session - Class in org.simalliance.openmobileapi
Instances of this class represent a connection session to one of the secure + elements available on the device.
shutdown() - +Method in class org.simalliance.openmobileapi.SEService +
Releases all Secure Elements resources allocated by this SEService. +
+
+

+T

+
+
transmit(byte[]) - +Method in class org.simalliance.openmobileapi.Channel +
Transmit an APDU command (as per ISO7816-4) to the secure element and + wait for the response. +
+
+C G I O R S T + + + + + + + + + + + + + + +
+SmartCard API V3.0.0 +
+ + + +
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH
+ + diff --git a/doc/index.html b/doc/index.html index fa1bf48..0b0de50 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled) diff --git a/doc/org/simalliance/openmobileapi/Channel.html b/doc/org/simalliance/openmobileapi/Channel.html index 885c39d..15fc6fa 100644 --- a/doc/org/simalliance/openmobileapi/Channel.html +++ b/doc/org/simalliance/openmobileapi/Channel.html @@ -2,12 +2,12 @@ - + Channel - + @@ -332,7 +332,7 @@

-SmartCard API V2.4.0 +SmartCard API V3.0.0 @@ -368,6 +368,6 @@


-
SEEK for AndroidCopyright 2012, Giesecke & Devrient GmbH
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH
diff --git a/doc/org/simalliance/openmobileapi/Reader.html b/doc/org/simalliance/openmobileapi/Reader.html index 1191eb0..1786eda 100644 --- a/doc/org/simalliance/openmobileapi/Reader.html +++ b/doc/org/simalliance/openmobileapi/Reader.html @@ -2,12 +2,12 @@ - + Reader - + @@ -290,7 +290,7 @@

-SmartCard API V2.4.0 +SmartCard API V3.0.0 @@ -326,6 +326,6 @@


-
SEEK for AndroidCopyright 2012, Giesecke & Devrient GmbH
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH
diff --git a/doc/org/simalliance/openmobileapi/SEService.CallBack.html b/doc/org/simalliance/openmobileapi/SEService.CallBack.html index 49d7877..95ddcff 100644 --- a/doc/org/simalliance/openmobileapi/SEService.CallBack.html +++ b/doc/org/simalliance/openmobileapi/SEService.CallBack.html @@ -2,12 +2,12 @@ - + SEService.CallBack - + @@ -174,7 +174,7 @@

-SmartCard API V2.4.0 +SmartCard API V3.0.0 @@ -210,6 +210,6 @@


-
SEEK for AndroidCopyright 2012, Giesecke & Devrient GmbH
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH
diff --git a/doc/org/simalliance/openmobileapi/SEService.html b/doc/org/simalliance/openmobileapi/SEService.html index def8352..75a036e 100644 --- a/doc/org/simalliance/openmobileapi/SEService.html +++ b/doc/org/simalliance/openmobileapi/SEService.html @@ -2,12 +2,12 @@ - + SEService - + @@ -300,7 +300,7 @@

-SmartCard API V2.4.0 +SmartCard API V3.0.0 @@ -336,6 +336,6 @@


-
SEEK for AndroidCopyright 2012, Giesecke & Devrient GmbH
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH
diff --git a/doc/org/simalliance/openmobileapi/Session.html b/doc/org/simalliance/openmobileapi/Session.html index 5953464..46056f2 100644 --- a/doc/org/simalliance/openmobileapi/Session.html +++ b/doc/org/simalliance/openmobileapi/Session.html @@ -2,12 +2,12 @@ - + Session - + @@ -202,6 +202,79 @@

+

+getReader

+
+public Reader getReader()
+
+
Get the reader that provides this session. +

+

+ +
Returns:
The Reader object.
+
+
+
+ +

+getATR

+
+public byte[] getATR()
+
+
Get the Answer to Reset of this Secure Element.
+ The returned byte array can be null if the ATR for this Secure Element + is not available. +

+

+ +
Returns:
the ATR as a byte array or null.
+
+
+
+ +

+close

+
+public void close()
+
+
Close the connection with the Secure Element. This will close any + channels opened by this application with this Secure Element. +

+

+
+
+
+
+ +

+isClosed

+
+public boolean isClosed()
+
+
Tells if this session is closed. +

+

+ +
Returns:
true if the session is closed, false otherwise.
+
+
+
+ +

+closeChannels

+
+public void closeChannels()
+
+
Close any channel opened on this session. +

+

+ +
Throws: +
IOException
+
+
+
+

openBasicChannel

@@ -241,7 +314,7 @@ 

SecurityException - if the calling application cannot be granted access to this AID or the default application on this session. -
NoSuchElementException - if an Applet with the defined AID does not exist in the SE +
NoSuchElementException - if an Applet with the defined AID does not exist in the SE

@@ -277,78 +350,7 @@

SecurityException - if the calling application cannot be granted access to this AID or the default application on this session. -
NoSuchElementException - if an Applet with the defined AID does not exist in the SE or a logical channel is already open to a non-multiselectable applet -
- -
- -

-close

-
-public void close()
-
-
Close the connection with the Secure Element. This will close any - channels opened by this application with this Secure Element. -

-

-
-
-
-
- -

-isClosed

-
-public boolean isClosed()
-
-
Tells if this session is closed. -

-

- -
Returns:
true if the session is closed, false otherwise.
-
-
-
- -

-getATR

-
-public byte[] getATR()
-
-
Get the Answer to Reset of this Secure Element.
- The returned byte array can be null if the ATR for this Secure Element - is not available. -

-

- -
Returns:
the ATR as a byte array or null.
-
-
-
- -

-getReader

-
-public Reader getReader()
-
-
Get the reader that provides this session. -

-

- -
Returns:
The Reader object.
-
-
-
- -

-closeChannels

-
-public void closeChannels()
-
-
Close any channel opened on this session. -

-

-
+
NoSuchElementException - if an Applet with the defined AID does not exist in the SE or a logical channel is already open to a non-multiselectable applet
@@ -375,7 +377,7 @@

-SmartCard API V2.4.0 +SmartCard API V3.0.0 @@ -411,6 +413,6 @@


-
SEEK for AndroidCopyright 2012, Giesecke & Devrient GmbH
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH
diff --git a/doc/org/simalliance/openmobileapi/class-use/Channel.html b/doc/org/simalliance/openmobileapi/class-use/Channel.html deleted file mode 100644 index 7395f67..0000000 --- a/doc/org/simalliance/openmobileapi/class-use/Channel.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - -Uses of Class org.simalliance.openmobileapi.Channel - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- -
- - - -
-
-

-Uses of Class
org.simalliance.openmobileapi.Channel

-
- - - - - -
-Uses of Channel in org.simalliance.openmobileapi
-  -

- - - - - - - - - - - - - -
Methods in org.simalliance.openmobileapi that return Channel
- ChannelSession.openBasicChannel(byte[] aid) - -
-          Get an access to the basic channel, as defined in the ISO/IEC 7816-4 specification (the one that has - number 0).
- ChannelSession.openLogicalChannel(byte[] aid) - -
-          Open a logical channel with the Secure Element, selecting the Applet - represented by the given AID.
-  -

-


- - - - - - - - - - - - - - - -
-SmartCard API V2.3.0 -
- - - -
-SEEK for Android
Copyright 2011, Giesecke & Devrient GmbH - - diff --git a/doc/org/simalliance/openmobileapi/class-use/Reader.html b/doc/org/simalliance/openmobileapi/class-use/Reader.html deleted file mode 100644 index ae0c0e8..0000000 --- a/doc/org/simalliance/openmobileapi/class-use/Reader.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - -Uses of Class org.simalliance.openmobileapi.Reader - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- -
- - - -
-
-

-Uses of Class
org.simalliance.openmobileapi.Reader

-
- - - - - -
-Uses of Reader in org.simalliance.openmobileapi
-  -

- - - - - - - - - - - - - -
Methods in org.simalliance.openmobileapi that return Reader
- ReaderSession.getReader() - -
-          Get the reader that provides this session.
- Reader[]SEService.getReaders() - -
-          Returns the list of available Secure Element readers.
-  -

-


- - - - - - - - - - - - - - - -
-SmartCard API V2.3.0 -
- - - -
-SEEK for Android
Copyright 2011, Giesecke & Devrient GmbH - - diff --git a/doc/org/simalliance/openmobileapi/class-use/SEService.CallBack.html b/doc/org/simalliance/openmobileapi/class-use/SEService.CallBack.html deleted file mode 100644 index f1ed31b..0000000 --- a/doc/org/simalliance/openmobileapi/class-use/SEService.CallBack.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - -Uses of Interface org.simalliance.openmobileapi.SEService.CallBack - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- -
- - - -
-
-

-Uses of Interface
org.simalliance.openmobileapi.SEService.CallBack

-
- - - - - -
-Uses of SEService.CallBack in org.simalliance.openmobileapi
-  -

- - - - - - - - -
Constructors in org.simalliance.openmobileapi with parameters of type SEService.CallBack
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.
-  -

-


- - - - - - - - - - - - - - - -
-SmartCard API V2.3.0 -
- - - -
-SEEK for Android
Copyright 2011, Giesecke & Devrient GmbH - - diff --git a/doc/org/simalliance/openmobileapi/class-use/SEService.html b/doc/org/simalliance/openmobileapi/class-use/SEService.html deleted file mode 100644 index c70676c..0000000 --- a/doc/org/simalliance/openmobileapi/class-use/SEService.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - -Uses of Class org.simalliance.openmobileapi.SEService - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- -
- - - -
-
-

-Uses of Class
org.simalliance.openmobileapi.SEService

-
- - - - - -
-Uses of SEService in org.simalliance.openmobileapi
-  -

- - - - - - - - - -
Methods in org.simalliance.openmobileapi that return SEService
- SEServiceReader.getSEService() - -
-          Return the Secure Element service this reader is bound to.
-  -

- - - - - - - - - -
Methods in org.simalliance.openmobileapi with parameters of type SEService
- voidSEService.CallBack.serviceConnected(SEService service) - -
-          Called by the framework when the service is connected.
-  -

-


- - - - - - - - - - - - - - - -
-SmartCard API V2.3.0 -
- - - -
-SEEK for Android
Copyright 2011, Giesecke & Devrient GmbH - - diff --git a/doc/org/simalliance/openmobileapi/class-use/Session.html b/doc/org/simalliance/openmobileapi/class-use/Session.html deleted file mode 100644 index 45290c1..0000000 --- a/doc/org/simalliance/openmobileapi/class-use/Session.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - -Uses of Class org.simalliance.openmobileapi.Session - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- -
- - - -
-
-

-Uses of Class
org.simalliance.openmobileapi.Session

-
- - - - - -
-Uses of Session in org.simalliance.openmobileapi
-  -

- - - - - - - - - - - - - -
Methods in org.simalliance.openmobileapi that return Session
- SessionChannel.getSession() - -
-          Get the session that has opened this channel.
- SessionReader.openSession() - -
-          Connects to a secure element in this reader.
-  -

-


- - - - - - - - - - - - - - - -
-SmartCard API V2.3.0 -
- - - -
-SEEK for Android
Copyright 2011, Giesecke & Devrient GmbH - - diff --git a/doc/org/simalliance/openmobileapi/package-frame.html b/doc/org/simalliance/openmobileapi/package-frame.html index 3730bfa..701e661 100644 --- a/doc/org/simalliance/openmobileapi/package-frame.html +++ b/doc/org/simalliance/openmobileapi/package-frame.html @@ -2,12 +2,12 @@ - + org.simalliance.openmobileapi - + diff --git a/doc/org/simalliance/openmobileapi/package-summary.html b/doc/org/simalliance/openmobileapi/package-summary.html index 7fba96c..0ac6599 100644 --- a/doc/org/simalliance/openmobileapi/package-summary.html +++ b/doc/org/simalliance/openmobileapi/package-summary.html @@ -2,12 +2,12 @@ - + org.simalliance.openmobileapi - + @@ -150,7 +150,7 @@

-SmartCard API V2.4.0 +SmartCard API V3.0.0 @@ -180,6 +180,6 @@


-
SEEK for AndroidCopyright 2012, Giesecke & Devrient GmbH
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH
diff --git a/doc/org/simalliance/openmobileapi/package-tree.html b/doc/org/simalliance/openmobileapi/package-tree.html index 99fd950..9669cf0 100644 --- a/doc/org/simalliance/openmobileapi/package-tree.html +++ b/doc/org/simalliance/openmobileapi/package-tree.html @@ -2,12 +2,12 @@ - + org.simalliance.openmobileapi Class Hierarchy - + @@ -118,7 +118,7 @@

-SmartCard API V2.4.0 +SmartCard API V3.0.0 @@ -148,6 +148,6 @@


-
SEEK for AndroidCopyright 2012, Giesecke & Devrient GmbH
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH
diff --git a/doc/overview-summary.html b/doc/overview-summary.html index 37fa290..c80aa82 100644 --- a/doc/overview-summary.html +++ b/doc/overview-summary.html @@ -2,12 +2,12 @@ - + Overview - + @@ -78,8 +78,9 @@
- -SIMalliance Open Mobile API interface that provides access to secure elements available in the device. + +SIMalliance Open Mobile API interface that provides access to secure elements +available in the device.

See:
@@ -100,8 +101,16 @@

 

-

-SIMalliance Open Mobile API interface that provides access to secure elements available in the device. The Open Mobile API is based on an object oriented concept and simplifies the handling and management of Secure Element resources for applications. The entry point of the interface is the class SEService. This class initializes the available Secure Element resources and offers these for communication. Then the interface package contains additional classes like Reader, Session and Channel which allow a structured management of communication streams to different Secure Elements. See at: SIMalliance Open Mobile API v2.02 +

+SIMalliance Open Mobile API interface that provides access to secure elements +available in the device. The Open Mobile API is based on an object oriented +concept and simplifies the handling and management of Secure Element resources +for applications. The entry point of the interface is the class SEService. +This class initializes the available Secure Element resources and offers these +for communication. Then the interface package contains additional classes like +Reader, Session and Channel which allow a structured management of +communication streams to different Secure Elements. See at: SIMalliance Open Mobile API v2.02

@@ -129,7 +138,7 @@ -SmartCard API V2.4.0 +SmartCard API V3.0.0 @@ -159,6 +168,6 @@


-
SEEK for AndroidCopyright 2012, Giesecke & Devrient GmbH
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH
diff --git a/doc/overview-tree.html b/doc/overview-tree.html index a5872f3..973fd85 100644 --- a/doc/overview-tree.html +++ b/doc/overview-tree.html @@ -2,12 +2,12 @@ - + Class Hierarchy - + @@ -120,7 +120,7 @@

-SmartCard API V2.4.0 +SmartCard API V3.0.0 @@ -150,6 +150,6 @@


-
SEEK for AndroidCopyright 2012, Giesecke & Devrient GmbH
+
SEEK for AndroidCopyright 2013 Giesecke & Devrient GmbH