SmartCardInterface

java.lang.Object
- com.cloudpos.jniinterface.SmartCardInterface

public class SmartCardInterface
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SmartCardInterface.NotifyEvent

Nested Classes
Modifier and Type	Class and Description
`static class`	`SmartCardInterface.NotifyEvent`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_SLOT`
`static int`	`EVENT_CANCEL`
`static int`	`EVENT_ERROR`
`static int`	`EVENT_INSERT_CARD`
`static int`	`EVENT_NONE`
`static int`	`EVENT_REMOVE_CARD`
`static boolean`	`isCardPresent`
`static int[]`	`LOGICAL_ID`
`static int[]`	`LOGICAL_ID_Q1`
`static int`	`MAX_NUMBER`
`static SmartCardInterface.NotifyEvent`	`notifyEvent`
`static java.lang.Object`	`objAbsent`
`static java.lang.Object`	`objPresent`
`static int`	`SLOT_INDEX_NONE`
`static java.lang.String`	`TAG`

Constructor Summary

Constructors
Constructor and Description

SmartCardInterface()

Constructors
Constructor and Description
`SmartCardInterface()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`callBack(int slotIndex, int eventID)` Call back method, called by driver.
`static void`	`clear()` 对于得到的通知事件,用完后即丢弃
`static int`	`close(int handle)` The function initialize the smart card reader.
`static void`	`notifyCancel()`
`static int`	`open(int nSlotIndex)` The function open the specified card.
`static int`	`powerOff(int handle)` Power off the smart card in the slot opened before.
`static int`	`powerOn(int handle, byte[] byteArrayATR, SmartCardSlotInfo info)` Power on the smart card in the slot opened before.
`static int`	`queryMaxNumber()` The function query the max the slot in this smart card reader.
`static int`	`queryPresence(int nSlotIndex)` The function query whether the smart card is not existent Attention : not every slot can support this function.
`static int`	`read(int handle, int nAreaType, byte[] byteArryData, int nStartAddress)` This function is responsible for reading data from memory card
`static int`	`setCardInfo(int handle, int nBuadrate, int nVoltage)` Set PSAM card baudrate and validate.
`static int`	`setSlotInfo(int handle, SmartCardSlotInfo info)` The function set the slot control information
`static int`	`touch(int handle)` Deprecated. Check whether this is a card on the smart card reader return value : == 0 : no card >0 : find a card <0 : error code
`static int`	`transmit(int handle, byte[] byteArrayAPDU, byte[] byteArrayResponse)` The function sends a command Application Protocol Data Unit(APDU) to a card and retrieve the response APDU, plus the status words SW1 and SW2.
`static int`	`verify_extend(int handle, byte[] byteArrayAPDU, int nAddress)` Verification of data, for AT88SC102 card
`static int`	`verify(int handle, byte[] byteArrayAPDU)` Verification of data
`static void`	`waitForCardAbsent(int timeout)`
`static void`	`waitForCardPresent(int timeout)`
`static int`	`write(int handle, int nAreaType, byte[] byteArryData, int nStartAddress)` This function is responsible for writing data to memory card.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TAG
```
public static final java.lang.String TAG
```
    See Also:
    
    Constant Field Values
  - LOGICAL_ID
```
public static final int[] LOGICAL_ID
```
  - LOGICAL_ID_Q1
```
public static final int[] LOGICAL_ID_Q1
```
  - MAX_NUMBER
```
public static final int MAX_NUMBER
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SLOT
```
public static final int DEFAULT_SLOT
```
    See Also:
    
    Constant Field Values
  - EVENT_INSERT_CARD
```
public static final int EVENT_INSERT_CARD
```
    See Also:
    
    Constant Field Values
  - EVENT_REMOVE_CARD
```
public static final int EVENT_REMOVE_CARD
```
    See Also:
    
    Constant Field Values
  - EVENT_ERROR
```
public static final int EVENT_ERROR
```
    See Also:
    
    Constant Field Values
  - EVENT_CANCEL
```
public static final int EVENT_CANCEL
```
    See Also:
    
    Constant Field Values
  - EVENT_NONE
```
public static final int EVENT_NONE
```
    See Also:
    
    Constant Field Values
  - SLOT_INDEX_NONE
```
public static final int SLOT_INDEX_NONE
```
    See Also:
    
    Constant Field Values
  - objPresent
```
public static java.lang.Object objPresent
```
  - objAbsent
```
public static java.lang.Object objAbsent
```
  - notifyEvent
```
public static SmartCardInterface.NotifyEvent notifyEvent
```
  - isCardPresent
```
public static boolean isCardPresent
```
- Constructor Detail
  - SmartCardInterface
```
public SmartCardInterface()
```
- Method Detail
  - queryMaxNumber
```
public static int queryMaxNumber()
```
    The function query the max the slot in this smart card reader.
    
    Returns:
    
    value < 0 : error code, value == 0 : not defined, value > 0 ; number of slot.
  - queryPresence
```
public static int queryPresence(int nSlotIndex)
```
    The function query whether the smart card is not existent Attention : not every slot can support this function.
    
    Parameters:
    
    nSlotIndex - : Slot index, from 0 to ( MAX_SUPPORT_SLOT - 1 )
    
    Returns:
    
    value < 0 : error code, value == 0 : not existent, value > 0 ; be existent.
  - open
```
public static int open(int nSlotIndex)
```
    The function open the specified card.
    
    Parameters:
    
    nSlotIndex - : Slot index, from 0 to (MAX_SUPPORT_SLOT - 1).
    
    Returns:
    
    value < 0 : error code, value >= 0: success, return value is a handle.This handle will be employed bye other API as an input parameter
  - close
```
public static int close(int handle)
```
    The function initialize the smart card reader.
    
    Parameters:
    
    handle - : returned from method of open.
    
    Returns:
    
    value >= 0, success in starting the process; value < 0, error code.
  - setCardInfo
```
public static int setCardInfo(int handle,
                              int nBuadrate,
                              int nVoltage)
```
    Set PSAM card baudrate and validate.
    
    Parameters:
    
    handle - returned from method of open。
    
    nBuadrate - value is 9600 or 38400.
    
    nVoltage - value is 1, 2, 3 means 1.8v, 3v, 5v.
  - powerOn
```
public static int powerOn(int handle,
                          byte[] byteArrayATR,
                          SmartCardSlotInfo info)
```
    Power on the smart card in the slot opened before.
    
    Parameters:
    
    Handle - : returned from method of open.
    
    byteArrayATR - : ATR
    
    info - : card information
    
    Returns:
    
    value >= 0 : ATR length value < 0 : error code
  - powerOff
```
public static int powerOff(int handle)
```
    Power off the smart card in the slot opened before.
    
    Parameters:
    
    handle - : return from method of open
    
    Returns:
    
    value >= 0, success in starting the process; value < 0, error code
  - setSlotInfo
```
public static int setSlotInfo(int handle,
                              SmartCardSlotInfo info)
```
    The function set the slot control information
    
    Parameters:
    
    Handle - ：return from method of open
    
    info - ：SmartCardSlotInfo
    
    Returns:
    
    value >= 0, success in starting the process; value < 0, error code
  - transmit
```
public static int transmit(int handle,
                           byte[] byteArrayAPDU,
                           byte[] byteArrayResponse)
```
    The function sends a command Application Protocol Data Unit(APDU) to a card and retrieve the response APDU, plus the status words SW1 and SW2.
    
    Parameters:
    
    Handle - : return from method of open
    
    byteArrayAPDU - : command of APDU
    
    byteArrayResponse - : response of command of APDU
    
    Returns:
    
    value >= 0 : response data length value < 0 : error code
  - read
```
public static int read(int handle,
                       int nAreaType,
                       byte[] byteArryData,
                       int nStartAddress)
```
    This function is responsible for reading data from memory card
    
    Parameters:
    
    handle, - return from method of open.
    
    nAreaType, - area type : 0 : main memory, 1 : protected memory 2 : security memory
    
    byteArryData - : data buffer
    
    nStartAddress - : starting address
    
    Returns:
    
    value : < 0 : error code >= 0 : data length
  - write
```
public static int write(int handle,
                        int nAreaType,
                        byte[] byteArryData,
                        int nStartAddress)
```
    This function is responsible for writing data to memory card.
    
    Parameters:
    
    handle, - return from method of open.
    
    nAreaType, - area type : 0 : main memory, 1 : protected memory 2 : security memory。
    
    byteArryData - : data buffer。
    
    nStartAddress - : starting address。
    
    Returns:
    
    value : < 0 : error code >= 0 : data length
  - verify
```
public static int verify(int handle,
                         byte[] byteArrayAPDU)
```
    Verification of data
    
    Parameters:
    
    handle, - return from method of open
    
    byteArrayAPDU - : data buffer
    
    Returns:
    
    value : < 0 : error code = 0 : failed in verifying data > 0 : success
  - verify_extend
```
public static int verify_extend(int handle,
                                byte[] byteArrayAPDU,
                                int nAddress)
```
    Verification of data, for AT88SC102 card
    
    Parameters:
    
    handle - : return from method of open
    
    byteArrayAPDU - : data buffer
    
    nAddress: - 1. 80 Security Code。 2. 688 Application Zone 1 Erase Key. 3. 1248 Application Zone 2 Erase Key。
    
    Returns:
    
    value : < 0 : error code, >= 0: success.
  - touch
```
public static int touch(int handle)
```
    Deprecated. Check whether this is a card on the smart card reader return value : == 0 : no card >0 : find a card <0 : error code
  - callBack
```
public static void callBack(int slotIndex,
                            int eventID)
```
    Call back method, called by driver.
    
    Parameters:
    
    nEvent -
    
    nData -
  - notifyCancel
```
public static void notifyCancel()
```
  - waitForCardPresent
```
public static void waitForCardPresent(int timeout)
                               throws java.lang.InterruptedException
```
    Throws:
    
    java.lang.InterruptedException
  - waitForCardAbsent
```
public static void waitForCardAbsent(int timeout)
                              throws java.lang.InterruptedException
```
    Throws:
    
    java.lang.InterruptedException
  - clear
```
public static void clear()
```
    对于得到的通知事件,用完后即丢弃

Class SmartCardInterface

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG

LOGICAL_ID

LOGICAL_ID_Q1

MAX_NUMBER

DEFAULT_SLOT

EVENT_INSERT_CARD

EVENT_REMOVE_CARD

EVENT_ERROR

EVENT_CANCEL

EVENT_NONE

SLOT_INDEX_NONE

objPresent

objAbsent

notifyEvent

isCardPresent

Constructor Detail

SmartCardInterface

Method Detail

queryMaxNumber

queryPresence

open

close

setCardInfo

powerOn

powerOff

setSlotInfo

transmit

read

write

verify

verify_extend

touch

callBack

notifyCancel

waitForCardPresent

waitForCardAbsent

clear