View Javadoc

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 authorise a secure connection
35   *
36   * @author Jon Blower
37   * $Revision: 602 $
38   * $Date: 2006-03-21 09:06:15 +0000 (Tue, 21 Mar 2006) $
39   * $Log$
40   * Revision 1.6  2006/03/21 09:06:15  jonblower
41   * Still implementing authentication
42   *
43   * Revision 1.5  2006/03/20 17:51:48  jonblower
44   * Adding authentication to base JStyx system
45   *
46   * Revision 1.4  2005/03/15 09:01:48  jonblower
47   * Message type now stored as short, not int
48   *
49   * Revision 1.3  2005/03/11 14:02:15  jonblower
50   * Merged MINA-Test_20059309 into main line of development
51   *
52   * Revision 1.2.2.1  2005/03/10 11:50:59  jonblower
53   * Changed to fit with MINA framework
54   *
55   * Revision 1.2  2005/02/24 07:44:43  jonblower
56   * Added getFriendlyString()
57   *
58   * Revision 1.1.1.1  2005/02/16 18:58:28  jonblower
59   * Initial import
60   *
61   */
62  public class TauthMessage extends StyxMessage
63  {
64      
65      private long afid;    // Fid that will be used in a subsequent attach message
66      private String uname; // The username supplied by the client
67      private String aname; // The file tree that the user wishes to access
68      
69      /*** 
70       * Creates a new TauthMessage. This constructor will be called by the
71       * MessageRecognizer.
72       * @param length The total length of the message (including all header info)
73       * @param type The type of the message (a number between 100 and 127)
74       * @param tag The tag that identifies this message
75       */
76      public TauthMessage(int length, short type, int tag)
77      {
78          super(length, type, tag);
79          this.name = "Tauth";
80      }
81      
82      public TauthMessage(long afid, String uname, String aname)
83      {
84          this(0, (short)102, 0); // The length and tag will be added later
85          this.afid = afid;
86          this.uname = uname;
87          this.aname = aname;
88          // Get the length of the strings
89          int unameLen = StyxUtils.strToUTF8(uname).length;
90          int anameLen = StyxUtils.strToUTF8(aname).length;
91          // Set the length of the message
92          this.length = StyxUtils.HEADER_LENGTH + 4 + 2 + unameLen + 2 + anameLen;
93      }
94      
95      protected final void decodeBody(StyxBuffer buf)
96      {
97          this.afid = buf.getUInt();
98          this.uname = buf.getString();
99          this.aname = buf.getString();
100     }
101     
102     protected final void encodeBody(StyxBuffer buf)
103     {
104         buf.putUInt(this.afid).putString(this.uname).putString(this.aname);
105     }
106     
107     /***
108      * @return the requested fid of the authentication file
109      */
110     public long getAfid()
111     {
112         return this.afid;
113     }
114     
115     /***
116      * @return the username
117      */
118     public String getUName()
119     {
120         return this.uname;
121     }
122     
123     /***
124      * @return the name of the file tree that the client wishes to access
125      */
126     public String getAName()
127     {
128         return this.aname;
129     }
130     
131     protected String getElements()
132     {
133         return ", " + this.afid + ", " + this.uname + ", " + this.aname;
134     }
135     
136     public String toFriendlyString()
137     {
138         return "afid: " + this.afid + ", user: " + this.uname + ", aname: " +
139             this.aname;
140     }
141 
142 }