com.symbol.emdk.securenfc

Class PassThruApduProcessor

java.lang.Object

com.symbol.emdk.securenfc.PassThruApduProcessor

public class PassThruApduProcessor
extends java.lang.Object

This class is designed for the NFC applications to perform secure communication with the contact-less secure cards (tags) at the low level protocol. The audience of this class are secure NFC application developers with good understanding and expertise of the secure technology they use, including the cards (tags) and SAM documentation, features and protocol. Note: This is recommended only for the secure NFC application developers who are interested getting the full control of the APDU. Other can use the SecureNfcManager.getTagTechInstance which provides simple API to securely communicate with the Smart card/tags for the supported tag technologies.

  
   Example Usage:
  	
  	public class MainActivity extends Activity implements EMDKListener {
  
  		SecureNfcManager secureNfcManager;
  		EMDKManager emdkManager;
  		PassThruApduProcessor passThruApduProcessor;
  
  		
  		protected void onCreate(Bundle savedInstanceState) {
  
  			EMDKResults results = EMDKManager.getEMDKManager(
  					getApplicationContext(), this);
  		}
  
  		
  		public void onOpened(EMDKManager emdkManager) {
  
  			this.emdkManager = emdkManager;
  
  			this.secureNfcManager = (secureNfcManager) this.emdkManager
  					.getInstance(FEATURE_TYPE.SECURENFC);
  
  			if (this.secureNfcManager != null) {
  
  			if(secureNfcMgr!= null){
  			
  				passThruApduProcessor = secureNfcMgr.getPassThruApduInstance();
  					
  			try {
  					passThruApduProcessor.enable(ProtocolType.T1);
 
  					passThruApduProcessor.disable();
  				
  				}catch (PassThruApduException e) {
 
  					e.printStackTrace();
  				}
  				
  			}
  		}
  	}
  
  		
  		public void onDestroy() {
  			if (this.emdkManager != null)
  				this.emdkManager.release();
  		}
  
  		
  		public void onClosed() {
  			this.emdkManager.release();
  		}
  
  	}
  
  
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PassThruApduProcessor.ProtocolType Communication protocol between a SAM and tag.
static class	PassThruApduProcessor.VersionType The enum to get the Smart Card stack and connected Smart Card versions.

Method Summary

Modifier and Type	Method and Description
void	disable() Closes already established connection between host device and SAM.
void	enable(PassThruApduProcessor.ProtocolType protocolType) Enables connection between host device and Secure Access Module (SAM).
java.lang.String	getVersion(PassThruApduProcessor.VersionType versionType) Retrieves version of smart card stack or connected smart card.
byte[]	process(byte[] cmdApdu, short expectedRespLength, boolean userFormattedProtocolFrame) Sends the Command APDU (C-APDU) (Application Protocol Data Unit) and receives Response APDU (R-APDU) from connected contactless smart cards.

Methods inherited from class java.lang.Object

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

Method Detail

enable

public void enable(PassThruApduProcessor.ProtocolType protocolType)
            throws PassThruApduException

Enables connection between host device and Secure Access Module (SAM).

Parameters:

protocolType - Protocol to be used for communication between card reader (SAM) and contactless cards. This parameter is added for future use only.

Throws:

PassThruApduException - The exception will be thrown if it fails to enable the smartcard.

disable

public void disable()
             throws PassThruApduException

Closes already established connection between host device and SAM.

Throws:

PassThruApduException - The exception will be thrown if it fails to disable the smartcard.

getVersion

public java.lang.String getVersion(PassThruApduProcessor.VersionType versionType)
                            throws PassThruApduException

Retrieves version of smart card stack or connected smart card.

Parameters:

versionType -

Returns:

Version string

Throws:

PassThruApduException - The exception will be thrown if it fails to retrieve version of smart card stack or connected smart card.

process

public byte[] process(byte[] cmdApdu,
                      short expectedRespLength,
                      boolean userFormattedProtocolFrame)
               throws PassThruApduException

Sends the Command APDU (C-APDU) (Application Protocol Data Unit) and receives Response APDU (R-APDU) from connected contactless smart cards. Application has to create C-APDU and send it to SAM using this API. Application should have process the R-APDU received from SAM. **Note:** This is a synchronous call and may block the main thread depending on the time process the command and its payload. The recommendation is not to be called from the main application thread.

Parameters:

cmdApdu - Command APDU (C-APDU) to be processed by smart card

expectedRespLength - 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:

Response APDU (R-APDU) received from smart card (tags).

Throws:

PassThruApduException - The exception will be thrown if it fails to process the given APDU.