1 /*
2 * Copyright (c) 2005 The University of Reading
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the University of Reading, nor the names of the
14 * authors or contributors may be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 package uk.ac.rdg.resc.jstyx.messages;
30
31 import uk.ac.rdg.resc.jstyx.StyxUtils;
32
33 /***
34 * Message sent to delete a file from a Styx server
35 *
36 * @author Jon Blower
37 * $Revision: 146 $
38 * $Date: 2005-03-15 09:01:48 +0000 (Tue, 15 Mar 2005) $
39 * $Log$
40 * Revision 1.4 2005/03/15 09:01:48 jonblower
41 * Message type now stored as short, not int
42 *
43 * Revision 1.3 2005/03/11 14:02:16 jonblower
44 * Merged MINA-Test_20059309 into main line of development
45 *
46 * Revision 1.2.2.1 2005/03/10 11:50:59 jonblower
47 * Changed to fit with MINA framework
48 *
49 * Revision 1.2 2005/02/24 07:44:44 jonblower
50 * Added getFriendlyString()
51 *
52 * Revision 1.1.1.1 2005/02/16 18:58:29 jonblower
53 * Initial import
54 *
55 */
56 public class TremoveMessage extends StyxMessage
57 {
58
59 private long fid; // Fid of the file to remove
60
61 /***
62 * Creates a new TremoveMessage. This constructor will be called by the
63 * MessageRecognizer.
64 * @param length The total length of the message (including all header info)
65 * @param type The type of the message (a number between 100 and 127)
66 * @param tag The tag that identifies this message
67 */
68 public TremoveMessage(int length, short type, int tag)
69 {
70 super(length, type, tag);
71 this.name = "Tremove";
72 }
73
74 public TremoveMessage(long fid)
75 {
76 this(11, (short)122, 0); // The tag will be added later
77 this.fid = fid;
78 }
79
80 protected final void decodeBody(StyxBuffer buf)
81 {
82 this.fid = buf.getUInt();
83 }
84
85 protected final void encodeBody(StyxBuffer buf)
86 {
87 buf.putUInt(this.fid);
88 }
89
90 public long getFid()
91 {
92 return this.fid;
93 }
94
95 protected String getElements()
96 {
97 return ", " + this.fid;
98 }
99
100 public String toFriendlyString()
101 {
102 return "fid: " + this.fid;
103 }
104
105 }