CalypsoPo (Keyple Calypso Reference API

java.lang.Object
- org.eclipse.keyple.core.card.selection.AbstractSmartCard
- - org.eclipse.keyple.calypso.transaction.CalypsoPo

```
public class CalypsoPo
extends org.eclipse.keyple.core.card.selection.AbstractSmartCard
```
This POJO concentrates all the information we know about the PO being processed: from the selection stage to the end of the transaction.
An instance of CalypsoPo is obtained by casting the AbstractSmartCard object from the selection process (e.g. (CalypsoPo)(cardSelectionsResult.getActiveSmartCard()))
The various information contained in CalypsoPo is accessible by getters and includes:
- The application identification fields (revision/version, class, DF name, serial number, ATR, issuer)
- The indication of the presence of optional features (Stored Value, PIN, Rev3.2 mode, ratification management)
- The management information of the modification buffer
- The invalidation status
- The files, counters, SV data read or modified during the execution of the processes defined by PoTransaction
Since:

0.9

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Map<java.lang.Byte,ElementaryFile>`	`getAllFiles()` Gets a reference to a map of all known Elementary Files by their associated SFI. Note that if a secure session is actually running, then the map contains all session modifications, which can be canceled if the secure session fails.
`java.lang.String`	`getApplicationSerialNumber()` Gets the Calypso application serial number as an HEX String.
`byte[]`	`getApplicationSerialNumberBytes()` Gets the Calypso application serial number as an array of bytes.
`byte`	`getApplicationSubtype()` The Application Subtype indicates to the terminal a reference to the file structure of the Calypso DF.
`byte`	`getApplicationType()` The Application Type byte determines the Calypso Revision and various options
`java.lang.String`	`getAtr()` Get the Answer To Reset as an HEX String.
`protected byte[]`	`getCalypsoSerialNumber()` Gets the full Calypso serial number including the possible validity date information in the two MSB.
`java.lang.String`	`getDfName()` Gets the DF name as an HEX String.
`byte[]`	`getDfNameBytes()` Gets the DF name as an array of bytes.
`DirectoryHeader`	`getDirectoryHeader()` Gets the DF metadata.
`ElementaryFile`	`getFileByLid(short lid)` Gets a reference to the `ElementaryFile` that has the provided LID value. Note that if a secure session is actually running, then the object contains all session modifications, which can be canceled if the secure session fails.
`ElementaryFile`	`getFileBySfi(byte sfi)` Gets a reference to the `ElementaryFile` that has the provided SFI value. Note that if a secure session is actually running, then the object contains all session modifications, which can be canceled if the secure session fails.
`protected int`	`getModificationsCounter()` Indicates the maximum number of changes allowed in session.
`protected int`	`getPayloadCapacity()` Gets the maximum length of data that an APDU in this PO can carry.
`int`	`getPinAttemptRemaining()` Gives the number of erroneous PIN presentations remaining before blocking.
`byte`	`getPlatform()` The platform identification byte is the reference of the chip
`protected PoClass`	`getPoClass()` The PO class is the ISO7816 class to be used with the current PO.
`PoRevision`	`getRevision()` Gets the PO revision.
`protected byte[]`	`getSerialNumberExpirationBytes()`
`byte`	`getSessionModification()` Get the session modification byte from the startup info structure.
`byte`	`getSoftwareIssuer()` The Software Issuer byte indicates the entity responsible for the software of the selected application.
`byte`	`getSoftwareRevision()` The Software Revision field may be set to any fixed value by the Software Issuer of the Calypso application.
`byte`	`getSoftwareVersion()` The Software Version field may be set to any fixed value by the Software Issuer of the Calypso application.
`java.lang.String`	`getStartupInfo()` Gets the Calypso startup information field as an HEX String
`int`	`getSvBalance()` Gets the current SV balance value
`java.util.List<SvDebitLogRecord>`	`getSvDebitLogAllRecords()` Gets list of references to the `SvDebitLogRecord` read from the PO.
`SvDebitLogRecord`	`getSvDebitLogLastRecord()` Gets a reference to the last `SvDebitLogRecord`
`int`	`getSvLastTNum()` Gets the last SV transaction number
`SvLoadLogRecord`	`getSvLoadLogRecord()` Gets a reference to the last `SvLoadLogRecord`
`boolean`	`isConfidentialSessionModeSupported()` Indicates whether the Confidential Session Mode is supported or not (since rev 3.2).
`boolean`	`isDeselectRatificationSupported()` Indicates if the ratification is done on deselect (ratification command not necessary)
`boolean`	`isDfInvalidated()` Tells if the PO has been invalidated or not.
`boolean`	`isDfRatified()` Tells if the last session with this PO has been ratified or not.
`protected boolean`	`isModificationsCounterInBytes()` Tells if the change counter allowed in session is established in number of operations or number of bytes modified.
`boolean`	`isPinBlocked()` Indicates if the PIN is blocked.
`boolean`	`isPinFeatureAvailable()` Indicates whether the PO has the Calypso PIN feature.
`boolean`	`isPublicAuthenticationSupported()` Indicates whether the Public Authentication is supported or not (since rev 3.3).
`protected boolean`	`isSerialNumberExpiring()`
`boolean`	`isSvFeatureAvailable()` Indicates whether the PO has the Calypso Stored Value feature.

Methods inherited from class org.eclipse.keyple.core.card.selection.AbstractSmartCard
getAtrBytes, getFciBytes, hasAtr, hasFci

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

- Method Detail
  - getRevision
```
public final PoRevision getRevision()
```
    Gets the PO revision.
    The PO revision indicates the generation of the product presented.
    It will also have an impact on the internal construction of some commands to take into account the specificities of the different POs.
    
    Returns:
    
    an enum giving the identified PO revision
    
    Since:
    
    0.9
  - getDfNameBytes
```
public final byte[] getDfNameBytes()
```
    Gets the DF name as an array of bytes.
    The DF name is the name of the application DF as defined in ISO/IEC 7816-4.
    It also corresponds to the complete representation of the target covered by the AID value provided in the selection command.
    The AID selects the application by specifying all or part of the targeted DF Name (5 bytes minimum).
    
    Returns:
    
    a byte array containing the DF Name bytes (5 to 16 bytes)
    
    Since:
    
    0.9
  - getDfName
```
public final java.lang.String getDfName()
```
    Gets the DF name as an HEX String.
    
    Returns:
    
    the DF name as an HEX string (see getDfNameBytes)
    
    Since:
    
    0.9
  - getCalypsoSerialNumber
```
protected final byte[] getCalypsoSerialNumber()
```
    Gets the full Calypso serial number including the possible validity date information in the two MSB.
    The serial number to be used as diversifier for key derivation.
    This is the complete number returned by the PO in its response to the Select command.
    
    Returns:
    
    a byte array containing the Calypso Serial Number (8 bytes)
    
    Since:
    
    0.9
  - getApplicationSerialNumberBytes
```
public final byte[] getApplicationSerialNumberBytes()
```
    Gets the Calypso application serial number as an array of bytes.
    The serial number for the application, is unique ID for the PO.
    The difference with getCalypsoSerialNumber is that the two possible bytes (MSB) of validity date are here forced to zero.
    
    Returns:
    
    a byte array containing the Application Serial Number (8 bytes)
    
    Since:
    
    0.9
  - getApplicationSerialNumber
```
public final java.lang.String getApplicationSerialNumber()
```
    Gets the Calypso application serial number as an HEX String.
    
    Returns:
    
    a String representing the Application Serial Number (8 bytes / 16 hex digits)
    
    Since:
    
    0.9
  - getStartupInfo
```
public final java.lang.String getStartupInfo()
```
    Gets the Calypso startup information field as an HEX String
    
    Returns:
    
    the startup info field from the FCI as an HEX string
    
    Since:
    
    0.9
  - isSerialNumberExpiring
```
protected final boolean isSerialNumberExpiring()
```
  - getSerialNumberExpirationBytes
```
protected final byte[] getSerialNumberExpirationBytes()
```
  - getAtr
```
public final java.lang.String getAtr()
```
    Get the Answer To Reset as an HEX String.
    The Answer To Reset is sent by the PO is ISO7816-3 mode and in contactless mode for PC/SC readers.
    When the ATR is obtained in contactless mode, it is in fact reconstructed by the reader from information obtained from the lower communication layers.Therefore, it may differ from one reader to another depending on the interpretation that has been made by the manufacturer of the PC/SC standard.
    This field is not interpreted in the Calypso module.
    
    Returns:
    
    an HEX chain representing the ATR
    
    Throws:
    
    java.lang.IllegalStateException - if the ATR is not available (see hasAtr() method)
    
    Since:
    
    0.9
  - getPayloadCapacity
```
protected final int getPayloadCapacity()
```
    Gets the maximum length of data that an APDU in this PO can carry.
    
    Returns:
    
    An int
    
    Since:
    
    0.9
  - isModificationsCounterInBytes
```
protected final boolean isModificationsCounterInBytes()
```
    Tells if the change counter allowed in session is established in number of operations or number of bytes modified.
    This varies depending on the revision of the PO.
    
    Returns:
    
    true if the counter is number of bytes
    
    Since:
    
    0.9
  - getModificationsCounter
```
protected final int getModificationsCounter()
```
    Indicates the maximum number of changes allowed in session.
    This number can be a number of operations or a number of commands (see isModificationsCounterInBytes)
    
    Returns:
    
    the maximum number of modifications allowed
    
    Since:
    
    0.9
  - getPlatform
```
public final byte getPlatform()
```
    The platform identification byte is the reference of the chip
    
    Returns:
    
    the platform identification byte
    
    Since:
    
    0.9
  - getApplicationType
```
public final byte getApplicationType()
```
    The Application Type byte determines the Calypso Revision and various options
    
    Returns:
    
    the Application Type byte
    
    Since:
    
    0.9
  - isConfidentialSessionModeSupported
```
public final boolean isConfidentialSessionModeSupported()
```
    Indicates whether the Confidential Session Mode is supported or not (since rev 3.2).
    This boolean is interpreted from the Application Type byte
    
    Returns:
    
    true if the Confidential Session Mode is supported
    
    Since:
    
    0.9
  - isDeselectRatificationSupported
```
public final boolean isDeselectRatificationSupported()
```
    Indicates if the ratification is done on deselect (ratification command not necessary)
    This boolean is interpreted from the Application Type byte
    
    Returns:
    
    true if the ratification command is required
    
    Since:
    
    0.9
  - isSvFeatureAvailable
```
public final boolean isSvFeatureAvailable()
```
    Indicates whether the PO has the Calypso Stored Value feature.
    This boolean is interpreted from the Application Type byte
    
    Returns:
    
    true if the PO has the Stored Value feature
    
    Since:
    
    0.9
  - isPinFeatureAvailable
```
public final boolean isPinFeatureAvailable()
```
    Indicates whether the PO has the Calypso PIN feature.
    This boolean is interpreted from the Application Type byte
    
    Returns:
    
    true if the PO has the PIN feature
    
    Since:
    
    0.9
  - isPublicAuthenticationSupported
```
public final boolean isPublicAuthenticationSupported()
```
    Indicates whether the Public Authentication is supported or not (since rev 3.3).
    This boolean is interpreted from the Application Type byte
    
    Returns:
    
    true if the Public Authentication is supported
    
    Since:
    
    0.9
  - getApplicationSubtype
```
public final byte getApplicationSubtype()
```
    The Application Subtype indicates to the terminal a reference to the file structure of the Calypso DF.
    
    Returns:
    
    the Application Subtype byte
    
    Since:
    
    0.9
  - getSoftwareIssuer
```
public final byte getSoftwareIssuer()
```
    The Software Issuer byte indicates the entity responsible for the software of the selected application.
    
    Returns:
    
    the Software Issuer byte
    
    Since:
    
    0.9
  - getSoftwareVersion
```
public final byte getSoftwareVersion()
```
    The Software Version field may be set to any fixed value by the Software Issuer of the Calypso application.
    
    Returns:
    
    the Software Version byte
    
    Since:
    
    0.9
  - getSoftwareRevision
```
public final byte getSoftwareRevision()
```
    The Software Revision field may be set to any fixed value by the Software Issuer of the Calypso application.
    
    Returns:
    
    the Software Revision byte
    
    Since:
    
    0.9
  - getSessionModification
```
public final byte getSessionModification()
```
    Get the session modification byte from the startup info structure.
    Depending on the type of PO, the session modification byte indicates the maximum number of bytes that can be modified or the number of possible write commands in a session.
    
    Returns:
    
    the Session Modifications byte
    
    Since:
    
    0.9
  - isDfInvalidated
```
public final boolean isDfInvalidated()
```
    Tells if the PO has been invalidated or not.
    An invalidated PO has 6283 as status word in response to the Select Application command.
    
    Returns:
    
    true if the PO has been invalidated.
    
    Since:
    
    0.9
  - isDfRatified
```
public final boolean isDfRatified()
```
    Tells if the last session with this PO has been ratified or not.
    
    Returns:
    
    true if the PO has been ratified.
    
    Throws:
    
    java.lang.IllegalStateException - if these methods is call when no session has been opened
    
    Since:
    
    0.9
  - getSvBalance
```
public final int getSvBalance()
```
    Gets the current SV balance value
    
    Returns:
    
    An int
    
    Throws:
    
    java.lang.IllegalStateException - if no SV Get command has been executed
    
    Since:
    
    0.9
  - getSvLastTNum
```
public final int getSvLastTNum()
```
    Gets the last SV transaction number
    
    Returns:
    
    An int
    
    Throws:
    
    java.lang.IllegalStateException - if no SV Get command has been executed
    
    Since:
    
    0.9
  - getSvLoadLogRecord
```
public final SvLoadLogRecord getSvLoadLogRecord()
```
    Gets a reference to the last SvLoadLogRecord
    
    Returns:
    
    a last SV load log record object or null if not available
    
    Throws:
    
    java.util.NoSuchElementException - if requested log is not found.
    
    Since:
    
    0.9
  - getSvDebitLogLastRecord
```
public final SvDebitLogRecord getSvDebitLogLastRecord()
```
    Gets a reference to the last SvDebitLogRecord
    
    Returns:
    
    a last SV debit log record object or null if not available
    
    Throws:
    
    java.util.NoSuchElementException - if requested log is not found.
    
    Since:
    
    0.9
  - getSvDebitLogAllRecords
```
public final java.util.List<SvDebitLogRecord> getSvDebitLogAllRecords()
```
    Gets list of references to the SvDebitLogRecord read from the PO.
    
    Returns:
    
    a list of SV debit log record objects or null if not available
    
    Throws:
    
    java.util.NoSuchElementException - if requested log is not found.
    
    Since:
    
    0.9
  - getPoClass
```
protected final PoClass getPoClass()
```
    The PO class is the ISO7816 class to be used with the current PO.
    It determined from the PO revision
    Two classes are possible: LEGACY and ISO.
    
    Returns:
    
    the PO class determined from the PO revision
  - getDirectoryHeader
```
public final DirectoryHeader getDirectoryHeader()
```
    Gets the DF metadata.
    
    Returns:
    
    null if is not set.
    
    Since:
    
    0.9
  - getFileBySfi
```
public final ElementaryFile getFileBySfi(byte sfi)
```
    Gets a reference to the ElementaryFile that has the provided SFI value.
    Note that if a secure session is actually running, then the object contains all session modifications, which can be canceled if the secure session fails.
    
    Parameters:
    
    sfi - the SFI to search
    
    Returns:
    
    a not null reference.
    
    Throws:
    
    java.util.NoSuchElementException - if requested EF is not found.
    
    Since:
    
    0.9
  - getFileByLid
```
public final ElementaryFile getFileByLid(short lid)
```
    Gets a reference to the ElementaryFile that has the provided LID value.
    Note that if a secure session is actually running, then the object contains all session modifications, which can be canceled if the secure session fails.
    
    Parameters:
    
    lid - the LID to search
    
    Returns:
    
    a not null reference.
    
    Throws:
    
    java.util.NoSuchElementException - if requested EF is not found.
    
    Since:
    
    0.9
  - getAllFiles
```
public final java.util.Map<java.lang.Byte,ElementaryFile> getAllFiles()
```
    Gets a reference to a map of all known Elementary Files by their associated SFI.
    Note that if a secure session is actually running, then the map contains all session modifications, which can be canceled if the secure session fails.
    
    Returns:
    
    a not null reference (may be empty if no one EF is set).
    
    Since:
    
    0.9
  - isPinBlocked
```
public final boolean isPinBlocked()
```
    Indicates if the PIN is blocked. The maximum number of incorrect PIN submissions has been reached.
    
    Returns:
    
    true if the PIN status is blocked
    
    Throws:
    
    java.lang.IllegalStateException - if the PIN has not been checked
    
    Since:
    
    0.9
  - getPinAttemptRemaining
```
public final int getPinAttemptRemaining()
```
    Gives the number of erroneous PIN presentations remaining before blocking.
    
    Returns:
    
    the number of remaining attempts
    
    Throws:
    
    java.lang.IllegalStateException - if the PIN has not been checked
    
    Since:
    
    0.9

Class CalypsoPo

Method Summary

Methods inherited from class org.eclipse.keyple.core.card.selection.AbstractSmartCard

Methods inherited from class java.lang.Object

Method Detail

getRevision

getDfNameBytes

getDfName

getCalypsoSerialNumber

getApplicationSerialNumberBytes

getApplicationSerialNumber

getStartupInfo

isSerialNumberExpiring

getSerialNumberExpirationBytes

getAtr

getPayloadCapacity

isModificationsCounterInBytes

getModificationsCounter

getPlatform

getApplicationType

isConfidentialSessionModeSupported

isDeselectRatificationSupported

isSvFeatureAvailable

isPinFeatureAvailable

isPublicAuthenticationSupported

getApplicationSubtype

getSoftwareIssuer

getSoftwareVersion

getSoftwareRevision

getSessionModification

isDfInvalidated

isDfRatified

getSvBalance

getSvLastTNum

getSvLoadLogRecord

getSvDebitLogLastRecord

getSvDebitLogAllRecords

getPoClass

getDirectoryHeader

getFileBySfi

getFileByLid

getAllFiles

isPinBlocked

getPinAttemptRemaining