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 import uk.ac.rdg.resc.jstyx.types.DirEntry;
33
34 /***
35 * Message returned by the server in response to a TstatMessage
36 * @todo Implement toFriendlyString() method
37 *
38 * @author Jon Blower
39 * $Revision: 146 $
40 * $Date: 2005-03-15 09:01:48 +0000 (Tue, 15 Mar 2005) $
41 * $Log$
42 * Revision 1.4 2005/03/15 09:01:48 jonblower
43 * Message type now stored as short, not int
44 *
45 * Revision 1.3 2005/03/11 14:02:15 jonblower
46 * Merged MINA-Test_20059309 into main line of development
47 *
48 * Revision 1.2.2.1 2005/03/10 11:50:59 jonblower
49 * Changed to fit with MINA framework
50 *
51 * Revision 1.2 2005/02/24 07:44:43 jonblower
52 * Added getFriendlyString()
53 *
54 * Revision 1.1.1.1 2005/02/16 18:58:27 jonblower
55 * Initial import
56 *
57 */
58 public class RstatMessage extends StyxMessage
59 {
60
61 private DirEntry dirEntry; // The attributes of the file that was queried
62
63 /***
64 * Creates a new RversionMessage
65 * @param length The total length of the message (including all header info)
66 * @param type The type of the message (a number between 100 and 127)
67 * @param tag The tag that identifies this message
68 */
69 public RstatMessage(int length, short type, int tag)
70 {
71 super(length, type, tag);
72 this.name = "Rstat";
73 }
74
75 public RstatMessage(DirEntry dirEntry)
76 {
77 this(0, (short)125, 0); // The tag and length are set later
78 this.dirEntry = dirEntry;
79 this.length = StyxUtils.HEADER_LENGTH + 2 + this.dirEntry.getSize();
80 }
81
82 protected final void decodeBody(StyxBuffer buf)
83 {
84 int dirEntrySize = buf.getUShort(); // The size of the whole DirEntry, redundant
85 this.dirEntry = buf.getDirEntry();
86 }
87
88 protected final void encodeBody(StyxBuffer buf)
89 {
90 buf.putUShort(this.dirEntry.getSize()).putDirEntry(this.dirEntry);
91 }
92
93 public DirEntry getDirEntry()
94 {
95 return this.dirEntry;
96 }
97
98 protected String getElements()
99 {
100 return ", " + this.dirEntry;
101 }
102
103 }