co.blustor.gatekeepersdk.devices

Class GKBluetoothCard

java.lang.Object

co.blustor.gatekeepersdk.devices.GKBluetoothCard

All Implemented Interfaces:

GKCard

public class GKBluetoothCard
extends java.lang.Object
implements GKCard

Nested Class Summary

Nested classes/interfaces inherited from interface co.blustor.gatekeepersdk.devices.GKCard

GKCard.AbortResponse, GKCard.ConnectionState, GKCard.Monitor, GKCard.Response

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
GKBluetoothCard(java.lang.String cardName, java.io.File dataCacheDir) Create a GKBluetoothCard to connect with the GateKeeper Card having the given name.

Method Summary

Modifier and Type	Method and Description
void	addMonitor(GKCard.Monitor monitor) Add a Monitor to be informed about changes to the state of the GateKeeper Card.
void	connect() Open a connection with the GateKeeper Card.
GKCard.Response	createPath(java.lang.String cardPath) Send a `createPath` action to the GateKeeper Card.
GKCard.Response	delete(java.lang.String cardPath) Send a `delete` action to the GateKeeper Card.
GKCard.Response	deletePath(java.lang.String cardPath) Send a `deletePath` action to the GateKeeper Card.
void	disconnect() Close the connection with the GateKeeper Card.
GKCard.Response	finalize(java.lang.String cardPath) Send a `finalize` action to the GateKeeper Card.
GKCard.Response	get(java.lang.String cardPath) Send a `get` action to the GateKeeper Card.
GKCard.Response	get(java.lang.String cardPath, java.io.File localFile) Send a `get` action to the GateKeeper Card.
GKCard.ConnectionState	getConnectionState() Get the current state of the connection between this object and the GateKeeper Card.
GKCard.Response	list(java.lang.String cardPath) Send a `list` action to the GateKeeper Card.
void	onConnectionChanged(GKCard.ConnectionState state) Intended for internal use only.
GKCard.Response	put(java.lang.String cardPath, java.io.InputStream inputStream) Send a `put` action to the GateKeeper Card.
void	removeMonitor(GKCard.Monitor monitor) Remove a Monitor from the GKCard.
GKCard.Response	rename(java.lang.String fromCardPath, java.lang.String toCardPath) Send a `rename` action to the GateKeeper Card.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

Constructor Detail

GKBluetoothCard

public GKBluetoothCard(java.lang.String cardName,
                       java.io.File dataCacheDir)

Create a GKBluetoothCard to connect with the GateKeeper Card having the given name.

Parameters:

cardName - the Bluetooth pairing name of the GateKeeper Card

dataCacheDir - a File that contains the location to create temporary files to store response data. Ex: context.getExternalCacheDir()

Method Detail

list

public GKCard.Response list(java.lang.String cardPath)
                     throws java.io.IOException

Description copied from interface: GKCard

Send a `list` action to the GateKeeper Card.

Specified by:

list in interface GKCard

Parameters:

cardPath - the path used in the action

Returns:

a Response with information about the action

Throws:

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

get

public GKCard.Response get(java.lang.String cardPath)
                    throws java.io.IOException

Description copied from interface: GKCard

Send a `get` action to the GateKeeper Card.

Specified by:

get in interface GKCard

Parameters:

cardPath - the path used in the action

Returns:

a Response with information about the action

Throws:

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

get

public GKCard.Response get(java.lang.String cardPath,
                           java.io.File localFile)
                    throws java.io.IOException

Description copied from interface: GKCard

Send a `get` action to the GateKeeper Card.

Specified by:

get in interface GKCard

Parameters:

cardPath - the path used in the action

localFile - the local file used to store the response data

Returns:

a Response with information about the action

Throws:

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

put

public GKCard.Response put(java.lang.String cardPath,
                           java.io.InputStream inputStream)
                    throws java.io.IOException

Description copied from interface: GKCard

Send a `put` action to the GateKeeper Card.

Specified by:

put in interface GKCard

Parameters:

cardPath - the path used in the action

inputStream - a stream with data used in the action

Returns:

a Response with information about the action

Throws:

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

rename

public GKCard.Response rename(java.lang.String fromCardPath,
                              java.lang.String toCardPath)
                       throws java.io.IOException

Description copied from interface: GKCard

Send a `rename` action to the GateKeeper Card.

Specified by:

rename in interface GKCard

Parameters:

fromCardPath - the name to change from

toCardPath - the name to change to

Returns:

a Response with information about the action

Throws:

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

delete

public GKCard.Response delete(java.lang.String cardPath)
                       throws java.io.IOException

Description copied from interface: GKCard

Send a `delete` action to the GateKeeper Card.

Specified by:

delete in interface GKCard

Parameters:

cardPath - the path used in the action

Returns:

a Response with information about the action

Throws:

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

createPath

public GKCard.Response createPath(java.lang.String cardPath)
                           throws java.io.IOException

Description copied from interface: GKCard

Send a `createPath` action to the GateKeeper Card.

Specified by:

createPath in interface GKCard

Parameters:

cardPath - the path used in the action

Returns:

a Response with information about the action

Throws:

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

deletePath

public GKCard.Response deletePath(java.lang.String cardPath)
                           throws java.io.IOException

Description copied from interface: GKCard

Send a `deletePath` action to the GateKeeper Card.

Specified by:

deletePath in interface GKCard

Parameters:

cardPath - the path used in the action

Returns:

a Response with information about the action

Throws:

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

finalize

public GKCard.Response finalize(java.lang.String cardPath)
                         throws java.io.IOException

Description copied from interface: GKCard

Send a `finalize` action to the GateKeeper Card.

Specified by:

finalize in interface GKCard

Parameters:

cardPath - the path used in the action

Returns:

a Response with information about the action

Throws:

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

connect

public void connect()
             throws java.io.IOException

Description copied from interface: GKCard

Open a connection with the GateKeeper Card.

Specified by:

connect in interface GKCard

Throws:

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

disconnect

public void disconnect()
                throws java.io.IOException

Description copied from interface: GKCard

Close the connection with the GateKeeper Card.

Specified by:

disconnect in interface GKCard

Throws:

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

getConnectionState

public GKCard.ConnectionState getConnectionState()

Description copied from interface: GKCard

Get the current state of the connection between this object and the GateKeeper Card.

Specified by:

getConnectionState in interface GKCard

Returns:

the current ConnectionState between this object and the GateKeeper Card.

onConnectionChanged

public void onConnectionChanged(GKCard.ConnectionState state)

Description copied from interface: GKCard

Intended for internal use only.

Specified by:

onConnectionChanged in interface GKCard

Parameters:

state - the ConnectionState that describes the new state of the connection

addMonitor

public void addMonitor(GKCard.Monitor monitor)

Description copied from interface: GKCard

Add a Monitor to be informed about changes to the state of the GateKeeper Card.

Specified by:

addMonitor in interface GKCard

Parameters:

monitor - the Monitor to be added

removeMonitor

public void removeMonitor(GKCard.Monitor monitor)

Description copied from interface: GKCard

Remove a Monitor from the GKCard.

Specified by:

removeMonitor in interface GKCard

Parameters:

monitor - the Monitor to be removed