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

Field Summary
static intACCESS_VIOLATION
The access violation error code according to RFC 783, value 2.
static intFILE_EXISTS
The file already exists error code according to RFC 783, value 6.
static intFILE_NOT_FOUND
The file not found error code according to RFC 783, value 1.
static intILLEGAL_OPERATION
The illegal TFTP operation error code according to RFC 783, value 4.
static intNO_SUCH_USER
The no such user error code according to RFC 783, value 7.
static intOUT_OF_SPACE
The disk full error code according to RFC 783, value 3.
static intUNDEFINED
The undefined error code according to RFC 783, value 0.
static intUNKNOWN_TID
The unknown transfer id error code according to RFC 783, value 5.
Constructor Summary
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
intgetError()
Returns the error code of the packet.
StringgetMessage()
Returns the error message of the packet.
DatagramPacketnewDatagram()
Creates a UDP datagram containing all the TFTP error packet data in the proper format.

Field Detail

ACCESS_VIOLATION

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

FILE_EXISTS

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

FILE_NOT_FOUND

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

ILLEGAL_OPERATION

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

NO_SUCH_USER

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

OUT_OF_SPACE

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

UNDEFINED

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

UNKNOWN_TID

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

Constructor Detail

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 Detail

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()
Creates a UDP datagram containing all the TFTP error packet data in the proper format. This is a method exposed to the programmer in case he wants to implement his own TFTP client instead of using the TFTPClient class. Under normal circumstances, you should not have a need to call this method.

Returns: A UDP datagram containing the TFTP error packet.