com.symbol.emdk.sam

Class SAM

java.lang.Object

com.symbol.emdk.sam.SAM

public class SAM
extends java.lang.Object

SAM class will represent and provides access to the physical SAMs

 
 	Example Usage:
  List<SAM> connectedSAMList = samManager.enumerateSAMs();
  SAM sam = connectedSAMList.get(0);
  SAMType samType = sam.getSamType();
  SAMType SAMStatus = sam.getSamStatus();
  sam.connect();
  sam.transceive(byte[],short,boolean);
  sam.disconnect();
 
 

Method Summary

Modifier and Type	Method and Description
void	connect() Connects to the SAM.
void	disconnect() Disconnects from SAM.
int	getSamIndex() This method will return the slot index of the SAM.
SAMType	getSamType() This method will return the type of the SAM (i.e MIFARE, CALYPSO, FELICA)
byte[]	getSmartCardATR() Gets the SmartCard ATR.
boolean	isConnected() This method will return the current SAM status whether the SAM is connected or not.
int	setSmartCardPPS(byte fd, byte protocol) Sets the SmartCard PPS (Protocol and Parameters Selection).
byte[]	transceive(byte[] apdu, short responseLength, boolean userFormattedProtocolFrame) The method will be used to send the APDUs to the SAM.

Methods inherited from class java.lang.Object

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

Method Detail

connect

public void connect()
             throws SAMException

Connects to the SAM. If an another application is connected to the same SAM, this will a SAMException. You may use isConnected() to determine if you have already connected to the SAM. You must call disconnect() when you are done using the SAM, otherwise it will remain locked and be unavailable to other applications.

 
 Example Usage:
 sam.connect();
 
 

Throws:

SAMException - The exception will thrown if the connection to the SAM fails.

disconnect

public void disconnect()

Disconnects from SAM. This method releases the SAM hardware resources for other application to use. You must call this as soon as you're done using the SAM

 
 Example Usage:
 sam.disconnect();
 
 

transceive

public byte[] transceive(byte[] apdu,
                         short responseLength,
                         boolean userFormattedProtocolFrame)
                  throws SAMException

The method will be used to send the APDUs to the SAM. Exception will be thrown in an error.

 
 Example Usage:
 sam.transceive(byte[],short,boolean);
 
 

Parameters:

apdu - Command APDU

responseLength - Length of expected response. Pass this parameter as 0, when expected response length is unknown while calling this API.

userFormattedProtocolFrame - This parameter applicable for only T1 protocol. Typically user will provide this parameter as false. true: User provides frame header, Command APDU (C-APDU) and trailer. false: User provides only Command APDU (C-APDU). Typically user will provide this parameter as false.

Returns:

byte[]

Throws:

SAMException - Exception will be thrown if any error occurs while executing transceive call

isConnected

public boolean isConnected()

This method will return the current SAM status whether the SAM is connected or not.

Returns:

boolean

getSamType

public SAMType getSamType()

This method will return the type of the SAM (i.e MIFARE, CALYPSO, FELICA)

Returns:

SAMType

getSamIndex

public int getSamIndex()

This method will return the slot index of the SAM. The indexes starting from 1.

Returns:

int

getSmartCardATR

public byte[] getSmartCardATR()
                       throws SAMException

Gets the SmartCard ATR. Exception will be thrown in an error.

 
 Example Usage:
 sam.getSmartCardATR();
 
 

Returns:

byte[] Returns a byte[] of 33 bytes on success.

Throws:

SAMException - Exception will be thrown if any error occurs while executing the API call.

setSmartCardPPS

public int setSmartCardPPS(byte fd,
                           byte protocol)
                    throws SAMException

Sets the SmartCard PPS (Protocol and Parameters Selection). Exception will be thrown in an unknown error.

 
 Example Usage:
 int result = sam.setSmartCardPPS(byte);
 if(result==0){
     //Success
 }else{
     //failure
 }
 
 

Parameters:

fd - fd - Dividers for calculating the correct SAM clock. fd= Fi/Di ratio

Returns:

boolean Returns true or false based on for success or failure.

Throws:

SAMException