org.eclipse.keyple.core.card.message

Class SelectionStatus

java.lang.Object

org.eclipse.keyple.core.card.message.SelectionStatus

All Implemented Interfaces:

java.io.Serializable

public class SelectionStatus
extends java.lang.Object
implements java.io.Serializable

This POJO is used to transport the data related to the outcome of the card selection process. These data are:

• the status of the selection indicating if the card has matched it.
• the card's Answer To Reset (ATR) if present.
• the File Control Information (FCI) obtained in response to the SELECT command if present.

Note: when Answer To Reset or FCI are not present they are returned with a null value.

Since:

0.9

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SelectionStatus(AnswerToReset atr, ApduResponse fci, boolean isMatching) Create a Selection Status with the 3 required elements.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
AnswerToReset	getAtr() Gets the ATR coming from the card.
ApduResponse	getFci() Gets the ApduResponse from the card to the Selection Application command.
int	hashCode()
boolean	hasMatched() Tells if the selection process has been successful.

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectionStatus

public SelectionStatus(AnswerToReset atr,
                       ApduResponse fci,
                       boolean isMatching)

Create a Selection Status with the 3 required elements.

• atr contains the ATR data from the card.
  
• fci contains the APDU response to the SELECT command sent to the card during the selection process. The data part of this ApduResponse is the FCI
  
• isMatching is True if the selection was successful, false otherwise.

Note: ATR and FCI are optional but cannot both be absent when the selection status is successful.

Parameters:

atr - A not null AnswerToReset reference.

fci - A nullable ApduResponse reference.

isMatching - A boolean.

Since:

0.9

Method Detail

getAtr

public AnswerToReset getAtr()

Gets the ATR coming from the card.

The ATR may not be available with certain types of readers, in this case this method returns null.

Returns:

A nullable AnswerToReset.

Since:

0.9

getFci

public ApduResponse getFci()

Gets the ApduResponse from the card to the Selection Application command.

The FCI is not available if the card has not been selected with an AID, in this case this method returns null.

Returns:

A nullable ApduResponse.

Since:

0.9

hasMatched

public boolean hasMatched()

Tells if the selection process has been successful.

Returns:

True or False.

Since:

0.9

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object