SmartCardDevice Interface Reference

Smart card device. More...

Inheritance diagram for SmartCardDevice:

Public Member Functions

String getId ()
 
SmartCardDeviceVersion getVersion () throws SmartCardNotAvailableException, SmartCardLowLevelException
 
List< SmartCardReadergetReaders () throws SmartCardNotAvailableException, SmartCardLowLevelException
 Gets list available devices. More...
 
void addMifareClassicKeys (List< MifareClassicKeyGroup > keyGroups) throws SmartCardNotAvailableException, SmartCardLowLevelException
 
List< MifareClassicKeyGroupgetMifareClassicKeys () throws SmartCardNotAvailableException, SmartCardLowLevelException
 Gets the current Mifare classic keys in device. More...
 
void clearMifareClassicKeys () throws SmartCardNotAvailableException, SmartCardLowLevelException
 Clears every Mifare classic key in device. More...
 
void setPaymentAppStatus (SmartCardPaymentAppStatus status) throws SmartCardNotAvailableException, SmartCardLowLevelException
 Sets the status of the Payment application. More...
 
SmartCardPaymentAppInformation getPaymentAppInfo () throws SmartCardNotAvailableException, SmartCardLowLevelException
 Retrieves different parameters related to the Payment application. More...
 
List< SmartCardPaymentAppConfigurationgetPaymentAppConf (List< SmartCardPaymentAppConfiguration > configurations) throws SmartCardNotAvailableException, SmartCardLowLevelException
 Retrieves different configuration parameters related to the Payment application. More...
 
void setPaymentAppConf (List< SmartCardPaymentAppConfiguration > configurations) throws SmartCardNotAvailableException, SmartCardLowLevelException
 Set different parameters related to the Payment configuration. More...
 
void addMediaProfiles (List< SmartCardDeviceMediaProfile > profiles) throws SmartCardNotAvailableException, SmartCardLowLevelException
 Adds a profile to the smart card device. More...
 
void removeMediaProfiles () throws SmartCardNotAvailableException, SmartCardLowLevelException
 Removes all profiles from a smart card device. More...
 
List< SmartCardDeviceMediaProfilegetMediaProfiles () throws SmartCardNotAvailableException, SmartCardLowLevelException
 Get the list of profiles stored in smart card device. More...
 
void playMediaProfile (String id) throws SmartCardNotAvailableException, SmartCardLowLevelException
 Plays a profile a smart card device. More...
 
void setPciRebootTime (Instant time) throws SmartCardNotAvailableException, SmartCardLowLevelException
 Set PCI reboot time for a smart card device. More...
 
Instant getPciRebootTime () throws SmartCardNotAvailableException, SmartCardLowLevelException
 Retrieve PCI reboot time for a smart card device. More...
 
SmartCardDeviceNetworkConfiguration getNetworkConfiguration () throws SmartCardNotAvailableException, SmartCardLowLevelException
 Get network configuration. More...
 
void setNetworkConfiguration (SmartCardDeviceNetworkConfiguration networkConfiguration) throws SmartCardNotAvailableException, SmartCardLowLevelException
 Set network configuration. More...
 
Instant getDateTime () throws SmartCardNotAvailableException, SmartCardLowLevelException
 Retrieve date and time for a smart card device. More...
 
void reboot (SmartCardDeviceRebootType rebootType) throws SmartCardNotAvailableException, SmartCardLowLevelException
 Retrieve date and time for a smart card device. More...
 
void forceConnection () throws SmartCardNotAvailableException, SmartCardLowLevelException
 Force payment gateway connection. More...
 
void forceDeviceUpgrade () throws SmartCardNotAvailableException, SmartCardLowLevelException
 Force upgrade firmware process. More...
 
NetworkConnectivityStatus testNetworkConnectivity (String address) throws SmartCardNotAvailableException, SmartCardLowLevelException
 Test network connectivity. More...
 
void setLoggingConfiguration (SmartCardDeviceLoggingConfiguration loggingConfiguration) throws SmartCardNotAvailableException, SmartCardLowLevelException
 Set a specific remote logging configuration for this device. More...
 
SmartCardDeviceLoggingConfiguration getLoggingConfiguration () throws SmartCardNotAvailableException, SmartCardLowLevelException
 Get remote logging configuration for this device. More...
 
- Public Member Functions inherited from Subject< T extends Observer< U, U extends Event >
void subscribe (T observer) throws CannotSubscribeException
 
void unSubscribe (T observer) throws ObserverNotSubscribedException
 

Detailed Description

Smart card reader.

Smart card device

Smart card reader

Member Function Documentation

void addMediaProfiles ( List< SmartCardDeviceMediaProfile profiles) throws SmartCardNotAvailableException, SmartCardLowLevelException
Parameters
profilesprofiles to be added
void addMifareClassicKeys ( List< MifareClassicKeyGroup keyGroups) throws SmartCardNotAvailableException, SmartCardLowLevelException

Adds a list of keys to smart card device

Parameters
keyslist of keys
Exceptions
SmartCardLowLevelException
SmartCardNotAvailableException
void clearMifareClassicKeys ( ) throws SmartCardNotAvailableException, SmartCardLowLevelException
Exceptions
SmartCardLowLevelException
SmartCardNotAvailableException
Exceptions
SmartCardNotAvailableException
SmartCardLowLevelException
void forceDeviceUpgrade ( ) throws SmartCardNotAvailableException, SmartCardLowLevelException
Exceptions
SmartCardNotAvailableException
SmartCardLowLevelException
Returns
date and time
Exceptions
SmartCardNotAvailableException
SmartCardLowLevelException
String getId ( )

Gets Smart card device identifier

Returns
Smart card device identifier
Returns
remote logging configuration which is being used
Exceptions
SmartCardNotAvailableException
SmartCardLowLevelException
Returns
list of profiles
Returns
current Mifare classic keys
Exceptions
SmartCardLowLevelException
SmartCardNotAvailableException
Returns
device network configuration
Exceptions
SmartCardNotAvailableException
SmartCardLowLevelException
Parameters
propertiesList of configuration properties to retrieve
Returns
List of SmartCardPaymentAppConfiguration objects filled
Exceptions
SmartCardLowLevelException
SmartCardNotAvailableException
Returns
SmartCardPaymentAppInformation class filled with the payment application information
Exceptions
SmartCardLowLevelException
SmartCardNotAvailableException
Instant getPciRebootTime ( ) throws SmartCardNotAvailableException, SmartCardLowLevelException
Returns
pci reboot time
Exceptions
SmartCardNotAvailableException
SmartCardLowLevelException
Returns
readers list
Exceptions
SmartCardNotAvailableException
SmartCardLowLevelException

Gets Smart card device version

Returns
Smart card device version
Exceptions
SmartCardNotAvailableException
SmartCardLowLevelException
void playMediaProfile ( String  id) throws SmartCardNotAvailableException, SmartCardLowLevelException
Parameters
idprofile id to be played
Parameters
rebootTypereboot type
Exceptions
SmartCardNotAvailableException
SmartCardLowLevelException
void removeMediaProfiles ( ) throws SmartCardNotAvailableException, SmartCardLowLevelException
Parameters
idprofile id to be deleted
void setLoggingConfiguration ( SmartCardDeviceLoggingConfiguration  loggingConfiguration) throws SmartCardNotAvailableException, SmartCardLowLevelException
Parameters
loggingConfigurationremote logging configuration to be applied
Exceptions
SmartCardNotAvailableException
SmartCardLowLevelException
void setNetworkConfiguration ( SmartCardDeviceNetworkConfiguration  networkConfiguration) throws SmartCardNotAvailableException, SmartCardLowLevelException
Parameters
devicenetwork configuration
Exceptions
SmartCardNotAvailableException
SmartCardLowLevelException
void setPaymentAppConf ( List< SmartCardPaymentAppConfiguration configurations) throws SmartCardNotAvailableException, SmartCardLowLevelException
Parameters
configurationsPayment configurations
Exceptions
SmartCardLowLevelException
SmartCardNotAvailableException
Parameters
statuspayment app status to be set
Exceptions
SmartCardLowLevelException
SmartCardNotAvailableException
void setPciRebootTime ( Instant  time) throws SmartCardNotAvailableException, SmartCardLowLevelException
Parameters
timewhen to perform the reboot
NetworkConnectivityStatus testNetworkConnectivity ( String  address) throws SmartCardNotAvailableException, SmartCardLowLevelException
Parameters
addressaddress that the device uses to test connectivity
Exceptions
SmartCardNotAvailableException
SmartCardLowLevelException