com.licel.jcardsim.base

Class Simulator

java.lang.Object

com.licel.jcardsim.base.Simulator

All Implemented Interfaces:

CardInterface, JavaCardInterface

Direct Known Subclasses:

JavaxSmartCardInterface

public class Simulator
extends Object
implements JavaCardInterface

Simulates a JavaCard.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATR_SYSTEM_PROPERTY
static String	DEFAULT_ATR
protected SimulatorRuntime	runtime The simulator runtime

Constructor Summary

Constructors

Modifier	Constructor and Description
	Simulator() Create a Simulator object using the default SimulatorRuntime.
	Simulator(SimulatorRuntime runtime) Create a Simulator object using a provided Runtime.
protected	Simulator(SimulatorRuntime runtime, Properties properties)

Method Summary

Modifier and Type	Method and Description
void	changeProtocol(String protocol) Switch protocol Supported protocols are: T=0 (alias: *) T=1 T=CL, TYPE_A, T0 (alias: T=CL) T=CL, TYPE_A, T1 T=CL, TYPE_B, T0 T=CL, TYPE_B, T1
javacard.framework.AID	createApplet(javacard.framework.AID aid, byte[] bArray, short bOffset, byte bLength) Create Applet instance in Simulator
void	deleteApplet(javacard.framework.AID aid) Delete an applet
byte[]	getATR() Returns ATR
String	getProtocol()
protected byte	getProtocolByte(String protocol)
javacard.framework.AID	installApplet(javacard.framework.AID aid, Class<? extends javacard.framework.Applet> appletClass) Install Applet into Simulator without installing data
javacard.framework.AID	installApplet(javacard.framework.AID aid, Class<? extends javacard.framework.Applet> appletClass, byte[] bArray, short bOffset, byte bLength) Install Applet into Simulator.
javacard.framework.AID	installApplet(javacard.framework.AID aid, String appletClassName, byte[] appletContents, byte[] bArray, short bOffset, byte bLength) Install Applet into Simulator.
javacard.framework.AID	installApplet(javacard.framework.AID aid, String appletClassName, byte[] bArray, short bOffset, byte bLength) Install Applet into Simulator.
javacard.framework.AID	loadApplet(javacard.framework.AID aid, Class<? extends javacard.framework.Applet> appletClass) Load Applet into Simulator
javacard.framework.AID	loadApplet(javacard.framework.AID aid, String appletClassName) Load Applet into Simulator
javacard.framework.AID	loadApplet(javacard.framework.AID aid, String appletClassName, byte[] appletJarContents) Load Applet into Simulator
void	reset() Powerdown/Powerup
void	resetRuntime()
boolean	selectApplet(javacard.framework.AID aid) Select applet by it's AID It's method must be called before start working with applet instance
byte[]	selectAppletWithResult(javacard.framework.AID aid) Select applet by it's AID It's method must be called before start working with applet instance
byte[]	transmitCommand(byte[] command) Transmit APDU to previous selected applet If no applet was selected returns byte[2] with status word 0x6986 (Command not allowed (no current EF))

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ATR

public static final String DEFAULT_ATR

See Also:

Constant Field Values

ATR_SYSTEM_PROPERTY

public static final String ATR_SYSTEM_PROPERTY

See Also:

Constant Field Values

runtime

protected final SimulatorRuntime runtime

The simulator runtime

Constructor Detail

Simulator

public Simulator()

Create a Simulator object using the default SimulatorRuntime.

• All Simulator instances share one SimulatorRuntime.
• SimulatorRuntime#resetRuntime is called
• If your want multiple independent simulators use Simulator(SimulatorRuntime)

Simulator

public Simulator(SimulatorRuntime runtime)

Create a Simulator object using a provided Runtime.

• SimulatorRuntime#resetRuntime is called

Parameters:

runtime - SimulatorRuntime instance to use

Throws:

NullPointerException - if runtime is null

Simulator

protected Simulator(SimulatorRuntime runtime,
                    Properties properties)

Method Detail

loadApplet

public javacard.framework.AID loadApplet(javacard.framework.AID aid,
                                         String appletClassName,
                                         byte[] appletJarContents)
                                  throws javacard.framework.SystemException

Description copied from interface: JavaCardInterface

Load Applet into Simulator

Specified by:

loadApplet in interface JavaCardInterface

Parameters:

aid - applet aid

appletClassName - fully qualified applet class name Strin

appletJarContents - contains a byte array containing a jar file with an applet and its dependent classes

Returns:

applet AID

Throws:

javacard.framework.SystemException - if appletClass not instanceof javacard.framework.Applet

loadApplet

public javacard.framework.AID loadApplet(javacard.framework.AID aid,
                                         String appletClassName)
                                  throws javacard.framework.SystemException

Description copied from interface: JavaCardInterface

Load Applet into Simulator

Specified by:

loadApplet in interface JavaCardInterface

Parameters:

aid - applet aid

appletClassName - fully qualified applet class name String

Returns:

applet AID

Throws:

javacard.framework.SystemException - if appletClass not instanceof javacard.framework.Applet

loadApplet

public javacard.framework.AID loadApplet(javacard.framework.AID aid,
                                         Class<? extends javacard.framework.Applet> appletClass)
                                  throws javacard.framework.SystemException

Load Applet into Simulator

Parameters:

aid - applet aid

appletClass - applet class

Returns:

applet AID

Throws:

javacard.framework.SystemException - if appletClass not instanceof javacard.framework.Applet

createApplet

public javacard.framework.AID createApplet(javacard.framework.AID aid,
                                           byte[] bArray,
                                           short bOffset,
                                           byte bLength)
                                    throws javacard.framework.SystemException

Description copied from interface: JavaCardInterface

Create Applet instance in Simulator

Specified by:

createApplet in interface JavaCardInterface

Parameters:

aid - applet aid

bArray - the array containing installation parameters

bOffset - the starting offset in bArray

bLength - the length in bytes of the parameter data in bArray

Returns:

applet AID

Throws:

javacard.framework.SystemException - if exception in Applet.install(..) method occurs.

installApplet

public javacard.framework.AID installApplet(javacard.framework.AID aid,
                                            Class<? extends javacard.framework.Applet> appletClass)
                                     throws javacard.framework.SystemException

Install Applet into Simulator without installing data

Parameters:

aid - applet aid or null

appletClass - applet class

Returns:

applet AID

Throws:

javacard.framework.SystemException - if appletClass not instanceof javacard.framework.Applet

installApplet

public javacard.framework.AID installApplet(javacard.framework.AID aid,
                                            Class<? extends javacard.framework.Applet> appletClass,
                                            byte[] bArray,
                                            short bOffset,
                                            byte bLength)
                                     throws javacard.framework.SystemException

Install Applet into Simulator. This method is equal to: loadApplet(...); createApplet(...);

Parameters:

aid - applet aid or null

appletClass - applet class

bArray - the array containing installation parameters

bOffset - the starting offset in bArray

bLength - the length in bytes of the parameter data in bArray

Returns:

applet AID

Throws:

javacard.framework.SystemException - if appletClass not instanceof javacard.framework.Applet

installApplet

public javacard.framework.AID installApplet(javacard.framework.AID aid,
                                            String appletClassName,
                                            byte[] bArray,
                                            short bOffset,
                                            byte bLength)
                                     throws javacard.framework.SystemException

Description copied from interface: JavaCardInterface

Install Applet into Simulator. This method is equal to: loadApplet(...); createApplet(...);

Specified by:

installApplet in interface JavaCardInterface

Parameters:

aid - applet aid or null

appletClassName - fully qualified applet class name Strin

bArray - the array containing installation parameters

bOffset - the starting offset in bArray

bLength - the length in bytes of the parameter data in bArray

Returns:

applet AID

Throws:

javacard.framework.SystemException - if appletClass not instanceof javacard.framework.Applet

installApplet

public javacard.framework.AID installApplet(javacard.framework.AID aid,
                                            String appletClassName,
                                            byte[] appletContents,
                                            byte[] bArray,
                                            short bOffset,
                                            byte bLength)
                                     throws javacard.framework.SystemException

Description copied from interface: JavaCardInterface

Install Applet into Simulator. This method is equal to: loadApplet(...); createApplet(...);

Specified by:

installApplet in interface JavaCardInterface

Parameters:

aid - applet aid or null

appletClassName - fully qualified applet class name Strin

appletContents - Contains a byte array containing a jar file with an applet and its dependent classes

bArray - the array containing installation parameters

bOffset - the starting offset in bArray

bLength - the length in bytes of the parameter data in bArray

Returns:

applet AID

Throws:

javacard.framework.SystemException - if appletClass not instanceof javacard.framework.Applet

deleteApplet

public void deleteApplet(javacard.framework.AID aid)

Delete an applet

Parameters:

aid - applet aid

selectApplet

public boolean selectApplet(javacard.framework.AID aid)
                     throws javacard.framework.SystemException

Description copied from interface: JavaCardInterface

Select applet by it's AID It's method must be called before start working with applet instance

Specified by:

selectApplet in interface JavaCardInterface

Parameters:

aid - appletId

Returns:

true if applet selection success

Throws:

javacard.framework.SystemException

selectAppletWithResult

public byte[] selectAppletWithResult(javacard.framework.AID aid)
                              throws javacard.framework.SystemException

Description copied from interface: JavaCardInterface

Select applet by it's AID It's method must be called before start working with applet instance

Specified by:

selectAppletWithResult in interface JavaCardInterface

Parameters:

aid - appletId

Returns:

byte array

Throws:

javacard.framework.SystemException

transmitCommand

public byte[] transmitCommand(byte[] command)

Description copied from interface: CardInterface

Transmit APDU to previous selected applet If no applet was selected returns byte[2] with status word 0x6986 (Command not allowed (no current EF))

Specified by:

transmitCommand in interface CardInterface

Parameters:

command - command apdu

Returns:

response APDU

See Also:

CommandAPDU, ResponseAPDU

reset

public void reset()

Description copied from interface: CardInterface

Powerdown/Powerup

Specified by:

reset in interface CardInterface

resetRuntime

public final void resetRuntime()

getATR

public byte[] getATR()

Description copied from interface: CardInterface

Returns ATR

Specified by:

getATR in interface CardInterface

Returns:

ATR bytes

getProtocolByte

protected byte getProtocolByte(String protocol)

changeProtocol

public void changeProtocol(String protocol)

Description copied from interface: JavaCardInterface

Switch protocol Supported protocols are:

• T=0 (alias: *)
• T=1
• T=CL, TYPE_A, T0 (alias: T=CL)
• T=CL, TYPE_A, T1
• T=CL, TYPE_B, T0
• T=CL, TYPE_B, T1

Specified by:

changeProtocol in interface JavaCardInterface

Parameters:

protocol - protocol to use

See Also:

JavaCardInterface.changeProtocol(String)

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface JavaCardInterface

Returns:

the current protocol string

See Also:

JavaCardInterface.getProtocol()