1 package org.apache.commons.net.tftp;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache Commons" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 import java.net.DatagramPacket;
58 import java.net.InetAddress;
59
60 /****
61 * A class derived from TFTPRequestPacket definiing a TFTP read request
62 * packet type.
63 * <p>
64 * Details regarding the TFTP protocol and the format of TFTP packets can
65 * be found in RFC 783. But the point of these classes is to keep you
66 * from having to worry about the internals. Additionally, only very
67 * few people should have to care about any of the TFTPPacket classes
68 * or derived classes. Almost all users should only be concerned with the
69 * <a href="org.apache.commons.net.tftp.TFTPClient.html#_top_">TFTPClient</a> class
70 * <a href="org.apache.commons.net.tftp.TFTPClient.html#receiveFile">receiveFile()</a>
71 * and
72 * <a href="org.apache.commons.net.tftp.TFTPClient.html#sendFile">sendFile()</a>
73 * methods.
74 * <p>
75 * <p>
76 * @author Daniel F. Savarese
77 * @see TFTPPacket
78 * @see TFTPRequestPacket
79 * @see TFTPPacketException
80 * @see TFTP
81 ***/
82
83 public final class TFTPReadRequestPacket extends TFTPRequestPacket
84 {
85
86 /****
87 * Creates a read request packet to be sent to a host at a
88 * given port with a filename and transfer mode request.
89 * <p>
90 * @param destination The host to which the packet is going to be sent.
91 * @param port The port to which the packet is going to be sent.
92 * @param filename The requested filename.
93 * @param mode The requested transfer mode. This should be on of the TFTP
94 * class MODE constants (e.g., TFTP.NETASCII_MODE).
95 ***/
96 public TFTPReadRequestPacket(InetAddress destination, int port,
97 String filename, int mode)
98 {
99 super(destination, port, TFTPPacket.READ_REQUEST, filename, mode);
100 }
101
102 /****
103 * Creates a read request packet of based on a received
104 * datagram and assumes the datagram has already been identified as a
105 * read request. Assumes the datagram is at least length 4, else an
106 * ArrayIndexOutOfBoundsException may be thrown.
107 * <p>
108 * @param datagram The datagram containing the received request.
109 * @throws TFTPPacketException If the datagram isn't a valid TFTP
110 * request packet.
111 ***/
112 TFTPReadRequestPacket(DatagramPacket datagram) throws TFTPPacketException
113 {
114 super(TFTPPacket.READ_REQUEST, datagram);
115 }
116
117 }
This page was automatically generated by Maven