com.cloudpos.card

Interface Card

All Known Subinterfaces:

CPUCard, FelicaCard, MemoryCard, MifareCard, MifareUltralightCard, SLE4442Card

public interface Card

The Card interface provides a general definition of card services in a POS (Point of Sale) system. It facilitates operations such as connecting or disconnecting a card to/from the card reader device and allows retrieval of basic card information like ATR (Answer To Reset), ID, and status.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROTOCOL_RFCARD_TYPE_A ISO14443 TYPE A protocol.
static int	PROTOCOL_RFCARD_TYPE_B ISO14443 TYPE B protocol.
static int	PROTOCOL_T_0 The asynchronous half-duplex communication protocol of T=0.
static int	PROTOCOL_T_1 The asynchronous half-duplex communication protocol of T=1.
static int	PROTOCOL_UNKNOWN Unknown communication protocol.
static int	STATUS_ABSENT Card slot status indicating the card is removed or absent.
static int	STATUS_CONNECTED Card slot status indicating the card is connected.
static int	STATUS_DISCONNECTED Card slot status indicating the card is disconnected.

Method Summary

Modifier and Type	Method and Description
int	getCardStatus() Retrieves the current status of the card in the card slot.
byte[]	getID() Retrieves the ID of the card.
byte[]	getIDInfo() Retrieves extended ID information of the card.
int	getProtocol() Retrieves the protocol used for communication between the card and the card slot.

Field Detail

PROTOCOL_RFCARD_TYPE_A

static final int PROTOCOL_RFCARD_TYPE_A

ISO14443 TYPE A protocol.

See Also:

Constant Field Values

PROTOCOL_RFCARD_TYPE_B

static final int PROTOCOL_RFCARD_TYPE_B

ISO14443 TYPE B protocol.

See Also:

Constant Field Values

PROTOCOL_T_0

static final int PROTOCOL_T_0

The asynchronous half-duplex communication protocol of T=0.

See Also:

Constant Field Values

PROTOCOL_T_1

static final int PROTOCOL_T_1

The asynchronous half-duplex communication protocol of T=1.

See Also:

Constant Field Values

PROTOCOL_UNKNOWN

static final int PROTOCOL_UNKNOWN

Unknown communication protocol.

See Also:

Constant Field Values

STATUS_CONNECTED

static final int STATUS_CONNECTED

Card slot status indicating the card is connected.

See Also:

Constant Field Values

STATUS_DISCONNECTED

static final int STATUS_DISCONNECTED

Card slot status indicating the card is disconnected.

See Also:

Constant Field Values

STATUS_ABSENT

static final int STATUS_ABSENT

Card slot status indicating the card is removed or absent.

See Also:

Constant Field Values

Method Detail

getID

byte[] getID()
      throws DeviceException

Retrieves the ID of the card. For contactless cards, this method gets the card ID; for contact cards, it retrieves the ATR of the card.

Returns:

A byte array containing the card ID or ATR.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

getIDInfo

byte[] getIDInfo()
          throws DeviceException

Retrieves extended ID information of the card. For contactless cards, this method returns SAK (1 byte) + ATQA (2 bytes) + ID; for contact cards, it retrieves the ATR of the card.

Returns:

A byte array containing the extended ID information.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

getProtocol

int getProtocol()
         throws DeviceException

Retrieves the protocol used for communication between the card and the card slot. The method should be called when a card is present in the card slot and the slot is active.

Returns:

An integer constant representing the communication protocol, such as PROTOCOL_RFCARD_TYPE_A, PROTOCOL_RFCARD_TYPE_B, PROTOCOL_T_0, PROTOCOL_T_1, or PROTOCOL_UNKNOWN.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

getCardStatus

int getCardStatus()
           throws DeviceException

Retrieves the current status of the card in the card slot.

Returns:

An integer indicating the card status, such as STATUS_CONNECTED, STATUS_DISCONNECTED, or STATUS_ABSENT.

Throws:

DeviceException - for standard reasons as documented in DeviceException.