Package org.apache.commons.net.tftp
Class TFTPErrorPacket
java.lang.Object
org.apache.commons.net.tftp.TFTPPacket
org.apache.commons.net.tftp.TFTPErrorPacket
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.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The access violation error code according to RFC 783, value 2.private final int
The error code of this packet.static final int
The file already exists error code according to RFC 783, value 6.static final int
The file not found error code according to RFC 783, value 1.static final int
The illegal TFTP operation error code according to RFC 783, value 4.private final String
The error message of this packet.static final int
The no such user error code according to RFC 783, value 7.static final int
The disk full error code according to RFC 783, value 3.static final int
The undefined error code according to RFC 783, value 0.static final int
The unknown transfer id error code according to RFC 783, value 5.Fields inherited from class org.apache.commons.net.tftp.TFTPPacket
ACKNOWLEDGEMENT, address, DATA, ERROR, MIN_PACKET_SIZE, port, READ_REQUEST, SEGMENT_SIZE, type, WRITE_REQUEST
-
Constructor Summary
ConstructorsConstructorDescriptionTFTPErrorPacket
(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
Modifier and TypeMethodDescriptionint
getError()
Returns the error code of the packet.Returns the error message of the packet.Creates a UDP datagram containing all the TFTP error packet data in the proper format.(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.toString()
For debuggingMethods inherited from class org.apache.commons.net.tftp.TFTPPacket
getAddress, getPort, getType, newTFTPPacket, setAddress, setPort
-
Field Details
-
UNDEFINED
public static final int UNDEFINEDThe undefined error code according to RFC 783, value 0.- See Also:
-
FILE_NOT_FOUND
public static final int FILE_NOT_FOUNDThe file not found error code according to RFC 783, value 1.- See Also:
-
ACCESS_VIOLATION
public static final int ACCESS_VIOLATIONThe access violation error code according to RFC 783, value 2.- See Also:
-
OUT_OF_SPACE
public static final int OUT_OF_SPACEThe disk full error code according to RFC 783, value 3.- See Also:
-
ILLEGAL_OPERATION
public static final int ILLEGAL_OPERATIONThe illegal TFTP operation error code according to RFC 783, value 4.- See Also:
-
UNKNOWN_TID
public static final int UNKNOWN_TIDThe unknown transfer id error code according to RFC 783, value 5.- See Also:
-
FILE_EXISTS
public static final int FILE_EXISTSThe file already exists error code according to RFC 783, value 6.- See Also:
-
NO_SUCH_USER
public static final int NO_SUCH_USERThe no such user error code according to RFC 783, value 7.- See Also:
-
error
private final int errorThe error code of this packet. -
message
The error message of this packet.
-
-
Constructor Details
-
TFTPErrorPacket
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.
-
TFTPErrorPacket
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.
-
-
Method Details
-
newDatagram
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.- Specified by:
newDatagram
in classTFTPPacket
- Parameters:
datagram
- The datagram to create.data
- The buffer to store the packet and to use in the datagram.- Returns:
- The datagram argument.
-
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 theTFTPClient
class. Under normal circumstances, you should not have a need to call this method.- Specified by:
newDatagram
in classTFTPPacket
- Returns:
- A UDP datagram containing the TFTP error packet.
-
getError
public int getError()Returns the error code of the packet.- Returns:
- The error code of the packet.
-
getMessage
Returns the error message of the packet.- Returns:
- The error message of the packet.
-
toString
For debugging- Overrides:
toString
in classTFTPPacket
- Since:
- 3.6
-