co.blustor.gatekeepersdk.devices

Class GKCard.Response

java.lang.Object

co.blustor.gatekeepersdk.devices.GKCard.Response

Direct Known Subclasses:

GKCard.AbortResponse

Enclosing interface:

GKCard

public static class GKCard.Response
extends java.lang.Object

A Response captures the communication received from the GateKeeper Card during the execution of an action.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	mDataFile The File representing the location that any data is stored from a response
protected java.lang.String	mMessage The String message received at the conclusion of the action.
protected int	mStatus The numeric status code received at the conclusion of the action.

Constructor Summary

Constructors

Constructor and Description
Response(byte[] commandData) Create a Response with the given command data.
Response(byte[] commandData, java.io.File bodyDataFile) Create a Response with the given command and body data.
Response(GKCard.Response response) Create a Response with the basic attributes of the given Response.
Response(int status, java.lang.String message) Create a Response with the given status code and message.
Response(int status, java.lang.String message, java.io.File dataFile) Create a Response with the given status code, message, and dataFile.

Method Summary

Modifier and Type	Method and Description
java.io.File	getDataFile() Retrieve the body data of the Response.
java.lang.String	getMessage() Retrieve the message of the Response.
int	getStatus() Retrieve the status code of the Response.
java.lang.String	getStatusMessage() Retrieve the status message of the Response.
java.lang.String	readDataFile() Read the data file to a String.
void	setDataFile(java.io.File dataFile) Assign the file that holds the Response data.

Methods inherited from class java.lang.Object

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

Field Detail

mStatus

protected int mStatus

The numeric status code received at the conclusion of the action.

mMessage

protected java.lang.String mMessage

The String message received at the conclusion of the action.

mDataFile

protected java.io.File mDataFile

The File representing the location that any data is stored from a response

Constructor Detail

Response

public Response(GKCard.Response response)

Create a Response with the basic attributes of the given Response.

Parameters:

response - the Response object to copy

Since:

0.16.0

Response

public Response(int status,
                java.lang.String message)

Create a Response with the given status code and message.

Parameters:

status - the numeric status code to classify this response

message - the String message to describe this response

Since:

0.5.0

Response

public Response(int status,
                java.lang.String message,
                java.io.File dataFile)

Create a Response with the given status code, message, and dataFile.

Parameters:

status - the numeric status code to classify this response

message - the String message to describe this response

dataFile - the File that holds body data for this response

Since:

0.16.0

Response

public Response(byte[] commandData)

Create a Response with the given command data.

Parameters:

commandData - the data containing the status code and message

Since:

0.5.0

Response

public Response(byte[] commandData,
                java.io.File bodyDataFile)

Create a Response with the given command and body data.

Parameters:

commandData - the data containing the status code and message

bodyDataFile - the File containing body data

Since:

0.16.0

Method Detail

getStatus

public int getStatus()

Retrieve the status code of the Response.

Returns:

the numeric status code

Since:

0.5.0

getMessage

public java.lang.String getMessage()

Retrieve the message of the Response.

Returns:

the String message

Since:

0.5.0

getStatusMessage

public java.lang.String getStatusMessage()

Retrieve the status message of the Response.

Returns:

the space-separated status code and message

Since:

0.5.0

getDataFile

public java.io.File getDataFile()

Retrieve the body data of the Response.

Returns:

the File that hold the response data

Since:

0.16.0

setDataFile

public void setDataFile(java.io.File dataFile)

Assign the file that holds the Response data.

Parameters:

dataFile - the File that holds response data

Since:

0.16.0

readDataFile

public java.lang.String readDataFile()

Read the data file to a String. DO NOT use for large amounts of data.

Returns:

the String contents of the file, or an empty String if the file is not present or cannot be read

Since:

0.17.0