co.blustor.gatekeepersdk.devices

Interface GKCard

All Known Implementing Classes:

GKBluetoothCard

public interface GKCard

GKCard represents a client connection to a GateKeeper Card.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GKCard.AbortResponse An AbortResponse represents the deliberate termination of an action.
static class	GKCard.ConnectionState ConnectionState is the current state of the connection between a GKCard and a GateKeeper Card.
static interface	GKCard.Monitor A Monitor is a handler for changes to ConnectionState.
static class	GKCard.Response A Response captures the communication received from the GateKeeper Card during the execution of an action.

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.

Method Detail

list

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

Send a `list` action to the GateKeeper Card.

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.

Since:

0.5.0

get

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

Send a `get` action to the GateKeeper Card.

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.

Since:

0.5.0

get

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

Send a `get` action to the GateKeeper Card.

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.

Since:

0.16.0

put

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

Send a `put` action to the GateKeeper Card.

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.

Since:

0.5.0

rename

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

Send a `rename` action to the GateKeeper Card.

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.

Since:

0.19.0

delete

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

Send a `delete` action to the GateKeeper Card.

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.

Since:

0.5.0

createPath

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

Send a `createPath` action to the GateKeeper Card.

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.

Since:

0.5.0

deletePath

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

Send a `deletePath` action to the GateKeeper Card.

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.

Since:

0.5.0

finalize

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

Send a `finalize` action to the GateKeeper Card.

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.

Since:

0.5.0

connect

void connect()
      throws java.io.IOException

Open a connection with the GateKeeper Card.

Throws:

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

Since:

0.5.0

disconnect

void disconnect()
         throws java.io.IOException

Close the connection with the GateKeeper Card.

Throws:

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

Since:

0.5.0

getConnectionState

GKCard.ConnectionState getConnectionState()

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

Returns:

the current ConnectionState between this object and the GateKeeper Card.

Since:

0.5.0

onConnectionChanged

void onConnectionChanged(GKCard.ConnectionState state)

Intended for internal use only.

Parameters:

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

addMonitor

void addMonitor(GKCard.Monitor monitor)

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

Parameters:

monitor - the Monitor to be added

Since:

0.5.0

removeMonitor

void removeMonitor(GKCard.Monitor monitor)

Remove a Monitor from the GKCard.

Parameters:

monitor - the Monitor to be removed

Since:

0.5.0