co.blustor.gatekeepersdk.services

Class GKCardSettings

java.lang.Object

co.blustor.gatekeepersdk.services.GKCardSettings

public class GKCardSettings
extends java.lang.Object

GKCardSettings is a Service for handling GateKeeper Card configuration data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GKCardSettings.CardResult CardResult encapsulates the result of basic settings actions.
static class	GKCardSettings.CardSettingsResult
static class	GKCardSettings.FirmwareInformationResult
static class	GKCardSettings.Status

Constructor Summary

Constructors

Constructor and Description
GKCardSettings(GKCard card) Create a GKCardSettings that communicates with card.

Method Summary

Modifier and Type	Method and Description
GKCardSettings.CardSettingsResult	getCardSettings() Retrieves card settings file
GKCardSettings.FirmwareInformationResult	getFirmwareInformation() Retrieves Firmware data from the GateKeeper Card.
GKCardSettings.CardResult	updateCardSettings(GKCardConfiguration cardConfiguration) Updates card settings file
GKCardSettings.CardResult	updateFirmware(java.io.InputStream inputStream) Send Firmware data to the GateKeeper Card.

Methods inherited from class java.lang.Object

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

Constructor Detail

GKCardSettings

public GKCardSettings(GKCard card)

Create a GKCardSettings that communicates with card.

Parameters:

card - the GKCard to be used with settings actions

Since:

0.5.0

Method Detail

updateFirmware

public GKCardSettings.CardResult updateFirmware(java.io.InputStream inputStream)
                                         throws java.io.IOException

Send Firmware data to the GateKeeper Card.

Parameters:

inputStream - a stream with Firmware data

Returns:

the CardResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.5.0

getFirmwareInformation

public GKCardSettings.FirmwareInformationResult getFirmwareInformation()
                                                                throws java.io.IOException

Retrieves Firmware data from the GateKeeper Card.

Returns:

the FirmwareInformationResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.6.0

getCardSettings

public GKCardSettings.CardSettingsResult getCardSettings()
                                                  throws java.io.IOException

Retrieves card settings file

Returns:

the CardSettingsResult which holds the card settings

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.17.0

updateCardSettings

public GKCardSettings.CardResult updateCardSettings(GKCardConfiguration cardConfiguration)
                                             throws java.io.IOException

Updates card settings file

Parameters:

cardConfiguration - the GKCardConfiguration that is returned from getCardSettings, which can be updated

Returns:

the CardSettingsResult which holds the card settings

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.17.0