SmartCardDevice Interface Reference

Smart card device. More...

Inheritance diagram for SmartCardDevice:

Public Member Functions
String	getId ()
SmartCardDeviceVersion	getVersion () throws SmartCardNotAvailableException, SmartCardLowLevelException
List< SmartCardReader >	getReaders () throws SmartCardNotAvailableException, SmartCardLowLevelException
	Gets list available devices. More...
void	addMifareClassicKeys (List< MifareClassicKeyGroup > keyGroups) throws SmartCardNotAvailableException, SmartCardLowLevelException
List< MifareClassicKeyGroup >	getMifareClassicKeys () 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< SmartCardPaymentAppConfiguration >	getPaymentAppConf (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< SmartCardDeviceMediaProfile >	getMediaProfiles () 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

addMediaProfiles()

void addMediaProfiles

(

List< SmartCardDeviceMediaProfile >

profiles

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Parameters

profiles

profiles to be added

addMifareClassicKeys()

void addMifareClassicKeys

(

List< MifareClassicKeyGroup >

keyGroups

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Adds a list of keys to smart card device

Parameters

keys	list of keys

Exceptions

SmartCardLowLevelException
SmartCardNotAvailableException

clearMifareClassicKeys()

void clearMifareClassicKeys

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Exceptions

SmartCardLowLevelException
SmartCardNotAvailableException

forceConnection()

void forceConnection

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Exceptions

SmartCardNotAvailableException
SmartCardLowLevelException

forceDeviceUpgrade()

void forceDeviceUpgrade

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Exceptions

SmartCardNotAvailableException
SmartCardLowLevelException

getDateTime()

Instant getDateTime

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Returns

date and time

Exceptions

SmartCardNotAvailableException
SmartCardLowLevelException

getId()

String getId

(

)

Gets Smart card device identifier

Returns

Smart card device identifier

getLoggingConfiguration()

SmartCardDeviceLoggingConfiguration getLoggingConfiguration

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Returns

remote logging configuration which is being used

Exceptions

SmartCardNotAvailableException
SmartCardLowLevelException

getMediaProfiles()

List<SmartCardDeviceMediaProfile> getMediaProfiles

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Returns

list of profiles

getMifareClassicKeys()

List<MifareClassicKeyGroup> getMifareClassicKeys

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Returns

current Mifare classic keys

Exceptions

SmartCardLowLevelException
SmartCardNotAvailableException

getNetworkConfiguration()

SmartCardDeviceNetworkConfiguration getNetworkConfiguration

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Returns

device network configuration

Exceptions

SmartCardNotAvailableException
SmartCardLowLevelException

getPaymentAppConf()

List<SmartCardPaymentAppConfiguration> getPaymentAppConf

(

List< SmartCardPaymentAppConfiguration >

configurations

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Parameters

properties

List of configuration properties to retrieve

Returns

List of SmartCardPaymentAppConfiguration objects filled

Exceptions

SmartCardLowLevelException
SmartCardNotAvailableException

getPaymentAppInfo()

SmartCardPaymentAppInformation getPaymentAppInfo

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Returns

SmartCardPaymentAppInformation class filled with the payment application information

Exceptions

SmartCardLowLevelException
SmartCardNotAvailableException

getPciRebootTime()

Instant getPciRebootTime

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Returns

pci reboot time

Exceptions

SmartCardNotAvailableException
SmartCardLowLevelException

getReaders()

List<SmartCardReader> getReaders

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Returns

readers list

Exceptions

SmartCardNotAvailableException
SmartCardLowLevelException

getVersion()

SmartCardDeviceVersion getVersion

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Gets Smart card device version

Returns

Smart card device version

Exceptions

SmartCardNotAvailableException
SmartCardLowLevelException

playMediaProfile()

void playMediaProfile

(

String

id

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Parameters

id	profile id to be played

reboot()

void reboot

(

SmartCardDeviceRebootType

rebootType

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Parameters

rebootType

reboot type

Exceptions

SmartCardNotAvailableException
SmartCardLowLevelException

removeMediaProfiles()

void removeMediaProfiles

(

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Parameters

id	profile id to be deleted

setLoggingConfiguration()

void setLoggingConfiguration

(

SmartCardDeviceLoggingConfiguration

loggingConfiguration

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Parameters

loggingConfiguration

remote logging configuration to be applied

Exceptions

SmartCardNotAvailableException
SmartCardLowLevelException

setNetworkConfiguration()

void setNetworkConfiguration

(

SmartCardDeviceNetworkConfiguration

networkConfiguration

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Parameters

device

network configuration

Exceptions

SmartCardNotAvailableException
SmartCardLowLevelException

setPaymentAppConf()

void setPaymentAppConf

(

List< SmartCardPaymentAppConfiguration >

configurations

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Parameters

configurations

Payment configurations

Exceptions

SmartCardLowLevelException
SmartCardNotAvailableException

setPaymentAppStatus()

void setPaymentAppStatus

(

SmartCardPaymentAppStatus

status

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Parameters

status

payment app status to be set

Exceptions

SmartCardLowLevelException
SmartCardNotAvailableException

setPciRebootTime()

void setPciRebootTime

(

Instant

time

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Parameters

time	when to perform the reboot

testNetworkConnectivity()

NetworkConnectivityStatus testNetworkConnectivity

(

String

address

)

throws SmartCardNotAvailableException, SmartCardLowLevelException

Parameters

address

address that the device uses to test connectivity

Exceptions

SmartCardNotAvailableException
SmartCardLowLevelException