CardData (Commons eID Consumer 1.0.4 API)

java.lang.Object
- be.bosa.commons.eid.consumer.CardData

All Implemented Interfaces:

Serializable
```
public class CardData
extends Object
implements Serializable
```
Holds the CARD DATA information returned by BeIDCard.getCardData() (see BELPIC APPLICATION V2.0 specs, GET CARD DATA, p49.)

Author:

Frank Marien

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`applicationInterfaceVersion`
`int`	`applicationLifeCycle`
`int`	`applicationVersion`
`int`	`axaltoReservedNumber`
`int`	`chipManufacturer`
`byte[]`	`chipSerialNumber`
`int`	`componentCode`
`int`	`globalOSVersion`
`int`	`keyExchangeVersion`
`int`	`osNumber`
`int`	`osVersion`
`int`	`pkcs1Support`
`byte[]`	`serialNumber`
`int`	`softmaskNumber`
`int`	`softmaskVersion`

Constructor Summary

Constructors
Constructor and Description

CardData()

Constructors
Constructor and Description
`CardData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getApplicationInterfaceVersion()` get the "Application interface version" byte
`int`	`getApplicationLifeCycle()` get the "Application Life cycle" byte CAUTION: state of 0x0f (DEACTIVATED) has been observed in otherwise active cards.
`int`	`getApplicationVersion()` get the "Application version" byte
`int`	`getAxaltoReservedNumber()` get the "2 bytes reserved for axalto" from the card serial number
`int`	`getChipManufacturer()` get the "2 bytes identifying the chip manufacturer" from the card serial number
`byte[]`	`getChipSerialNumber()` get the 12 bytes uniquely identifying the chip inside all chips from this manufacturer
`int`	`getComponentCode()` get the "component code" byte
`int`	`getGlobalOSVersion()` get the 2 "Global OS version" bytes "This global number is unique for a given set composed of: Component code \|\| OS number \|\| OS version \|\| Softmask number \|\| Softmask version \|\| Application version"
`int`	`getKeyExchangeVersion()` get the "Key exchange version" byte
`int`	`getOsNumber()` get the "OS number" byte
`int`	`getOsVersion()` get the "OS version" byte
`int`	`getPkcs1Support()` get the "PKCS#1 support" byte b7 b6 b5 b4 b3 b2 b1 b0 Meaning -- -- -- -- -- -- -- 1 RSASSA-PKCS1 v1.5 supported (MD5 and SHA-1) -- -- -- -- -- -- 1 -- RSASSA-PSS supported (SHA-1) -- -- -- -- -- 1 -- -- RSAES-PKCS1 v1.5 supported -- -- -- -- 1 -- -- -- RSAES-OAEP supported -- -- -- 1 -- -- -- -- RSA-KEM supported
`byte[]`	`getSerialNumber()` get the complete card serial number "he serial number is composed of 2 bytes reserved for axalto, 2 bytes identifying the chip manufacturer, and 12 bytes identifying uniquely the chip inside all chips from this manufacturer."
`int`	`getSoftmaskNumber()` get the "Softmask number" byte
`int`	`getSoftmaskVersion()` get the "Softmask version" byte
`boolean`	`isActivated()` Convenience method to test whether this card is in the ACTIVATED state.
`boolean`	`isDeactivated()` Convenience method to test whether this card is in the DEACTIVATED state.
`boolean`	`isLocked()` Convenience method to test whether this card is in the LOCKED state.
`boolean`	`isRSAESOAEPSupported()` Convenience method to test whether this card supports RSAES-OAEP
`boolean`	`isRSAESPKCS115Supported()` Convenience method to test whether this card supports RSAES-PKCS1 v1.5
`boolean`	`isRSAKEMSupported()` Convenience method to test whether this card supports RSA-KEM
`boolean`	`isRSASSAPKCS115Supported()` Convenience method to test whether this card supports RSASSA-PKCS1 v1.5
`boolean`	`isRSASSAPSSSupported()` Convenience method to test whether this card supports RSASSA-PSS

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

- Field Detail
  - serialNumber
```
public byte[] serialNumber
```
  - axaltoReservedNumber
```
public int axaltoReservedNumber
```
  - chipManufacturer
```
public int chipManufacturer
```
  - chipSerialNumber
```
public byte[] chipSerialNumber
```
  - componentCode
```
public int componentCode
```
  - osNumber
```
public int osNumber
```
  - osVersion
```
public int osVersion
```
  - softmaskNumber
```
public int softmaskNumber
```
  - softmaskVersion
```
public int softmaskVersion
```
  - applicationVersion
```
public int applicationVersion
```
  - globalOSVersion
```
public int globalOSVersion
```
  - applicationInterfaceVersion
```
public int applicationInterfaceVersion
```
  - pkcs1Support
```
public int pkcs1Support
```
  - keyExchangeVersion
```
public int keyExchangeVersion
```
  - applicationLifeCycle
```
public int applicationLifeCycle
```
- Constructor Detail
  - CardData
```
public CardData()
```
- Method Detail
  - getSerialNumber
```
public byte[] getSerialNumber()
```
    get the complete card serial number "he serial number is composed of 2 bytes reserved for axalto, 2 bytes identifying the chip manufacturer, and 12 bytes identifying uniquely the chip inside all chips from this manufacturer."
    
    Returns:
    
    the complete 16-byte card serial number
  - getAxaltoReservedNumber
```
public int getAxaltoReservedNumber()
```
    get the "2 bytes reserved for axalto" from the card serial number
    
    Returns:
    
    the value of the 2 bytes reserved for axalto from the card serial number
  - getChipManufacturer
```
public int getChipManufacturer()
```
    get the "2 bytes identifying the chip manufacturer" from the card serial number
    
    Returns:
    
    the value of the 2 bytes identifying the chip manufacturer from the card serial number
  - getChipSerialNumber
```
public byte[] getChipSerialNumber()
```
    get the 12 bytes uniquely identifying the chip inside all chips from this manufacturer
    
    Returns:
    
    the 12 bytes uniquely identifying the chip inside all chips from this manufacturer
  - getComponentCode
```
public int getComponentCode()
```
    get the "component code" byte
    
    Returns:
    
    the "component code" byte
  - getOsNumber
```
public int getOsNumber()
```
    get the "OS number" byte
    
    Returns:
    
    the "OS number" byte
  - getOsVersion
```
public int getOsVersion()
```
    get the "OS version" byte
    
    Returns:
    
    the "OS version" byte
  - getSoftmaskNumber
```
public int getSoftmaskNumber()
```
    get the "Softmask number" byte
    
    Returns:
    
    the "Softmask number" byte
  - getSoftmaskVersion
```
public int getSoftmaskVersion()
```
    get the "Softmask version" byte
    
    Returns:
    
    the "Softmask version" byte
  - getApplicationVersion
```
public int getApplicationVersion()
```
    get the "Application version" byte
    
    Returns:
    
    the "Application version" byte
  - getGlobalOSVersion
```
public int getGlobalOSVersion()
```
    get the 2 "Global OS version" bytes "This global number is unique for a given set composed of: Component code || OS number || OS version || Softmask number || Softmask version || Application version"
    
    Returns:
    
    the 2 "Global OS version" bytes
  - getApplicationInterfaceVersion
```
public int getApplicationInterfaceVersion()
```
    get the "Application interface version" byte
    
    Returns:
    
    the "Application interface version" byte
  - getPkcs1Support
```
public int getPkcs1Support()
```
    get the "PKCS#1 support" byte b7 b6 b5 b4 b3 b2 b1 b0 Meaning -- -- -- -- -- -- -- 1 RSASSA-PKCS1 v1.5 supported (MD5 and SHA-1) -- -- -- -- -- -- 1 -- RSASSA-PSS supported (SHA-1) -- -- -- -- -- 1 -- -- RSAES-PKCS1 v1.5 supported -- -- -- -- 1 -- -- -- RSAES-OAEP supported -- -- -- 1 -- -- -- -- RSA-KEM supported
    
    Returns:
    
    the "PKCS#1 support" byte
  - getKeyExchangeVersion
```
public int getKeyExchangeVersion()
```
    get the "Key exchange version" byte
    
    Returns:
    
    the "Key exchange version" byte
  - getApplicationLifeCycle
```
public int getApplicationLifeCycle()
```
    get the "Application Life cycle" byte CAUTION: state of 0x0f (DEACTIVATED) has been observed in otherwise active cards. It's a bad idea to make a functional decision about card state based on this byte.
    
    Returns:
    
    the "Application Life cycle" byte
  - isRSASSAPKCS115Supported
```
public boolean isRSASSAPKCS115Supported()
```
    Convenience method to test whether this card supports RSASSA-PKCS1 v1.5
    
    Returns:
    
    true if card supports RSASSA-PKCS1 v1.5, false otherwise
  - isRSASSAPSSSupported
```
public boolean isRSASSAPSSSupported()
```
    Convenience method to test whether this card supports RSASSA-PSS
    
    Returns:
    
    true if card supports RSASSA-PSS, false otherwise
  - isRSAESPKCS115Supported
```
public boolean isRSAESPKCS115Supported()
```
    Convenience method to test whether this card supports RSAES-PKCS1 v1.5
    
    Returns:
    
    true if card supports RSAES-PKCS1 v1.5, false otherwise
  - isRSAESOAEPSupported
```
public boolean isRSAESOAEPSupported()
```
    Convenience method to test whether this card supports RSAES-OAEP
    
    Returns:
    
    true if card supports RSAES-OAEP, false otherwise
  - isRSAKEMSupported
```
public boolean isRSAKEMSupported()
```
    Convenience method to test whether this card supports RSA-KEM
    
    Returns:
    
    true if card supports RSA-KEM, false otherwise
  - isActivated
```
public boolean isActivated()
```
    Convenience method to test whether this card is in the ACTIVATED state. CAUTION: state DEACTIVATED has been observed in otherwise active cards.
    
    Returns:
    
    true if card is in ACTIVATED state, false otherwise
  - isDeactivated
```
public boolean isDeactivated()
```
    Convenience method to test whether this card is in the DEACTIVATED state. CAUTION: state DEACTIVATED has been observed in otherwise active cards.
    
    Returns:
    
    true if card is in DEACTIVATED state, false otherwise
  - isLocked
```
public boolean isLocked()
```
    Convenience method to test whether this card is in the LOCKED state. CAUTION: state DEACTIVATED has been observed in otherwise active cards.
    
    Returns:
    
    true if card is in LOCKED state, false otherwise

Class CardData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialNumber

axaltoReservedNumber

chipManufacturer

chipSerialNumber

componentCode

osNumber

osVersion

softmaskNumber

softmaskVersion

applicationVersion

globalOSVersion

applicationInterfaceVersion

pkcs1Support

keyExchangeVersion

applicationLifeCycle

Constructor Detail

CardData

Method Detail

getSerialNumber

getAxaltoReservedNumber

getChipManufacturer

getChipSerialNumber

getComponentCode

getOsNumber

getOsVersion

getSoftmaskNumber

getSoftmaskVersion

getApplicationVersion

getGlobalOSVersion

getApplicationInterfaceVersion

getPkcs1Support

getKeyExchangeVersion

getApplicationLifeCycle

isRSASSAPKCS115Supported

isRSASSAPSSSupported

isRSAESPKCS115Supported

isRSAESOAEPSupported

isRSAKEMSupported

isActivated

isDeactivated

isLocked