co.blustor.gatekeepersdk.services

Class GKFileActions

java.lang.Object

co.blustor.gatekeepersdk.services.GKFileActions

public class GKFileActions
extends java.lang.Object

GKFileActions is a Service for handling file data with the GateKeeper Card.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GKFileActions.FileResult FileResult encapsulates the result of basic file actions.
static class	GKFileActions.GetFileResult GetFileResult encapsulates the result of the "Get File" action.
static class	GKFileActions.ListFilesResult ListFilesResult encapsulates the result of the "List Files" action.
static class	GKFileActions.PutFileResult PutFileResult encapsulates the result of the "Put File" action.
static class	GKFileActions.Status Status is the named result of an action.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
GKFileActions.FileResult	deleteFile(GKFile file) Delete the given file on the GateKeeper Card.
GKFileActions.GetFileResult	getFile(GKFile file, java.io.File localFile) Retrieve the given file from the GateKeeper Card.
GKFileActions.ListFilesResult	listFiles(java.lang.String cardPath) Retrieve a list of files stored at the given path on the GateKeeper Card.
GKFileActions.FileResult	makeDirectory(java.lang.String cardPath) Create a directory at the given path on the GateKeeper Card.
GKFileActions.PutFileResult	putFile(java.io.InputStream localFile, java.lang.String cardPath) Store the given data to the given path on the GateKeeper Card.
GKFileActions.FileResult	renameFile(GKFile file, java.lang.String name) Rename the file located at fromCardPath to the name specified by toCardPath

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

GKFileActions

public GKFileActions(GKCard card)

Create a GKFileActions that communicates with card.

Parameters:

card - the GKCard to be used with file actions

Since:

0.5.0

Method Detail

listFiles

public GKFileActions.ListFilesResult listFiles(java.lang.String cardPath)
                                        throws java.io.IOException

Retrieve a list of files stored at the given path on the GateKeeper Card.

Parameters:

cardPath - the path at which to retrieve the list of files

Returns:

the ListFilesResult of the action

Throws:

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

Since:

0.5.0

getFile

public GKFileActions.GetFileResult getFile(GKFile file,
                                           java.io.File localFile)
                                    throws java.io.IOException

Retrieve the given file from the GateKeeper Card.

Parameters:

file - a GKFile referencing the file to retrieve

localFile - a File to store retrieved file data

Returns:

the GetFileResult of the action

Throws:

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

Since:

0.5.0

putFile

public GKFileActions.PutFileResult putFile(java.io.InputStream localFile,
                                           java.lang.String cardPath)
                                    throws java.io.IOException

Store the given data to the given path on the GateKeeper Card.

Parameters:

localFile - a stream with file data

cardPath - the path at which to store the file data

Returns:

the FileResult of the action

Throws:

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

Since:

0.5.0

renameFile

public GKFileActions.FileResult renameFile(GKFile file,
                                           java.lang.String name)
                                    throws java.io.IOException

Rename the file located at fromCardPath to the name specified by toCardPath

Parameters:

file - the GKFile to be renamed

name - the new name of the file, relative to the file's current card path

Returns:

the FileResult of the action

Throws:

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

Since:

0.19.0

deleteFile

public GKFileActions.FileResult deleteFile(GKFile file)
                                    throws java.io.IOException

Delete the given file on the GateKeeper Card.

Parameters:

file - a GKFile referencing the file to delete

Returns:

the FileResult of the action

Throws:

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

Since:

0.5.0

makeDirectory

public GKFileActions.FileResult makeDirectory(java.lang.String cardPath)
                                       throws java.io.IOException

Create a directory at the given path on the GateKeeper Card.

Parameters:

cardPath - the path at which to create the directory

Returns:

the FileResult of the action

Throws:

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

Since:

0.5.0