com.digi.xbee.api.packet.devicecloud

Class SendDataRequestPacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

public class SendDataRequestPacket
extends XBeeAPIPacket

This class represents a Send Data Request packet. Packet is built using the parameters of the constructor or providing a valid API payload.

This frame type is used to send a file of the given name and type to Device Cloud.

If the frame ID is non-zero, a SendDataResponsePacket will be received.

Since:

1.2.0

See Also:

SendDataResponsePacket, XBeeAPIPacket

Field Summary

Fields inherited from class com.digi.xbee.api.packet.XBeeAPIPacket

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
SendDataRequestPacket(int frameID, String path, String contentType, SendDataRequestOptions options, byte[] fileData) Class constructor.

Method Summary

Modifier and Type	Method and Description
static SendDataRequestPacket	createPacket(byte[] payload) Creates a new SendDataRequestPacket object from the given payload.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
String	getContentType() Retrieves the content type of the file to upload.
byte[]	getFileData() Retrieves the data of the file to upload.
SendDataRequestOptions	getOptions() Retrieves the file upload operation options.
String	getPath() Retrieves the path of the file to upload to Device Cloud.
int	getTransport() Retrieves the transport.
boolean	isBroadcast() Returns whether or not the packet is a broadcast packet.
boolean	needsAPIFrameID() Returns whether the API packet needs API Frame ID or not.
void	setContentType(String contentType) Sets the content type of the file to upload.
void	setFileData(byte[] fileData) Sets the data of the file to upload.
void	setOptions(SendDataRequestOptions options) Sets the file upload operation options.
void	setPath(String path) Sets the path of the file to upload to Device Cloud.

Methods inherited from class com.digi.xbee.api.packet.XBeeAPIPacket

checkFrameID, getAPIData, getFrameID, getFrameType, getFrameTypeValue, getPacketData, setFrameID

Methods inherited from class com.digi.xbee.api.packet.XBeePacket

equals, generateByteArray, generateByteArrayEscaped, getChecksum, getPacketLength, getParameters, hashCode, parsePacket, parsePacket, toPrettyString, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendDataRequestPacket

public SendDataRequestPacket(int frameID,
                             String path,
                             String contentType,
                             SendDataRequestOptions options,
                             byte[] fileData)

Class constructor. Instantiates a new SendDataRequestPacket object with the given parameters.

Parameters:

frameID - Frame ID.

path - Path of the file to upload to Device Cloud.

contentType - Content type of the file to upload.

options - Options.

fileData - Data of the file to upload.

Throws:

IllegalArgumentException - if frameID < 0 or if frameID > 255.

NullPointerException - if options == null.

See Also:

SendDataRequestOptions

Method Detail

createPacket

public static SendDataRequestPacket createPacket(byte[] payload)

Creates a new SendDataRequestPacket object from the given payload.

Parameters:

payload - The API frame payload. It must start with the frame type corresponding to a Send Data Request packet (0x28). The byte array must be in OperatingMode.API mode.

Returns:

Parsed Send Data Request packet.

Throws:

IllegalArgumentException - if payload[0] != APIFrameType.SEND_DATA_REQUEST.getValue() or if payload.length < .

NullPointerException - if payload == null.

getAPIPacketParameters

public LinkedHashMap<String,String> getAPIPacketParameters()

Description copied from class: XBeeAPIPacket

Returns a map with the XBee packet parameters and their values.

Returns:

A sorted map containing the XBee packet parameters with their values.

getContentType

public String getContentType()

Retrieves the content type of the file to upload.

Returns:

The content type of the file to upload.

See Also:

setContentType(String)

getFileData

public byte[] getFileData()

Retrieves the data of the file to upload.

Returns:

The data of the file to upload.

See Also:

setFileData(byte[])

getOptions

public SendDataRequestOptions getOptions()

Retrieves the file upload operation options.

Returns:

The file upload operation options.

See Also:

setOptions(SendDataRequestOptions), SendDataRequestOptions

getPath

public String getPath()

Retrieves the path of the file to upload to Device Cloud.

Returns:

The path of the file to upload to Device Cloud.

See Also:

setPath(String)

getTransport

public int getTransport()

Retrieves the transport.

Returns:

The transport.

isBroadcast

public boolean isBroadcast()

Description copied from class: XBeeAPIPacket

Returns whether or not the packet is a broadcast packet.

Specified by:

isBroadcast in class XBeeAPIPacket

Returns:

true if the packet is a broadcast packet, false otherwise.

needsAPIFrameID

public boolean needsAPIFrameID()

Description copied from class: XBeeAPIPacket

Returns whether the API packet needs API Frame ID or not.

Specified by:

needsAPIFrameID in class XBeeAPIPacket

Returns:

true if the packet needs API Frame ID, false otherwise.

setContentType

public void setContentType(String contentType)

Sets the content type of the file to upload.

Parameters:

contentType - The content type of the file to upload.

See Also:

getContentType()

setFileData

public void setFileData(byte[] fileData)

Sets the data of the file to upload.

Parameters:

fileData - Data of the file to upload.

See Also:

getFileData()

setOptions

public void setOptions(SendDataRequestOptions options)

Sets the file upload operation options.

Parameters:

options - File upload operation options.

Throws:

NullPointerException - if options == null.

See Also:

getOptions(), SendDataRequestOptions

setPath

public void setPath(String path)

Sets the path of the file to upload to Device Cloud.

Parameters:

path - Path of the file to upload to Device Cloud.

See Also:

getPath()