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.Qid;
33
34 /***
35 * Message returned by the server in response to a TattachMessage
36 *
37 * @author Jon Blower
38 * $Revision: 146 $
39 * $Date: 2005-03-15 09:01:48 +0000 (Tue, 15 Mar 2005) $
40 * $Log$
41 * Revision 1.4 2005/03/15 09:01:47 jonblower
42 * Message type now stored as short, not int
43 *
44 * Revision 1.3 2005/03/11 14:02:15 jonblower
45 * Merged MINA-Test_20059309 into main line of development
46 *
47 * Revision 1.2.2.1 2005/03/10 11:50:59 jonblower
48 * Changed to fit with MINA framework
49 *
50 * Revision 1.2 2005/02/24 07:44:43 jonblower
51 * Added getFriendlyString()
52 *
53 * Revision 1.1.1.1 2005/02/16 18:58:26 jonblower
54 * Initial import
55 *
56 */
57 public class RattachMessage extends StyxMessage
58 {
59
60 private Qid qid; // The server's representation of the root of the file tree
61
62 /***
63 * Creates a new RversionMessage
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 RattachMessage(int length, short type, int tag)
69 {
70 super(length, type, tag);
71 this.name = "Rattach";
72 }
73
74 public RattachMessage(Qid qid)
75 {
76 this(0, (short)105, 0); // The tag is set later
77 this.qid = qid;
78 this.length = StyxUtils.HEADER_LENGTH + 13; // Just a header and a Qid
79 }
80
81 protected final void decodeBody(StyxBuffer styxBuf)
82 {
83 this.qid = styxBuf.getQid();
84 }
85
86 protected final void encodeBody(StyxBuffer styxBuf)
87 {
88 styxBuf.putQid(this.qid);
89 }
90
91 public Qid getQid()
92 {
93 return this.qid;
94 }
95
96 protected String getElements()
97 {
98 return ", " + this.qid;
99 }
100
101 public String toFriendlyString()
102 {
103 return "qid: " + this.qid.toFriendlyString();
104 }
105
106 }