org.apache.commons.net.tftp

Class TFTPErrorPacket


public final class TFTPErrorPacket
extends TFTPPacket

A final class derived from TFTPPacket definiing the TFTP Error packet type.

Details regarding the TFTP protocol and the format of TFTP packets can be found in RFC 783. But the point of these classes is to keep you from having to worry about the internals. Additionally, only very few people should have to care about any of the TFTPPacket classes or derived classes. Almost all users should only be concerned with the TFTPClient class receiveFile() and sendFile() methods.

Author:
Daniel F. Savarese

See Also:
TFTPPacket, TFTPPacketException, TFTP

Field Summary

static int
ACCESS_VIOLATION
The access violation error code according to RFC 783, value 2.
static int
FILE_EXISTS
The file already exists error code according to RFC 783, value 6.
static int
FILE_NOT_FOUND
The file not found error code according to RFC 783, value 1.
static int
ILLEGAL_OPERATION
The illegal TFTP operation error code according to RFC 783, value 4.
static int
NO_SUCH_USER
The no such user error code according to RFC 783, value 7.
static int
OUT_OF_SPACE
The disk full error code according to RFC 783, value 3.
static int
UNDEFINED
The undefined error code according to RFC 783, value 0.
static int
UNKNOWN_TID
The unknown transfer id error code according to RFC 783, value 5.
(package private) int
_error
The error code of this packet.
(package private) String
_message
The error message of this packet.

Fields inherited from class org.apache.commons.net.tftp.TFTPPacket

ACKNOWLEDGEMENT, DATA, ERROR, MIN_PACKET_SIZE, READ_REQUEST, SEGMENT_SIZE, WRITE_REQUEST, _address, _port, _type

Constructor Summary

TFTPErrorPacket(DatagramPacket datagram)
Creates an error packet based from a received datagram.
TFTPErrorPacket(InetAddress destination, int port, int error, String message)
Creates an error packet to be sent to a host at a given port with an error code and error message.

Method Summary

(package private) DatagramPacket
_newDatagram(DatagramPacket datagram, byte[] data)
This is a method only available within the package for implementing efficient datagram transport by elminating buffering.
int
getError()
Returns the error code of the packet.
String
getMessage()
Returns the error message of the packet.
DatagramPacket
newDatagram()
Creates a UDP datagram containing all the TFTP error packet data in the proper format.

Methods inherited from class org.apache.commons.net.tftp.TFTPPacket

_newDatagram, getAddress, getPort, getType, newDatagram, newTFTPPacket, setAddress, setPort

Field Details

ACCESS_VIOLATION

public static final int ACCESS_VIOLATION
The access violation error code according to RFC 783, value 2. **

Field Value:
2


FILE_EXISTS

public static final int FILE_EXISTS
The file already exists error code according to RFC 783, value 6. **

Field Value:
6


FILE_NOT_FOUND

public static final int FILE_NOT_FOUND
The file not found error code according to RFC 783, value 1. **

Field Value:
1


ILLEGAL_OPERATION

public static final int ILLEGAL_OPERATION
The illegal TFTP operation error code according to RFC 783, value 4.

Field Value:
4


NO_SUCH_USER

public static final int NO_SUCH_USER
The no such user error code according to RFC 783, value 7. **

Field Value:
7


OUT_OF_SPACE

public static final int OUT_OF_SPACE
The disk full error code according to RFC 783, value 3. **

Field Value:
3


UNDEFINED

public static final int UNDEFINED
The undefined error code according to RFC 783, value 0. **

Field Value:
0


UNKNOWN_TID

public static final int UNKNOWN_TID
The unknown transfer id error code according to RFC 783, value 5. **

Field Value:
5


_error

(package private)  int _error
The error code of this packet. **


_message

(package private)  String _message
The error message of this packet. **

Constructor Details

TFTPErrorPacket

(package private)  TFTPErrorPacket(DatagramPacket datagram)
            throws TFTPPacketException
Creates an error packet based from a received datagram. Assumes the datagram is at least length 4, else an ArrayIndexOutOfBoundsException may be thrown.

Parameters:
datagram - The datagram containing the received error.

Throws:
TFTPPacketException - If the datagram isn't a valid TFTP error packet.


TFTPErrorPacket

public TFTPErrorPacket(InetAddress destination,
                       int port,
                       int error,
                       String message)
Creates an error packet to be sent to a host at a given port with an error code and error message.

Parameters:
destination - The host to which the packet is going to be sent.
port - The port to which the packet is going to be sent.
error - The error code of the packet.
message - The error message of the packet.

Method Details

_newDatagram

(package private)  DatagramPacket _newDatagram(DatagramPacket datagram,
                                               byte[] data)
This is a method only available within the package for implementing efficient datagram transport by elminating buffering. It takes a datagram as an argument, and a byte buffer in which to store the raw datagram data. Inside the method, the data is set as the datagram's data and the datagram returned.

Overrides:
_newDatagram in interface TFTPPacket

Parameters:
datagram - The datagram to create.
data - The buffer to store the packet and to use in the datagram.

Returns:
The datagram argument.


getError

public int getError()
Returns the error code of the packet.

Returns:
The error code of the packet.


getMessage

public String getMessage()
Returns the error message of the packet.

Returns:
The error message of the packet.


newDatagram

public DatagramPacket newDatagram()
Overrides:
newDatagram in interface TFTPPacket

Returns:
A UDP datagram containing the TFTP error packet.