Refactor file layout
[openafs-wiki.git] / archive / JavaAdminAPI / Volume.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc on Mon Jun 09 15:53:39 PDT 2003 -->
6 <TITLE>
7 Volume (Java AFS API)
8 </TITLE>
9 <META NAME="keywords" CONTENT="org.openafs.jafs.Volume,Volume class">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
11 </HEAD>
12 <SCRIPT>
13 function asd()
14 {
15 parent.document.title="Volume (Java AFS API)";
16 }
17 </SCRIPT>
18 <BODY BGCOLOR="white" onload="asd();">
19
20 <!-- ========== START OF NAVBAR ========== -->
21 <A NAME="navbar_top"><!-- --></A>
22 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
23 <TR>
24 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
25 <A NAME="navbar_top_firstrow"><!-- --></A>
26 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
27   <TR ALIGN="center" VALIGN="top">
28   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
29   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
30   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Volume.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
31   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
32   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
33   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
34   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
35   </TR>
36 </TABLE>
37 </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
40 </TD>
41 </TR>
42
43 <TR>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 &nbsp;<A HREF="../../../org/openafs/jafs/VersionInfo.html"><B>PREV CLASS</B></A>&nbsp;
46 &nbsp;NEXT CLASS</FONT></TD>
47 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
48   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
49 &nbsp;<A HREF="Volume.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
50 &nbsp;
51 <SCRIPT>
52   <!--
53   if(window==top) {
54     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
55   }
56   //-->
57 </SCRIPT>
58 <NOSCRIPT>
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
60 </NOSCRIPT>
61 </FONT></TD>
62 </TR>
63 <TR>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
68 </TR>
69 </TABLE>
70 <!-- =========== END OF NAVBAR =========== -->
71
72 <HR>
73 <!-- ======== START OF CLASS DATA ======== -->
74 <H2>
75 <FONT SIZE="-1">
76 org.openafs.jafs</FONT>
77 <BR>
78 Class Volume</H2>
79 <PRE>
80 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">java.lang.Object</A>
81   |
82   +--<B>org.openafs.jafs.Volume</B>
83 </PRE>
84 <DL>
85 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Serializable.html">Serializable</A></DD>
86 </DL>
87 <HR>
88 <DL>
89 <DT>public class <B>Volume</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A><DT>implements <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Serializable.html">Serializable</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A></DL>
90
91 <P>
92 An abstract representation of an AFS volume.  It holds information about 
93  the server, such as what its quota is.
94  <BR><BR>
95
96  Constructing an instance of a <code>Volume</code> does not mean an actual 
97  AFS partition is created on a partition -- usually a <code>Volume</code>
98  object is a representation of an already existing AFS volume.  If, 
99  however, the <code>Volume</code> is constructed with the name of a 
100  volume that does not exist in the cell to which the provided 
101  <code>Partition</code> belongs, a new AFS volume with that name can be
102  created on that partition by calling the <A HREF="../../../org/openafs/jafs/Volume.html#create(int)"><CODE>create(int)</CODE></A> method.  If
103  such a volume does already exist when this method is called, an exception 
104  will be thrown.<BR><BR>
105
106  <!--Example of how to use class-->
107  The following is a simple example of how to construct and use a 
108  <code>Volume</code> object.  This example obtains the list of 
109  <code>Volume</code> objects residing on a particular partition, and prints
110  out the name and id of each one.<BR><BR>
111
112  <PRE>
113  import org.openafs.jafs.Cell;
114  import org.openafs.jafs.AFSException;
115  import org.openafs.jafs.Partition;
116  import org.openafs.jafs.Server;
117  import org.openafs.jafs.Volume;
118  ...
119  public class ...
120  {
121    ...
122    private Cell cell;
123    private Server server;
124    private Partition partition;
125    ...
126    public static void main(String[] args) throws Exception
127    {
128      String username      = arg[0];
129      String password      = arg[1];
130      String cellName      = arg[2];
131      String serverName    = arg[3];
132      String partitionName = arg[4];
133  
134      token  = new Token(username, password, cellName);
135      cell   = new Cell(token);
136      server = cell.getServer(serverName);
137      partition = cell.getPartition(partitionName);
138  
139      System.out.println("Volumes in Partition " + partition.getName() + ":");
140      Volume[] volumes = partition.getVolumes();
141      for (int i = 0; i < volumes.length; i++) {
142        System.out.println(" -> " + volumes[i] + ": " + volumes[i].getID());
143      }
144    }
145    ...
146  }
147  </PRE>
148 <P>
149
150 <P>
151 <DL>
152 <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html" TARGET="org.openafs.jafs.Volume">Serialized Form</A></DL>
153 <HR>
154
155 <P>
156 <!-- ======== NESTED CLASS SUMMARY ======== -->
157
158
159 <!-- =========== FIELD SUMMARY =========== -->
160
161 <A NAME="field_summary"><!-- --></A>
162 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
163 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
164 <TD COLSPAN=2><FONT SIZE="+2">
165 <B>Field Summary</B></FONT></TD>
166 </TR>
167 <TR BGCOLOR="white" CLASS="TableRowColor">
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169 <CODE>protected &nbsp;int</CODE></FONT></TD>
170 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#accessesSinceMidnight">accessesSinceMidnight</A></B></CODE>
171
172 <BR>
173 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
174 </TR>
175 <TR BGCOLOR="white" CLASS="TableRowColor">
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177 <CODE>protected &nbsp;int</CODE></FONT></TD>
178 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#backupID">backupID</A></B></CODE>
179
180 <BR>
181 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
182 </TR>
183 <TR BGCOLOR="white" CLASS="TableRowColor">
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185 <CODE>protected &nbsp;boolean</CODE></FONT></TD>
186 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#cachedInfo">cachedInfo</A></B></CODE>
187
188 <BR>
189 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
190 </TR>
191 <TR BGCOLOR="white" CLASS="TableRowColor">
192 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193 <CODE>protected &nbsp;<A HREF="../../../org/openafs/jafs/Cell.html">Cell</A></CODE></FONT></TD>
194 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#cell">cell</A></B></CODE>
195
196 <BR>
197 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
198 </TR>
199 <TR BGCOLOR="white" CLASS="TableRowColor">
200 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201 <CODE>protected &nbsp;long</CODE></FONT></TD>
202 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#copyCreationDate">copyCreationDate</A></B></CODE>
203
204 <BR>
205 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
206 </TR>
207 <TR BGCOLOR="white" CLASS="TableRowColor">
208 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209 <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A></CODE></FONT></TD>
210 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#copyCreationDateCal">copyCreationDateCal</A></B></CODE>
211
212 <BR>
213 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
214 </TR>
215 <TR BGCOLOR="white" CLASS="TableRowColor">
216 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217 <CODE>protected &nbsp;long</CODE></FONT></TD>
218 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#creationDate">creationDate</A></B></CODE>
219
220 <BR>
221 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
222 </TR>
223 <TR BGCOLOR="white" CLASS="TableRowColor">
224 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225 <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A></CODE></FONT></TD>
226 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#creationDateCal">creationDateCal</A></B></CODE>
227
228 <BR>
229 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
230 </TR>
231 <TR BGCOLOR="white" CLASS="TableRowColor">
232 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
233 <CODE>protected &nbsp;int</CODE></FONT></TD>
234 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#currentSize">currentSize</A></B></CODE>
235
236 <BR>
237 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
238 </TR>
239 <TR BGCOLOR="white" CLASS="TableRowColor">
240 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241 <CODE>protected &nbsp;int</CODE></FONT></TD>
242 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#disposition">disposition</A></B></CODE>
243
244 <BR>
245 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
246 </TR>
247 <TR BGCOLOR="white" CLASS="TableRowColor">
248 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
249 <CODE>protected &nbsp;int</CODE></FONT></TD>
250 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#fileCount">fileCount</A></B></CODE>
251
252 <BR>
253 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
254 </TR>
255 <TR BGCOLOR="white" CLASS="TableRowColor">
256 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257 <CODE>protected &nbsp;int</CODE></FONT></TD>
258 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#id">id</A></B></CODE>
259
260 <BR>
261 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
262 </TR>
263 <TR BGCOLOR="white" CLASS="TableRowColor">
264 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265 <CODE>protected &nbsp;long</CODE></FONT></TD>
266 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#lastAccessDate">lastAccessDate</A></B></CODE>
267
268 <BR>
269 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
270 </TR>
271 <TR BGCOLOR="white" CLASS="TableRowColor">
272 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273 <CODE>protected &nbsp;long</CODE></FONT></TD>
274 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#lastBackupDate">lastBackupDate</A></B></CODE>
275
276 <BR>
277 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
278 </TR>
279 <TR BGCOLOR="white" CLASS="TableRowColor">
280 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
281 <CODE>protected &nbsp;long</CODE></FONT></TD>
282 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#lastUpdateDate">lastUpdateDate</A></B></CODE>
283
284 <BR>
285 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
286 </TR>
287 <TR BGCOLOR="white" CLASS="TableRowColor">
288 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
289 <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A></CODE></FONT></TD>
290 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#lastUpdateDateCal">lastUpdateDateCal</A></B></CODE>
291
292 <BR>
293 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
294 </TR>
295 <TR BGCOLOR="white" CLASS="TableRowColor">
296 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
297 <CODE>protected &nbsp;int</CODE></FONT></TD>
298 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#maxQuota">maxQuota</A></B></CODE>
299
300 <BR>
301 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
302 </TR>
303 <TR BGCOLOR="white" CLASS="TableRowColor">
304 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305 <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
306 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#name">name</A></B></CODE>
307
308 <BR>
309 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
310 </TR>
311 <TR BGCOLOR="white" CLASS="TableRowColor">
312 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313 <CODE>protected &nbsp;<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A></CODE></FONT></TD>
314 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#partition">partition</A></B></CODE>
315
316 <BR>
317 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
318 </TR>
319 <TR BGCOLOR="white" CLASS="TableRowColor">
320 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321 <CODE>protected &nbsp;int</CODE></FONT></TD>
322 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#readOnlyID">readOnlyID</A></B></CODE>
323
324 <BR>
325 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
326 </TR>
327 <TR BGCOLOR="white" CLASS="TableRowColor">
328 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329 <CODE>protected &nbsp;int</CODE></FONT></TD>
330 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#readWriteID">readWriteID</A></B></CODE>
331
332 <BR>
333 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
334 </TR>
335 <TR BGCOLOR="white" CLASS="TableRowColor">
336 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337 <CODE>protected &nbsp;<A HREF="../../../org/openafs/jafs/Server.html">Server</A></CODE></FONT></TD>
338 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#server">server</A></B></CODE>
339
340 <BR>
341 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
342 </TR>
343 <TR BGCOLOR="white" CLASS="TableRowColor">
344 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
345 <CODE>protected &nbsp;int</CODE></FONT></TD>
346 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#status">status</A></B></CODE>
347
348 <BR>
349 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
350 </TR>
351 <TR BGCOLOR="white" CLASS="TableRowColor">
352 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
353 <CODE>protected &nbsp;int</CODE></FONT></TD>
354 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#type">type</A></B></CODE>
355
356 <BR>
357 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
358 </TR>
359 <TR BGCOLOR="white" CLASS="TableRowColor">
360 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
361 <CODE>static&nbsp;int</CODE></FONT></TD>
362 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_BUSY">VOLUME_BUSY</A></B></CODE>
363
364 <BR>
365 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Status/disposition busy</TD>
366 </TR>
367 <TR BGCOLOR="white" CLASS="TableRowColor">
368 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
369 <CODE>static&nbsp;int</CODE></FONT></TD>
370 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_DISK_FULL">VOLUME_DISK_FULL</A></B></CODE>
371
372 <BR>
373 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Status/disposition disk full</TD>
374 </TR>
375 <TR BGCOLOR="white" CLASS="TableRowColor">
376 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
377 <CODE>static&nbsp;int</CODE></FONT></TD>
378 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_MOVED">VOLUME_MOVED</A></B></CODE>
379
380 <BR>
381 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Status/disposition moved</TD>
382 </TR>
383 <TR BGCOLOR="white" CLASS="TableRowColor">
384 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
385 <CODE>static&nbsp;int</CODE></FONT></TD>
386 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_NO_SERVICE">VOLUME_NO_SERVICE</A></B></CODE>
387
388 <BR>
389 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Status/disposition no service</TD>
390 </TR>
391 <TR BGCOLOR="white" CLASS="TableRowColor">
392 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
393 <CODE>static&nbsp;int</CODE></FONT></TD>
394 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_NO_VNODE">VOLUME_NO_VNODE</A></B></CODE>
395
396 <BR>
397 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Status/disposition no vnode</TD>
398 </TR>
399 <TR BGCOLOR="white" CLASS="TableRowColor">
400 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
401 <CODE>static&nbsp;int</CODE></FONT></TD>
402 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_NO_VOL">VOLUME_NO_VOL</A></B></CODE>
403
404 <BR>
405 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Status/disposition no volume</TD>
406 </TR>
407 <TR BGCOLOR="white" CLASS="TableRowColor">
408 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
409 <CODE>static&nbsp;int</CODE></FONT></TD>
410 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_OFFLINE">VOLUME_OFFLINE</A></B></CODE>
411
412 <BR>
413 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Status/disposition offline</TD>
414 </TR>
415 <TR BGCOLOR="white" CLASS="TableRowColor">
416 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
417 <CODE>static&nbsp;int</CODE></FONT></TD>
418 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_OK">VOLUME_OK</A></B></CODE>
419
420 <BR>
421 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Status/disposition ok</TD>
422 </TR>
423 <TR BGCOLOR="white" CLASS="TableRowColor">
424 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
425 <CODE>static&nbsp;int</CODE></FONT></TD>
426 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_ONLINE">VOLUME_ONLINE</A></B></CODE>
427
428 <BR>
429 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Status/disposition online</TD>
430 </TR>
431 <TR BGCOLOR="white" CLASS="TableRowColor">
432 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
433 <CODE>static&nbsp;int</CODE></FONT></TD>
434 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_OVER_QUOTA">VOLUME_OVER_QUOTA</A></B></CODE>
435
436 <BR>
437 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Status/disposition over quota</TD>
438 </TR>
439 <TR BGCOLOR="white" CLASS="TableRowColor">
440 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
441 <CODE>static&nbsp;int</CODE></FONT></TD>
442 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_SALVAGE">VOLUME_SALVAGE</A></B></CODE>
443
444 <BR>
445 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Status/disposition salvage</TD>
446 </TR>
447 <TR BGCOLOR="white" CLASS="TableRowColor">
448 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
449 <CODE>static&nbsp;int</CODE></FONT></TD>
450 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_TYPE_BACKUP">VOLUME_TYPE_BACKUP</A></B></CODE>
451
452 <BR>
453 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Backup volume type</TD>
454 </TR>
455 <TR BGCOLOR="white" CLASS="TableRowColor">
456 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
457 <CODE>static&nbsp;int</CODE></FONT></TD>
458 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_TYPE_READ_ONLY">VOLUME_TYPE_READ_ONLY</A></B></CODE>
459
460 <BR>
461 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read-only volume type</TD>
462 </TR>
463 <TR BGCOLOR="white" CLASS="TableRowColor">
464 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
465 <CODE>static&nbsp;int</CODE></FONT></TD>
466 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_TYPE_READ_WRITE">VOLUME_TYPE_READ_WRITE</A></B></CODE>
467
468 <BR>
469 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read-write volume type</TD>
470 </TR>
471 <TR BGCOLOR="white" CLASS="TableRowColor">
472 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
473 <CODE>static&nbsp;int</CODE></FONT></TD>
474 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_VOL_EXISTS">VOLUME_VOL_EXISTS</A></B></CODE>
475
476 <BR>
477 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Status/disposition volume exists</TD>
478 </TR>
479 </TABLE>
480 &nbsp;
481 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
482
483 <A NAME="constructor_summary"><!-- --></A>
484 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
485 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
486 <TD COLSPAN=2><FONT SIZE="+2">
487 <B>Constructor Summary</B></FONT></TD>
488 </TR>
489 <TR BGCOLOR="white" CLASS="TableRowColor">
490 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
491 <CODE>(package private)</CODE></FONT></TD>
492 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#Volume(org.openafs.jafs.Partition)">Volume</A></B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;partition)</CODE>
493
494 <BR>
495 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a blank <code>Volume</code> given the cell to which the volume
496  belongs, the server on which the partition resides, and 
497  the partition on which the volume resides. </TD>
498 </TR>
499 <TR BGCOLOR="white" CLASS="TableRowColor">
500 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
501 <CODE>&nbsp;</CODE></FONT></TD>
502 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#Volume(java.lang.String, org.openafs.jafs.Partition)">Volume</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
503        <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;partition)</CODE>
504
505 <BR>
506 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new <CODE>Volume</CODE> object instance given the name of 
507  the AFS volume and the AFS cell, represented by <CODE>partition</CODE>, 
508  to which it belongs.   </TD>
509 </TR>
510 <TR BGCOLOR="white" CLASS="TableRowColor">
511 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
512 <CODE>&nbsp;</CODE></FONT></TD>
513 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#Volume(java.lang.String, org.openafs.jafs.Partition, boolean)">Volume</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
514        <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;partition,
515        boolean&nbsp;preloadAllMembers)</CODE>
516
517 <BR>
518 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new <CODE>Volume</CODE> object instance given the name of 
519  the AFS volume and the AFS partition, represented by 
520  <CODE>partition</CODE>, to which it belongs.    </TD>
521 </TR>
522 </TABLE>
523 &nbsp;
524 <!-- ========== METHOD SUMMARY =========== -->
525
526 <A NAME="method_summary"><!-- --></A>
527 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
528 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
529 <TD COLSPAN=2><FONT SIZE="+2">
530 <B>Method Summary</B></FONT></TD>
531 </TR>
532 <TR BGCOLOR="white" CLASS="TableRowColor">
533 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
534 <CODE>protected static&nbsp;void</CODE></FONT></TD>
535 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#changeQuota(int, int, int, int, int)">changeQuota</A></B>(int&nbsp;cellHandle,
536             int&nbsp;serverHandle,
537             int&nbsp;partition,
538             int&nbsp;volId,
539             int&nbsp;newQuota)</CODE>
540
541 <BR>
542 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Changes the quota of the specified volume.</TD>
543 </TR>
544 <TR BGCOLOR="white" CLASS="TableRowColor">
545 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
546 <CODE>&nbsp;int</CODE></FONT></TD>
547 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#compareTo(java.lang.Object)">compareTo</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A>&nbsp;obj)</CODE>
548
549 <BR>
550 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Comparable interface method.</TD>
551 </TR>
552 <TR BGCOLOR="white" CLASS="TableRowColor">
553 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
554 <CODE>&nbsp;int</CODE></FONT></TD>
555 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#compareTo(org.openafs.jafs.Volume)">compareTo</A></B>(<A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>&nbsp;volume)</CODE>
556
557 <BR>
558 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares two Volume objects respective to their names and does not
559  factor any other attribute.    </TD>
560 </TR>
561 <TR BGCOLOR="white" CLASS="TableRowColor">
562 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
563 <CODE>&nbsp;void</CODE></FONT></TD>
564 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#create(int)">create</A></B>(int&nbsp;quota)</CODE>
565
566 <BR>
567 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new volume on the server and partition given upon construction.</TD>
568 </TR>
569 <TR BGCOLOR="white" CLASS="TableRowColor">
570 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
571 <CODE>protected static&nbsp;int</CODE></FONT></TD>
572 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#create(int, int, int, java.lang.String, int)">create</A></B>(int&nbsp;cellHandle,
573        int&nbsp;serverHandle,
574        int&nbsp;partition,
575        <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;volumeName,
576        int&nbsp;quota)</CODE>
577
578 <BR>
579 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a volume on a particular partition.</TD>
580 </TR>
581 <TR BGCOLOR="white" CLASS="TableRowColor">
582 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
583 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/Volume.html">Volume</A></CODE></FONT></TD>
584 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#createBackup()">createBackup</A></B>()</CODE>
585
586 <BR>
587 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a backup volume for this volume.</TD>
588 </TR>
589 <TR BGCOLOR="white" CLASS="TableRowColor">
590 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
591 <CODE>protected static&nbsp;void</CODE></FONT></TD>
592 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#createBackupVolume(int, int)">createBackupVolume</A></B>(int&nbsp;cellHandle,
593                    int&nbsp;volId)</CODE>
594
595 <BR>
596 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a backup volume for the specified regular volume.</TD>
597 </TR>
598 <TR BGCOLOR="white" CLASS="TableRowColor">
599 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
600 <CODE>&nbsp;void</CODE></FONT></TD>
601 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#createMountPoint(java.lang.String)">createMountPoint</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;directory)</CODE>
602
603 <BR>
604 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a read-write mount point for this volume.  </TD>
605 </TR>
606 <TR BGCOLOR="white" CLASS="TableRowColor">
607 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
608 <CODE>&nbsp;void</CODE></FONT></TD>
609 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#createMountPoint(java.lang.String, boolean)">createMountPoint</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;directory,
610                  boolean&nbsp;readWrite)</CODE>
611
612 <BR>
613 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a mount point for this volume.  </TD>
614 </TR>
615 <TR BGCOLOR="white" CLASS="TableRowColor">
616 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
617 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/Volume.html">Volume</A></CODE></FONT></TD>
618 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#createReadOnly(org.openafs.jafs.Partition)">createReadOnly</A></B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;sitePartition)</CODE>
619
620 <BR>
621 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a readonly site for this volume on the specified server and 
622  partition.  </TD>
623 </TR>
624 <TR BGCOLOR="white" CLASS="TableRowColor">
625 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
626 <CODE>protected static&nbsp;void</CODE></FONT></TD>
627 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#createReadOnlyVolume(int, int, int, int)">createReadOnlyVolume</A></B>(int&nbsp;cellHandle,
628                      int&nbsp;serverHandle,
629                      int&nbsp;partition,
630                      int&nbsp;volId)</CODE>
631
632 <BR>
633 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a read-only volume for the specified regular volume.</TD>
634 </TR>
635 <TR BGCOLOR="white" CLASS="TableRowColor">
636 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
637 <CODE>&nbsp;void</CODE></FONT></TD>
638 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#delete()">delete</A></B>()</CODE>
639
640 <BR>
641 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the volume from the cell.</TD>
642 </TR>
643 <TR BGCOLOR="white" CLASS="TableRowColor">
644 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
645 <CODE>protected static&nbsp;void</CODE></FONT></TD>
646 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#delete(int, int, int, int)">delete</A></B>(int&nbsp;cellHandle,
647        int&nbsp;serverHandle,
648        int&nbsp;partition,
649        int&nbsp;volId)</CODE>
650
651 <BR>
652 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes a volume from a particular partition.</TD>
653 </TR>
654 <TR BGCOLOR="white" CLASS="TableRowColor">
655 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
656 <CODE>protected static&nbsp;void</CODE></FONT></TD>
657 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#deleteReadOnlyVolume(int, int, int, int)">deleteReadOnlyVolume</A></B>(int&nbsp;cellHandle,
658                      int&nbsp;serverHandle,
659                      int&nbsp;partition,
660                      int&nbsp;volId)</CODE>
661
662 <BR>
663 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes a read-only volume for the specified regular volume.</TD>
664 </TR>
665 <TR BGCOLOR="white" CLASS="TableRowColor">
666 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
667 <CODE>protected static&nbsp;void</CODE></FONT></TD>
668 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#dump(int, int, int, int, int, java.lang.String)">dump</A></B>(int&nbsp;cellHandle,
669      int&nbsp;serverHandle,
670      int&nbsp;partition,
671      int&nbsp;volId,
672      int&nbsp;startTime,
673      <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;dumpFile)</CODE>
674
675 <BR>
676 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dumps the specified volume to a file.</TD>
677 </TR>
678 <TR BGCOLOR="white" CLASS="TableRowColor">
679 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
680 <CODE>&nbsp;void</CODE></FONT></TD>
681 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#dump(java.lang.String)">dump</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;fileName)</CODE>
682
683 <BR>
684 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dumps this volume to a file. </TD>
685 </TR>
686 <TR BGCOLOR="white" CLASS="TableRowColor">
687 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
688 <CODE>&nbsp;void</CODE></FONT></TD>
689 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#dump(java.lang.String, java.util.GregorianCalendar)">dump</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;fileName,
690      <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A>&nbsp;dumpSince)</CODE>
691
692 <BR>
693 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dumps this volume to a file. </TD>
694 </TR>
695 <TR BGCOLOR="white" CLASS="TableRowColor">
696 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
697 <CODE>&nbsp;boolean</CODE></FONT></TD>
698 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#equals(org.openafs.jafs.Volume)">equals</A></B>(<A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>&nbsp;otherVolume)</CODE>
699
700 <BR>
701 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests whether two <code>Volume</code> objects are equal, based on their 
702  names and hosting partition.</TD>
703 </TR>
704 <TR BGCOLOR="white" CLASS="TableRowColor">
705 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
706 <CODE>&nbsp;int</CODE></FONT></TD>
707 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getAccessesSinceMidnight()">getAccessesSinceMidnight</A></B>()</CODE>
708
709 <BR>
710 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of accesses since midnight.
711  </TD>
712 </TR>
713 <TR BGCOLOR="white" CLASS="TableRowColor">
714 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
715 <CODE>&nbsp;int</CODE></FONT></TD>
716 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getBackupID()">getBackupID</A></B>()</CODE>
717
718 <BR>
719 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the backup ID of this volume</TD>
720 </TR>
721 <TR BGCOLOR="white" CLASS="TableRowColor">
722 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
723 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A></CODE></FONT></TD>
724 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getCopyCreationDate()">getCopyCreationDate</A></B>()</CODE>
725
726 <BR>
727 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the date the volume was copied.
728  </TD>
729 </TR>
730 <TR BGCOLOR="white" CLASS="TableRowColor">
731 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
732 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A></CODE></FONT></TD>
733 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getCreationDate()">getCreationDate</A></B>()</CODE>
734
735 <BR>
736 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the date the volume was created</TD>
737 </TR>
738 <TR BGCOLOR="white" CLASS="TableRowColor">
739 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
740 <CODE>&nbsp;int</CODE></FONT></TD>
741 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getCurrentSize()">getCurrentSize</A></B>()</CODE>
742
743 <BR>
744 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns current volume size in K.
745  </TD>
746 </TR>
747 <TR BGCOLOR="white" CLASS="TableRowColor">
748 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
749 <CODE>&nbsp;int</CODE></FONT></TD>
750 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getDisposition()">getDisposition</A></B>()</CODE>
751
752 <BR>
753 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns volume disposition. </TD>
754 </TR>
755 <TR BGCOLOR="white" CLASS="TableRowColor">
756 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
757 <CODE>&nbsp;int</CODE></FONT></TD>
758 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getFileCount()">getFileCount</A></B>()</CODE>
759
760 <BR>
761 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns file count.
762  </TD>
763 </TR>
764 <TR BGCOLOR="white" CLASS="TableRowColor">
765 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
766 <CODE>&nbsp;int</CODE></FONT></TD>
767 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getID()">getID</A></B>()</CODE>
768
769 <BR>
770 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the id of this volume.</TD>
771 </TR>
772 <TR BGCOLOR="white" CLASS="TableRowColor">
773 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
774 <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
775 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getInfo()">getInfo</A></B>()</CODE>
776
777 <BR>
778 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <code>String</code> representation of this <code>Volume</code>.
779  </TD>
780 </TR>
781 <TR BGCOLOR="white" CLASS="TableRowColor">
782 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
783 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A></CODE></FONT></TD>
784 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getLastUpdateDate()">getLastUpdateDate</A></B>()</CODE>
785
786 <BR>
787 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the date the volume was last updated.
788  </TD>
789 </TR>
790 <TR BGCOLOR="white" CLASS="TableRowColor">
791 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
792 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
793 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getName()">getName</A></B>()</CODE>
794
795 <BR>
796 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this volume.</TD>
797 </TR>
798 <TR BGCOLOR="white" CLASS="TableRowColor">
799 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
800 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A></CODE></FONT></TD>
801 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getPartition()">getPartition</A></B>()</CODE>
802
803 <BR>
804 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns this volume's hosting partition.</TD>
805 </TR>
806 <TR BGCOLOR="white" CLASS="TableRowColor">
807 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
808 <CODE>&nbsp;int</CODE></FONT></TD>
809 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getQuota()">getQuota</A></B>()</CODE>
810
811 <BR>
812 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns this volume's quota, expressed in kilobyte blocks (1024 
813  kilobyte blocks equal one megabyte). </TD>
814 </TR>
815 <TR BGCOLOR="white" CLASS="TableRowColor">
816 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
817 <CODE>&nbsp;int</CODE></FONT></TD>
818 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getReadOnlyID()">getReadOnlyID</A></B>()</CODE>
819
820 <BR>
821 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the read-only ID of this volume</TD>
822 </TR>
823 <TR BGCOLOR="white" CLASS="TableRowColor">
824 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
825 <CODE>&nbsp;int</CODE></FONT></TD>
826 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getReadWriteID()">getReadWriteID</A></B>()</CODE>
827
828 <BR>
829 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the read-write ID of this volume</TD>
830 </TR>
831 <TR BGCOLOR="white" CLASS="TableRowColor">
832 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
833 <CODE>&nbsp;int</CODE></FONT></TD>
834 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getStatus()">getStatus</A></B>()</CODE>
835
836 <BR>
837 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns volume status. </TD>
838 </TR>
839 <TR BGCOLOR="white" CLASS="TableRowColor">
840 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
841 <CODE>&nbsp;int</CODE></FONT></TD>
842 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getTotalFreeSpace()">getTotalFreeSpace</A></B>()</CODE>
843
844 <BR>
845 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the difference between quota and current volume size (in K).
846
847  </TD>
848 </TR>
849 <TR BGCOLOR="white" CLASS="TableRowColor">
850 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
851 <CODE>&nbsp;int</CODE></FONT></TD>
852 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getType()">getType</A></B>()</CODE>
853
854 <BR>
855 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns volume type. </TD>
856 </TR>
857 <TR BGCOLOR="white" CLASS="TableRowColor">
858 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
859 <CODE>protected static&nbsp;void</CODE></FONT></TD>
860 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getVolumeInfo(int, int, int, int, org.openafs.jafs.Volume)">getVolumeInfo</A></B>(int&nbsp;cellHandle,
861               int&nbsp;serverHandle,
862               int&nbsp;partition,
863               int&nbsp;volId,
864               <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>&nbsp;theVolume)</CODE>
865
866 <BR>
867 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fills in the information fields of the provided <code>Volume</code>.</TD>
868 </TR>
869 <TR BGCOLOR="white" CLASS="TableRowColor">
870 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
871 <CODE>&nbsp;boolean</CODE></FONT></TD>
872 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#isQuotaUnlimited()">isQuotaUnlimited</A></B>()</CODE>
873
874 <BR>
875 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests whether this volume's quota is configured as unlimited.
876
877  </TD>
878 </TR>
879 <TR BGCOLOR="white" CLASS="TableRowColor">
880 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
881 <CODE>&nbsp;void</CODE></FONT></TD>
882 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#lock()">lock</A></B>()</CODE>
883
884 <BR>
885 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Locks the VLDB enrty for this volume</TD>
886 </TR>
887 <TR BGCOLOR="white" CLASS="TableRowColor">
888 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
889 <CODE>protected static&nbsp;void</CODE></FONT></TD>
890 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#lock(int, int)">lock</A></B>(int&nbsp;cellHandle,
891      int&nbsp;volId)</CODE>
892
893 <BR>
894 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Locks the VLDB entry specified volume</TD>
895 </TR>
896 <TR BGCOLOR="white" CLASS="TableRowColor">
897 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
898 <CODE>&nbsp;void</CODE></FONT></TD>
899 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#mount()">mount</A></B>()</CODE>
900
901 <BR>
902 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Mounts this volume, bringing it online and making it accessible.</TD>
903 </TR>
904 <TR BGCOLOR="white" CLASS="TableRowColor">
905 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
906 <CODE>protected static&nbsp;void</CODE></FONT></TD>
907 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#mount(int, int, int, int, boolean)">mount</A></B>(int&nbsp;serverHandle,
908       int&nbsp;partition,
909       int&nbsp;volId,
910       int&nbsp;sleepTime,
911       boolean&nbsp;offline)</CODE>
912
913 <BR>
914 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"Mounts" the specified volume, bringing it online.</TD>
915 </TR>
916 <TR BGCOLOR="white" CLASS="TableRowColor">
917 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
918 <CODE>protected static&nbsp;void</CODE></FONT></TD>
919 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#move(int, int, int, int, int, int)">move</A></B>(int&nbsp;cellHandle,
920      int&nbsp;fromServerHandle,
921      int&nbsp;fromPartition,
922      int&nbsp;toServerHandle,
923      int&nbsp;toPartition,
924      int&nbsp;volId)</CODE>
925
926 <BR>
927 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the specified volume to a different site.</TD>
928 </TR>
929 <TR BGCOLOR="white" CLASS="TableRowColor">
930 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
931 <CODE>&nbsp;void</CODE></FONT></TD>
932 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#moveTo(org.openafs.jafs.Partition)">moveTo</A></B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;newPartition)</CODE>
933
934 <BR>
935 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Moves this volume to the specified partition (which indirectly 
936  specifies a new server, as well).  </TD>
937 </TR>
938 <TR BGCOLOR="white" CLASS="TableRowColor">
939 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
940 <CODE>protected static&nbsp;void</CODE></FONT></TD>
941 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#reclaimVolumeMemory()">reclaimVolumeMemory</A></B>()</CODE>
942
943 <BR>
944 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reclaims all memory being saved by the volume portion of the native 
945  library. </TD>
946 </TR>
947 <TR BGCOLOR="white" CLASS="TableRowColor">
948 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
949 <CODE>&nbsp;void</CODE></FONT></TD>
950 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#refresh()">refresh</A></B>()</CODE>
951
952 <BR>
953 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Refreshes the properties of this Volume object instance with values from 
954  the AFS volume it represents.  </TD>
955 </TR>
956 <TR BGCOLOR="white" CLASS="TableRowColor">
957 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
958 <CODE>protected &nbsp;void</CODE></FONT></TD>
959 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#refresh(boolean)">refresh</A></B>(boolean&nbsp;all)</CODE>
960
961 <BR>
962 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Refreshes the properties of this Volume object instance with values from 
963  the AFS volume it represents.  </TD>
964 </TR>
965 <TR BGCOLOR="white" CLASS="TableRowColor">
966 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
967 <CODE>protected &nbsp;void</CODE></FONT></TD>
968 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#refreshInfo()">refreshInfo</A></B>()</CODE>
969
970 <BR>
971 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Refreshes the information fields of this <code>Volume</code> to reflect 
972  the current state of the AFS volume. </TD>
973 </TR>
974 <TR BGCOLOR="white" CLASS="TableRowColor">
975 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
976 <CODE>&nbsp;void</CODE></FONT></TD>
977 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#release()">release</A></B>()</CODE>
978
979 <BR>
980 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Releases this volume, which updates the read-only copies of it.
981
982  </TD>
983 </TR>
984 <TR BGCOLOR="white" CLASS="TableRowColor">
985 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
986 <CODE>&nbsp;void</CODE></FONT></TD>
987 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#release(boolean)">release</A></B>(boolean&nbsp;forceComplete)</CODE>
988
989 <BR>
990 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Releases this volume, which updates the read-only copies of it.</TD>
991 </TR>
992 <TR BGCOLOR="white" CLASS="TableRowColor">
993 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
994 <CODE>protected static&nbsp;void</CODE></FONT></TD>
995 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#release(int, int, boolean)">release</A></B>(int&nbsp;cellHandle,
996         int&nbsp;volId,
997         boolean&nbsp;forceComplete)</CODE>
998
999 <BR>
1000 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Releases the specified volume that has readonly volume sites.</TD>
1001 </TR>
1002 <TR BGCOLOR="white" CLASS="TableRowColor">
1003 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1004 <CODE>protected static&nbsp;void</CODE></FONT></TD>
1005 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#rename(int, int, java.lang.String)">rename</A></B>(int&nbsp;cellHandle,
1006        int&nbsp;volId,
1007        <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;newVolumeName)</CODE>
1008
1009 <BR>
1010 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Renames the specified read-write volume.</TD>
1011 </TR>
1012 <TR BGCOLOR="white" CLASS="TableRowColor">
1013 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1014 <CODE>&nbsp;void</CODE></FONT></TD>
1015 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#rename(java.lang.String)">rename</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;newName)</CODE>
1016
1017 <BR>
1018 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Renames this volume.</TD>
1019 </TR>
1020 <TR BGCOLOR="white" CLASS="TableRowColor">
1021 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1022 <CODE>protected static&nbsp;void</CODE></FONT></TD>
1023 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#restore(int, int, int, int, java.lang.String, java.lang.String, boolean)">restore</A></B>(int&nbsp;cellHandle,
1024         int&nbsp;serverHandle,
1025         int&nbsp;partition,
1026         int&nbsp;volId,
1027         <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;volumeName,
1028         <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;dumpFile,
1029         boolean&nbsp;incremental)</CODE>
1030
1031 <BR>
1032 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restores the specified volume from a dump file.</TD>
1033 </TR>
1034 <TR BGCOLOR="white" CLASS="TableRowColor">
1035 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1036 <CODE>&nbsp;void</CODE></FONT></TD>
1037 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#restore(java.lang.String, boolean)">restore</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;fileName,
1038         boolean&nbsp;incremental)</CODE>
1039
1040 <BR>
1041 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restores a file to this volume.  </TD>
1042 </TR>
1043 <TR BGCOLOR="white" CLASS="TableRowColor">
1044 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1045 <CODE>&nbsp;void</CODE></FONT></TD>
1046 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#restore(java.lang.String, boolean, int)">restore</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;fileName,
1047         boolean&nbsp;incremental,
1048         int&nbsp;id)</CODE>
1049
1050 <BR>
1051 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restores a file to this volume.  </TD>
1052 </TR>
1053 <TR BGCOLOR="white" CLASS="TableRowColor">
1054 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1055 <CODE>&nbsp;void</CODE></FONT></TD>
1056 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#salvage()">salvage</A></B>()</CODE>
1057
1058 <BR>
1059 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Salvages (restores consistency to) this volume.  </TD>
1060 </TR>
1061 <TR BGCOLOR="white" CLASS="TableRowColor">
1062 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1063 <CODE>&nbsp;void</CODE></FONT></TD>
1064 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#setQuota(int)">setQuota</A></B>(int&nbsp;quota)</CODE>
1065
1066 <BR>
1067 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets quota of volume, 0 denotes an unlimited quota.</TD>
1068 </TR>
1069 <TR BGCOLOR="white" CLASS="TableRowColor">
1070 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1071 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
1072 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#toString()">toString</A></B>()</CODE>
1073
1074 <BR>
1075 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this <CODE>Volume</CODE></TD>
1076 </TR>
1077 <TR BGCOLOR="white" CLASS="TableRowColor">
1078 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1079 <CODE>protected static&nbsp;int</CODE></FONT></TD>
1080 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#translateNameToID(int, java.lang.String, int)">translateNameToID</A></B>(int&nbsp;cellHandle,
1081                   <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
1082                   int&nbsp;volumeType)</CODE>
1083
1084 <BR>
1085 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Translates a volume name into a volume id</TD>
1086 </TR>
1087 <TR BGCOLOR="white" CLASS="TableRowColor">
1088 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1089 <CODE>&nbsp;void</CODE></FONT></TD>
1090 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#unlock()">unlock</A></B>()</CODE>
1091
1092 <BR>
1093 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unlocks the VLDB entry for this volume</TD>
1094 </TR>
1095 <TR BGCOLOR="white" CLASS="TableRowColor">
1096 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1097 <CODE>protected static&nbsp;void</CODE></FONT></TD>
1098 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#unlock(int, int)">unlock</A></B>(int&nbsp;cellHandle,
1099        int&nbsp;volId)</CODE>
1100
1101 <BR>
1102 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unlocks the VLDB entry of the specified volume</TD>
1103 </TR>
1104 <TR BGCOLOR="white" CLASS="TableRowColor">
1105 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1106 <CODE>&nbsp;void</CODE></FONT></TD>
1107 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#unmount()">unmount</A></B>()</CODE>
1108
1109 <BR>
1110 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unmounts this volume, bringing it offline and making it inaccessible.</TD>
1111 </TR>
1112 <TR BGCOLOR="white" CLASS="TableRowColor">
1113 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1114 <CODE>protected static&nbsp;void</CODE></FONT></TD>
1115 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#unmount(int, int, int)">unmount</A></B>(int&nbsp;serverHandle,
1116         int&nbsp;partition,
1117         int&nbsp;volId)</CODE>
1118
1119 <BR>
1120 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"Unmounts" the specified volume, bringing it offline.</TD>
1121 </TR>
1122 </TABLE>
1123 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
1124 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1125 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
1126 <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A></B></TD>
1127 </TR>
1128 <TR BGCOLOR="white" CLASS="TableRowColor">
1129 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#clone()">clone</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#finalize()">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
1130 </TR>
1131 </TABLE>
1132 &nbsp;
1133 <P>
1134
1135 <!-- ============ FIELD DETAIL =========== -->
1136
1137 <A NAME="field_detail"><!-- --></A>
1138 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1139 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1140 <TD COLSPAN=1><FONT SIZE="+2">
1141 <B>Field Detail</B></FONT></TD>
1142 </TR>
1143 </TABLE>
1144
1145 <A NAME="VOLUME_TYPE_READ_WRITE"><!-- --></A><H3>
1146 VOLUME_TYPE_READ_WRITE</H3>
1147 <PRE>
1148 public static final int <B>VOLUME_TYPE_READ_WRITE</B></PRE>
1149 <DL>
1150 <DD>Read-write volume type
1151 <P>
1152 <DL>
1153 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_TYPE_READ_WRITE">Constant Field Values</A></DL>
1154 </DL>
1155 <HR>
1156
1157 <A NAME="VOLUME_TYPE_READ_ONLY"><!-- --></A><H3>
1158 VOLUME_TYPE_READ_ONLY</H3>
1159 <PRE>
1160 public static final int <B>VOLUME_TYPE_READ_ONLY</B></PRE>
1161 <DL>
1162 <DD>Read-only volume type
1163 <P>
1164 <DL>
1165 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_TYPE_READ_ONLY">Constant Field Values</A></DL>
1166 </DL>
1167 <HR>
1168
1169 <A NAME="VOLUME_TYPE_BACKUP"><!-- --></A><H3>
1170 VOLUME_TYPE_BACKUP</H3>
1171 <PRE>
1172 public static final int <B>VOLUME_TYPE_BACKUP</B></PRE>
1173 <DL>
1174 <DD>Backup volume type
1175 <P>
1176 <DL>
1177 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_TYPE_BACKUP">Constant Field Values</A></DL>
1178 </DL>
1179 <HR>
1180
1181 <A NAME="VOLUME_OK"><!-- --></A><H3>
1182 VOLUME_OK</H3>
1183 <PRE>
1184 public static final int <B>VOLUME_OK</B></PRE>
1185 <DL>
1186 <DD>Status/disposition ok
1187 <P>
1188 <DL>
1189 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_OK">Constant Field Values</A></DL>
1190 </DL>
1191 <HR>
1192
1193 <A NAME="VOLUME_SALVAGE"><!-- --></A><H3>
1194 VOLUME_SALVAGE</H3>
1195 <PRE>
1196 public static final int <B>VOLUME_SALVAGE</B></PRE>
1197 <DL>
1198 <DD>Status/disposition salvage
1199 <P>
1200 <DL>
1201 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_SALVAGE">Constant Field Values</A></DL>
1202 </DL>
1203 <HR>
1204
1205 <A NAME="VOLUME_NO_VNODE"><!-- --></A><H3>
1206 VOLUME_NO_VNODE</H3>
1207 <PRE>
1208 public static final int <B>VOLUME_NO_VNODE</B></PRE>
1209 <DL>
1210 <DD>Status/disposition no vnode
1211 <P>
1212 <DL>
1213 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_NO_VNODE">Constant Field Values</A></DL>
1214 </DL>
1215 <HR>
1216
1217 <A NAME="VOLUME_NO_VOL"><!-- --></A><H3>
1218 VOLUME_NO_VOL</H3>
1219 <PRE>
1220 public static final int <B>VOLUME_NO_VOL</B></PRE>
1221 <DL>
1222 <DD>Status/disposition no volume
1223 <P>
1224 <DL>
1225 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_NO_VOL">Constant Field Values</A></DL>
1226 </DL>
1227 <HR>
1228
1229 <A NAME="VOLUME_VOL_EXISTS"><!-- --></A><H3>
1230 VOLUME_VOL_EXISTS</H3>
1231 <PRE>
1232 public static final int <B>VOLUME_VOL_EXISTS</B></PRE>
1233 <DL>
1234 <DD>Status/disposition volume exists
1235 <P>
1236 <DL>
1237 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_VOL_EXISTS">Constant Field Values</A></DL>
1238 </DL>
1239 <HR>
1240
1241 <A NAME="VOLUME_NO_SERVICE"><!-- --></A><H3>
1242 VOLUME_NO_SERVICE</H3>
1243 <PRE>
1244 public static final int <B>VOLUME_NO_SERVICE</B></PRE>
1245 <DL>
1246 <DD>Status/disposition no service
1247 <P>
1248 <DL>
1249 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_NO_SERVICE">Constant Field Values</A></DL>
1250 </DL>
1251 <HR>
1252
1253 <A NAME="VOLUME_OFFLINE"><!-- --></A><H3>
1254 VOLUME_OFFLINE</H3>
1255 <PRE>
1256 public static final int <B>VOLUME_OFFLINE</B></PRE>
1257 <DL>
1258 <DD>Status/disposition offline
1259 <P>
1260 <DL>
1261 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_OFFLINE">Constant Field Values</A></DL>
1262 </DL>
1263 <HR>
1264
1265 <A NAME="VOLUME_ONLINE"><!-- --></A><H3>
1266 VOLUME_ONLINE</H3>
1267 <PRE>
1268 public static final int <B>VOLUME_ONLINE</B></PRE>
1269 <DL>
1270 <DD>Status/disposition online
1271 <P>
1272 <DL>
1273 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_ONLINE">Constant Field Values</A></DL>
1274 </DL>
1275 <HR>
1276
1277 <A NAME="VOLUME_DISK_FULL"><!-- --></A><H3>
1278 VOLUME_DISK_FULL</H3>
1279 <PRE>
1280 public static final int <B>VOLUME_DISK_FULL</B></PRE>
1281 <DL>
1282 <DD>Status/disposition disk full
1283 <P>
1284 <DL>
1285 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_DISK_FULL">Constant Field Values</A></DL>
1286 </DL>
1287 <HR>
1288
1289 <A NAME="VOLUME_OVER_QUOTA"><!-- --></A><H3>
1290 VOLUME_OVER_QUOTA</H3>
1291 <PRE>
1292 public static final int <B>VOLUME_OVER_QUOTA</B></PRE>
1293 <DL>
1294 <DD>Status/disposition over quota
1295 <P>
1296 <DL>
1297 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_OVER_QUOTA">Constant Field Values</A></DL>
1298 </DL>
1299 <HR>
1300
1301 <A NAME="VOLUME_BUSY"><!-- --></A><H3>
1302 VOLUME_BUSY</H3>
1303 <PRE>
1304 public static final int <B>VOLUME_BUSY</B></PRE>
1305 <DL>
1306 <DD>Status/disposition busy
1307 <P>
1308 <DL>
1309 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_BUSY">Constant Field Values</A></DL>
1310 </DL>
1311 <HR>
1312
1313 <A NAME="VOLUME_MOVED"><!-- --></A><H3>
1314 VOLUME_MOVED</H3>
1315 <PRE>
1316 public static final int <B>VOLUME_MOVED</B></PRE>
1317 <DL>
1318 <DD>Status/disposition moved
1319 <P>
1320 <DL>
1321 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_MOVED">Constant Field Values</A></DL>
1322 </DL>
1323 <HR>
1324
1325 <A NAME="cell"><!-- --></A><H3>
1326 cell</H3>
1327 <PRE>
1328 protected <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> <B>cell</B></PRE>
1329 <DL>
1330 <DL>
1331 </DL>
1332 </DL>
1333 <HR>
1334
1335 <A NAME="server"><!-- --></A><H3>
1336 server</H3>
1337 <PRE>
1338 protected <A HREF="../../../org/openafs/jafs/Server.html">Server</A> <B>server</B></PRE>
1339 <DL>
1340 <DL>
1341 </DL>
1342 </DL>
1343 <HR>
1344
1345 <A NAME="partition"><!-- --></A><H3>
1346 partition</H3>
1347 <PRE>
1348 protected <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> <B>partition</B></PRE>
1349 <DL>
1350 <DL>
1351 </DL>
1352 </DL>
1353 <HR>
1354
1355 <A NAME="name"><!-- --></A><H3>
1356 name</H3>
1357 <PRE>
1358 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>name</B></PRE>
1359 <DL>
1360 <DL>
1361 </DL>
1362 </DL>
1363 <HR>
1364
1365 <A NAME="id"><!-- --></A><H3>
1366 id</H3>
1367 <PRE>
1368 protected int <B>id</B></PRE>
1369 <DL>
1370 <DL>
1371 </DL>
1372 </DL>
1373 <HR>
1374
1375 <A NAME="readWriteID"><!-- --></A><H3>
1376 readWriteID</H3>
1377 <PRE>
1378 protected int <B>readWriteID</B></PRE>
1379 <DL>
1380 <DL>
1381 </DL>
1382 </DL>
1383 <HR>
1384
1385 <A NAME="readOnlyID"><!-- --></A><H3>
1386 readOnlyID</H3>
1387 <PRE>
1388 protected int <B>readOnlyID</B></PRE>
1389 <DL>
1390 <DL>
1391 </DL>
1392 </DL>
1393 <HR>
1394
1395 <A NAME="backupID"><!-- --></A><H3>
1396 backupID</H3>
1397 <PRE>
1398 protected int <B>backupID</B></PRE>
1399 <DL>
1400 <DL>
1401 </DL>
1402 </DL>
1403 <HR>
1404
1405 <A NAME="creationDate"><!-- --></A><H3>
1406 creationDate</H3>
1407 <PRE>
1408 protected long <B>creationDate</B></PRE>
1409 <DL>
1410 <DL>
1411 </DL>
1412 </DL>
1413 <HR>
1414
1415 <A NAME="lastAccessDate"><!-- --></A><H3>
1416 lastAccessDate</H3>
1417 <PRE>
1418 protected long <B>lastAccessDate</B></PRE>
1419 <DL>
1420 <DL>
1421 </DL>
1422 </DL>
1423 <HR>
1424
1425 <A NAME="lastUpdateDate"><!-- --></A><H3>
1426 lastUpdateDate</H3>
1427 <PRE>
1428 protected long <B>lastUpdateDate</B></PRE>
1429 <DL>
1430 <DL>
1431 </DL>
1432 </DL>
1433 <HR>
1434
1435 <A NAME="lastBackupDate"><!-- --></A><H3>
1436 lastBackupDate</H3>
1437 <PRE>
1438 protected long <B>lastBackupDate</B></PRE>
1439 <DL>
1440 <DL>
1441 </DL>
1442 </DL>
1443 <HR>
1444
1445 <A NAME="copyCreationDate"><!-- --></A><H3>
1446 copyCreationDate</H3>
1447 <PRE>
1448 protected long <B>copyCreationDate</B></PRE>
1449 <DL>
1450 <DL>
1451 </DL>
1452 </DL>
1453 <HR>
1454
1455 <A NAME="accessesSinceMidnight"><!-- --></A><H3>
1456 accessesSinceMidnight</H3>
1457 <PRE>
1458 protected int <B>accessesSinceMidnight</B></PRE>
1459 <DL>
1460 <DL>
1461 </DL>
1462 </DL>
1463 <HR>
1464
1465 <A NAME="fileCount"><!-- --></A><H3>
1466 fileCount</H3>
1467 <PRE>
1468 protected int <B>fileCount</B></PRE>
1469 <DL>
1470 <DL>
1471 </DL>
1472 </DL>
1473 <HR>
1474
1475 <A NAME="maxQuota"><!-- --></A><H3>
1476 maxQuota</H3>
1477 <PRE>
1478 protected int <B>maxQuota</B></PRE>
1479 <DL>
1480 <DL>
1481 </DL>
1482 </DL>
1483 <HR>
1484
1485 <A NAME="currentSize"><!-- --></A><H3>
1486 currentSize</H3>
1487 <PRE>
1488 protected int <B>currentSize</B></PRE>
1489 <DL>
1490 <DL>
1491 </DL>
1492 </DL>
1493 <HR>
1494
1495 <A NAME="status"><!-- --></A><H3>
1496 status</H3>
1497 <PRE>
1498 protected int <B>status</B></PRE>
1499 <DL>
1500 <DL>
1501 </DL>
1502 </DL>
1503 <HR>
1504
1505 <A NAME="disposition"><!-- --></A><H3>
1506 disposition</H3>
1507 <PRE>
1508 protected int <B>disposition</B></PRE>
1509 <DL>
1510 <DL>
1511 </DL>
1512 </DL>
1513 <HR>
1514
1515 <A NAME="type"><!-- --></A><H3>
1516 type</H3>
1517 <PRE>
1518 protected int <B>type</B></PRE>
1519 <DL>
1520 <DL>
1521 </DL>
1522 </DL>
1523 <HR>
1524
1525 <A NAME="creationDateCal"><!-- --></A><H3>
1526 creationDateCal</H3>
1527 <PRE>
1528 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>creationDateCal</B></PRE>
1529 <DL>
1530 <DL>
1531 </DL>
1532 </DL>
1533 <HR>
1534
1535 <A NAME="lastUpdateDateCal"><!-- --></A><H3>
1536 lastUpdateDateCal</H3>
1537 <PRE>
1538 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>lastUpdateDateCal</B></PRE>
1539 <DL>
1540 <DL>
1541 </DL>
1542 </DL>
1543 <HR>
1544
1545 <A NAME="copyCreationDateCal"><!-- --></A><H3>
1546 copyCreationDateCal</H3>
1547 <PRE>
1548 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>copyCreationDateCal</B></PRE>
1549 <DL>
1550 <DL>
1551 </DL>
1552 </DL>
1553 <HR>
1554
1555 <A NAME="cachedInfo"><!-- --></A><H3>
1556 cachedInfo</H3>
1557 <PRE>
1558 protected boolean <B>cachedInfo</B></PRE>
1559 <DL>
1560 <DL>
1561 </DL>
1562 </DL>
1563
1564 <!-- ========= CONSTRUCTOR DETAIL ======== -->
1565
1566 <A NAME="constructor_detail"><!-- --></A>
1567 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1568 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1569 <TD COLSPAN=1><FONT SIZE="+2">
1570 <B>Constructor Detail</B></FONT></TD>
1571 </TR>
1572 </TABLE>
1573
1574 <A NAME="Volume(java.lang.String, org.openafs.jafs.Partition)"><!-- --></A><H3>
1575 Volume</H3>
1576 <PRE>
1577 public <B>Volume</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
1578               <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;partition)
1579        throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1580 <DL>
1581 <DD>Constructs a new <CODE>Volume</CODE> object instance given the name of 
1582  the AFS volume and the AFS cell, represented by <CODE>partition</CODE>, 
1583  to which it belongs.   This does not actually
1584  create a new AFS volume, it just represents one.
1585  If <code>name</code> is not an actual AFS volume, exceptions
1586  will be thrown during subsequent method invocations on this 
1587  object, unless the <A HREF="../../../org/openafs/jafs/Volume.html#create(int)"><CODE>create(int)</CODE></A> method is explicitly called
1588  to create it.
1589 <P>
1590 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the volume to represent<DD><CODE>partition</CODE> - the partition on which the volume resides
1591 <DT><B>Throws:</B>
1592 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1593 <HR>
1594
1595 <A NAME="Volume(java.lang.String, org.openafs.jafs.Partition, boolean)"><!-- --></A><H3>
1596 Volume</H3>
1597 <PRE>
1598 public <B>Volume</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
1599               <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;partition,
1600               boolean&nbsp;preloadAllMembers)
1601        throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1602 <DL>
1603 <DD>Constructs a new <CODE>Volume</CODE> object instance given the name of 
1604  the AFS volume and the AFS partition, represented by 
1605  <CODE>partition</CODE>, to which it belongs.    This does not actually
1606  create a new AFS volume, it just represents one.
1607  If <code>name</code> is not an actual AFS volume, exceptions
1608  will be thrown during subsequent method invocations on this 
1609  object, unless the <A HREF="../../../org/openafs/jafs/Volume.html#create(int)"><CODE>create(int)</CODE></A> method is explicitly called
1610  to create it.  Note that if the volume doesn't exist and 
1611  <code>preloadAllMembers</code> is true, an exception will be thrown.
1612
1613  <P> This constructor is ideal for point-in-time representation and 
1614  transient applications. It ensures all data member values are set 
1615  and available without calling back to the filesystem at the first request
1616  for them.  Use the <A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A> method to address any coherency 
1617  concerns.
1618 <P>
1619 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the volume to represent<DD><CODE>partition</CODE> - the partition on which the volume resides.<DD><CODE>preloadAllMembers</CODE> - true will ensure all object members are set 
1620                            upon construction; otherwise members will be 
1621                            set upon access, which is the default behavior.
1622 <DT><B>Throws:</B>
1623 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A></DL>
1624 <HR>
1625
1626 <A NAME="Volume(org.openafs.jafs.Partition)"><!-- --></A><H3>
1627 Volume</H3>
1628 <PRE>
1629 <B>Volume</B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;partition)
1630  throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1631 <DL>
1632 <DD>Creates a blank <code>Volume</code> given the cell to which the volume
1633  belongs, the server on which the partition resides, and 
1634  the partition on which the volume resides. This blank 
1635  object can then be passed into other methods to fill out its properties.
1636 <P>
1637 <DT><B>Parameters:</B><DD><CODE>partition</CODE> - the partition on which the volume resides
1638 <DT><B>Throws:</B>
1639 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1640
1641 <!-- ============ METHOD DETAIL ========== -->
1642
1643 <A NAME="method_detail"><!-- --></A>
1644 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1645 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1646 <TD COLSPAN=1><FONT SIZE="+2">
1647 <B>Method Detail</B></FONT></TD>
1648 </TR>
1649 </TABLE>
1650
1651 <A NAME="refresh()"><!-- --></A><H3>
1652 refresh</H3>
1653 <PRE>
1654 public void <B>refresh</B>()
1655              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1656 <DL>
1657 <DD>Refreshes the properties of this Volume object instance with values from 
1658  the AFS volume it represents.  All properties that have been initialized 
1659  and/or accessed will be renewed according to the values of the AFS volume
1660  this Volume object instance represents.
1661
1662  <P>Since in most environments administrative changes can be administered
1663  from an AFS command-line program or an alternate GUI application, this
1664  method provides a means to refresh the Java object representation and
1665  thereby ascertain any possible modifications that may have been made
1666  from such alternate administrative programs.  Using this method before
1667  an associated instance accessor will ensure the highest level of 
1668  representative accuracy, accommodating changes made external to the
1669  Java application space.  If administrative changes to the underlying AFS 
1670  system are only allowed via this API, then the use of this method is 
1671  unnecessary.
1672 <P>
1673 <DD><DL>
1674 </DL>
1675 </DD>
1676 <DD><DL>
1677
1678 <DT><B>Throws:</B>
1679 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1680 </DD>
1681 </DL>
1682 <HR>
1683
1684 <A NAME="refresh(boolean)"><!-- --></A><H3>
1685 refresh</H3>
1686 <PRE>
1687 protected void <B>refresh</B>(boolean&nbsp;all)
1688                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1689 <DL>
1690 <DD>Refreshes the properties of this Volume object instance with values from 
1691  the AFS volume it represents.  If <CODE>all</CODE> is <CODE>true</CODE> 
1692  then <U>all</U> of the properties of this Volume object instance will be 
1693  set, or renewed, according to the values of the AFS volume it represents,
1694  disregarding any previously set properties.
1695
1696  <P> Thus, if <CODE>all</CODE> is <CODE>false</CODE> then properties that 
1697  are currently set will be refreshed and properties that are not set will 
1698  remain uninitialized. See <A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A> for more information.
1699 <P>
1700 <DD><DL>
1701 </DL>
1702 </DD>
1703 <DD><DL>
1704 <DT><B>Parameters:</B><DD><CODE>all</CODE> - if true set or renew all object properties; otherwise renew 
1705               all set properties
1706 <DT><B>Throws:</B>
1707 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A></DL>
1708 </DD>
1709 </DL>
1710 <HR>
1711
1712 <A NAME="refreshInfo()"><!-- --></A><H3>
1713 refreshInfo</H3>
1714 <PRE>
1715 protected void <B>refreshInfo</B>()
1716                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1717 <DL>
1718 <DD>Refreshes the information fields of this <code>Volume</code> to reflect 
1719  the current state of the AFS volume. These include the last update time,
1720  file count, etc.
1721 <P>
1722 <DD><DL>
1723 </DL>
1724 </DD>
1725 <DD><DL>
1726
1727 <DT><B>Throws:</B>
1728 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1729 </DD>
1730 </DL>
1731 <HR>
1732
1733 <A NAME="create(int)"><!-- --></A><H3>
1734 create</H3>
1735 <PRE>
1736 public void <B>create</B>(int&nbsp;quota)
1737             throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1738 <DL>
1739 <DD>Creates a new volume on the server and partition given upon construction.
1740 <P>
1741 <DD><DL>
1742 </DL>
1743 </DD>
1744 <DD><DL>
1745 <DT><B>Parameters:</B><DD><CODE>quota</CODE> - the quota for the volume in K, 0 indicates an unlimited 
1746                  quota
1747 <DT><B>Throws:</B>
1748 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1749 </DD>
1750 </DL>
1751 <HR>
1752
1753 <A NAME="createBackup()"><!-- --></A><H3>
1754 createBackup</H3>
1755 <PRE>
1756 public <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A> <B>createBackup</B>()
1757                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1758 <DL>
1759 <DD>Creates a backup volume for this volume.
1760 <P>
1761 <DD><DL>
1762 </DL>
1763 </DD>
1764 <DD><DL>
1765
1766 <DT><B>Returns:</B><DD>the <code>Volume</code> object representation for the
1767           backup volume that was created
1768 <DT><B>Throws:</B>
1769 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1770 </DD>
1771 </DL>
1772 <HR>
1773
1774 <A NAME="createReadOnly(org.openafs.jafs.Partition)"><!-- --></A><H3>
1775 createReadOnly</H3>
1776 <PRE>
1777 public <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A> <B>createReadOnly</B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;sitePartition)
1778                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1779 <DL>
1780 <DD>Creates a readonly site for this volume on the specified server and 
1781  partition.  Automatically releases the volume.
1782 <P>
1783 <DD><DL>
1784 </DL>
1785 </DD>
1786 <DD><DL>
1787 <DT><B>Parameters:</B><DD><CODE>sitePartition</CODE> - the partition on which the readonly volume is 
1788                         to reside
1789 <DT><B>Returns:</B><DD>the <code>Volume</code> representation for the
1790          read-only volume that was created
1791 <DT><B>Throws:</B>
1792 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1793 </DD>
1794 </DL>
1795 <HR>
1796
1797 <A NAME="delete()"><!-- --></A><H3>
1798 delete</H3>
1799 <PRE>
1800 public void <B>delete</B>()
1801             throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1802 <DL>
1803 <DD>Deletes the volume from the cell.
1804 <P>
1805 <DD><DL>
1806 </DL>
1807 </DD>
1808 <DD><DL>
1809
1810 <DT><B>Throws:</B>
1811 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1812 </DD>
1813 </DL>
1814 <HR>
1815
1816 <A NAME="release()"><!-- --></A><H3>
1817 release</H3>
1818 <PRE>
1819 public void <B>release</B>()
1820              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1821 <DL>
1822 <DD>Releases this volume, which updates the read-only copies of it.
1823
1824  <P> This method will force a complete release; a complete release updates
1825  all read-only sites even if the VLDB entry has a flag.
1826 <P>
1827 <DD><DL>
1828 </DL>
1829 </DD>
1830 <DD><DL>
1831
1832 <DT><B>Throws:</B>
1833 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1834 </DD>
1835 </DL>
1836 <HR>
1837
1838 <A NAME="release(boolean)"><!-- --></A><H3>
1839 release</H3>
1840 <PRE>
1841 public void <B>release</B>(boolean&nbsp;forceComplete)
1842              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1843 <DL>
1844 <DD>Releases this volume, which updates the read-only copies of it.
1845 <P>
1846 <DD><DL>
1847 </DL>
1848 </DD>
1849 <DD><DL>
1850 <DT><B>Parameters:</B><DD><CODE>forceComplete</CODE> - whether or not to force a complete release; 
1851                         a complete release updates all read-only sites 
1852                         even if the VLDB entry has a flag
1853 <DT><B>Throws:</B>
1854 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1855 </DD>
1856 </DL>
1857 <HR>
1858
1859 <A NAME="dump(java.lang.String, java.util.GregorianCalendar)"><!-- --></A><H3>
1860 dump</H3>
1861 <PRE>
1862 public void <B>dump</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;fileName,
1863                  <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A>&nbsp;dumpSince)
1864           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1865 <DL>
1866 <DD>Dumps this volume to a file. If you use the dumpSince argument you will 
1867  create an incremental dump, but you can leave it <code>null</code> 
1868  for a full dump.
1869 <P>
1870 <DD><DL>
1871 </DL>
1872 </DD>
1873 <DD><DL>
1874 <DT><B>Parameters:</B><DD><CODE>fileName</CODE> - the path name of the file on the client machine to 
1875                     which to dump this volume<DD><CODE>dumpSince</CODE> - dump only files that have been modified more recently 
1876                     than this date
1877 <DT><B>Throws:</B>
1878 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1879 </DD>
1880 </DL>
1881 <HR>
1882
1883 <A NAME="dump(java.lang.String)"><!-- --></A><H3>
1884 dump</H3>
1885 <PRE>
1886 public void <B>dump</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;fileName)
1887           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1888 <DL>
1889 <DD>Dumps this volume to a file. Creates a full dump.
1890 <P>
1891 <DD><DL>
1892 </DL>
1893 </DD>
1894 <DD><DL>
1895 <DT><B>Parameters:</B><DD><CODE>fileName</CODE> - the path name of the file to which to dump this volume
1896 <DT><B>Throws:</B>
1897 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1898 </DD>
1899 </DL>
1900 <HR>
1901
1902 <A NAME="restore(java.lang.String, boolean)"><!-- --></A><H3>
1903 restore</H3>
1904 <PRE>
1905 public void <B>restore</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;fileName,
1906                     boolean&nbsp;incremental)
1907              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1908 <DL>
1909 <DD>Restores a file to this volume.  Note that this does not have to be an 
1910  existing volume in order to be restored - you may create a 
1911  <code>Volume</code> as a volume that doesn't yet exist and then restore 
1912  a file to it.  Or you can restore over an existing volume.  If a new 
1913  volume is being created with this method, the id will be automatically 
1914  assigned.
1915 <P>
1916 <DD><DL>
1917 </DL>
1918 </DD>
1919 <DD><DL>
1920 <DT><B>Parameters:</B><DD><CODE>fileName</CODE> - the path name of the file on the client machine from 
1921  which to restore this volume<DD><CODE>incremental</CODE> - if true, restores an incremental dump over an 
1922                       existing volume
1923 <DT><B>Throws:</B>
1924 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1925 </DD>
1926 </DL>
1927 <HR>
1928
1929 <A NAME="restore(java.lang.String, boolean, int)"><!-- --></A><H3>
1930 restore</H3>
1931 <PRE>
1932 public void <B>restore</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;fileName,
1933                     boolean&nbsp;incremental,
1934                     int&nbsp;id)
1935              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1936 <DL>
1937 <DD>Restores a file to this volume.  Note that this does not have to be an 
1938  existing volume in order to be restored - you may create a 
1939  <code>Volume</code> as a volume that doesn't yet exist and then restore 
1940  a file to it.  Or you can restore over an existing volume.
1941 <P>
1942 <DD><DL>
1943 </DL>
1944 </DD>
1945 <DD><DL>
1946 <DT><B>Parameters:</B><DD><CODE>fileName</CODE> - the path name of the file on the client machine from 
1947  which to restore this volume<DD><CODE>incremental</CODE> - if true, restores an incremental dump over an 
1948                       existing volume<DD><CODE>id</CODE> - the id to assign this volume
1949 <DT><B>Throws:</B>
1950 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1951 </DD>
1952 </DL>
1953 <HR>
1954
1955 <A NAME="mount()"><!-- --></A><H3>
1956 mount</H3>
1957 <PRE>
1958 public void <B>mount</B>()
1959            throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1960 <DL>
1961 <DD>Mounts this volume, bringing it online and making it accessible.
1962 <P>
1963 <DD><DL>
1964 </DL>
1965 </DD>
1966 <DD><DL>
1967
1968 <DT><B>Throws:</B>
1969 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1970 </DD>
1971 </DL>
1972 <HR>
1973
1974 <A NAME="unmount()"><!-- --></A><H3>
1975 unmount</H3>
1976 <PRE>
1977 public void <B>unmount</B>()
1978              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1979 <DL>
1980 <DD>Unmounts this volume, bringing it offline and making it inaccessible.
1981 <P>
1982 <DD><DL>
1983 </DL>
1984 </DD>
1985 <DD><DL>
1986
1987 <DT><B>Throws:</B>
1988 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1989 </DD>
1990 </DL>
1991 <HR>
1992
1993 <A NAME="lock()"><!-- --></A><H3>
1994 lock</H3>
1995 <PRE>
1996 public void <B>lock</B>()
1997           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1998 <DL>
1999 <DD>Locks the VLDB enrty for this volume
2000 <P>
2001 <DD><DL>
2002 </DL>
2003 </DD>
2004 <DD><DL>
2005
2006 <DT><B>Throws:</B>
2007 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2008 </DD>
2009 </DL>
2010 <HR>
2011
2012 <A NAME="unlock()"><!-- --></A><H3>
2013 unlock</H3>
2014 <PRE>
2015 public void <B>unlock</B>()
2016             throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2017 <DL>
2018 <DD>Unlocks the VLDB entry for this volume
2019 <P>
2020 <DD><DL>
2021 </DL>
2022 </DD>
2023 <DD><DL>
2024
2025 <DT><B>Throws:</B>
2026 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2027 </DD>
2028 </DL>
2029 <HR>
2030
2031 <A NAME="moveTo(org.openafs.jafs.Partition)"><!-- --></A><H3>
2032 moveTo</H3>
2033 <PRE>
2034 public void <B>moveTo</B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;newPartition)
2035             throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2036 <DL>
2037 <DD>Moves this volume to the specified partition (which indirectly 
2038  specifies a new server, as well).  Caution: This will remove any backup 
2039  volumes at the original site.
2040 <P>
2041 <DD><DL>
2042 </DL>
2043 </DD>
2044 <DD><DL>
2045 <DT><B>Parameters:</B><DD><CODE>newPartition</CODE> - the partition to which to move the volume
2046 <DT><B>Throws:</B>
2047 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2048 </DD>
2049 </DL>
2050 <HR>
2051
2052 <A NAME="rename(java.lang.String)"><!-- --></A><H3>
2053 rename</H3>
2054 <PRE>
2055 public void <B>rename</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;newName)
2056             throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2057 <DL>
2058 <DD>Renames this volume.
2059 <P>
2060 <DD><DL>
2061 </DL>
2062 </DD>
2063 <DD><DL>
2064 <DT><B>Parameters:</B><DD><CODE>newName</CODE> - the new name for this volume
2065 <DT><B>Throws:</B>
2066 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2067 </DD>
2068 </DL>
2069 <HR>
2070
2071 <A NAME="salvage()"><!-- --></A><H3>
2072 salvage</H3>
2073 <PRE>
2074 public void <B>salvage</B>()
2075              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2076 <DL>
2077 <DD>Salvages (restores consistency to) this volume.  Uses default values for
2078  most salvager options in order to simplify the API.
2079 <P>
2080 <DD><DL>
2081 </DL>
2082 </DD>
2083 <DD><DL>
2084
2085 <DT><B>Throws:</B>
2086 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2087 </DD>
2088 </DL>
2089 <HR>
2090
2091 <A NAME="createMountPoint(java.lang.String)"><!-- --></A><H3>
2092 createMountPoint</H3>
2093 <PRE>
2094 public void <B>createMountPoint</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;directory)
2095                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2096 <DL>
2097 <DD>Creates a read-write mount point for this volume.  Does not ensure the 
2098  volume already exists.
2099 <P>
2100 <DD><DL>
2101 </DL>
2102 </DD>
2103 <DD><DL>
2104 <DT><B>Parameters:</B><DD><CODE>directory</CODE> - the name of the directory where this volume 
2105  should be mounted
2106 <DT><B>Throws:</B>
2107 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2108 </DD>
2109 </DL>
2110 <HR>
2111
2112 <A NAME="createMountPoint(java.lang.String, boolean)"><!-- --></A><H3>
2113 createMountPoint</H3>
2114 <PRE>
2115 public void <B>createMountPoint</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;directory,
2116                              boolean&nbsp;readWrite)
2117                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2118 <DL>
2119 <DD>Creates a mount point for this volume.  Does not ensure the volume 
2120  already exists.
2121 <P>
2122 <DD><DL>
2123 </DL>
2124 </DD>
2125 <DD><DL>
2126 <DT><B>Parameters:</B><DD><CODE>directory</CODE> - the name of the directory where this volume should be 
2127                     mounted<DD><CODE>readWrite</CODE> - whether or not this mount point should be read-write
2128 <DT><B>Throws:</B>
2129 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2130 </DD>
2131 </DL>
2132 <HR>
2133
2134 <A NAME="getName()"><!-- --></A><H3>
2135 getName</H3>
2136 <PRE>
2137 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>
2138 <DL>
2139 <DD>Returns the name of this volume.
2140 <P>
2141 <DD><DL>
2142 </DL>
2143 </DD>
2144 <DD><DL>
2145
2146 <DT><B>Returns:</B><DD>the name of this volume</DL>
2147 </DD>
2148 </DL>
2149 <HR>
2150
2151 <A NAME="getPartition()"><!-- --></A><H3>
2152 getPartition</H3>
2153 <PRE>
2154 public <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> <B>getPartition</B>()</PRE>
2155 <DL>
2156 <DD>Returns this volume's hosting partition.
2157 <P>
2158 <DD><DL>
2159 </DL>
2160 </DD>
2161 <DD><DL>
2162
2163 <DT><B>Returns:</B><DD>this volume's partition</DL>
2164 </DD>
2165 </DL>
2166 <HR>
2167
2168 <A NAME="getID()"><!-- --></A><H3>
2169 getID</H3>
2170 <PRE>
2171 public int <B>getID</B>()
2172           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2173 <DL>
2174 <DD>Returns the id of this volume.
2175 <P>
2176 <DD><DL>
2177 </DL>
2178 </DD>
2179 <DD><DL>
2180
2181 <DT><B>Returns:</B><DD>the id of this volume
2182 <DT><B>Throws:</B>
2183 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2184 </DD>
2185 </DL>
2186 <HR>
2187
2188 <A NAME="getReadWriteID()"><!-- --></A><H3>
2189 getReadWriteID</H3>
2190 <PRE>
2191 public int <B>getReadWriteID</B>()
2192                    throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2193 <DL>
2194 <DD>Returns the read-write ID of this volume
2195 <P>
2196 <DD><DL>
2197 </DL>
2198 </DD>
2199 <DD><DL>
2200
2201 <DT><B>Returns:</B><DD>the read-write id
2202 <DT><B>Throws:</B>
2203 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2204 </DD>
2205 </DL>
2206 <HR>
2207
2208 <A NAME="getReadOnlyID()"><!-- --></A><H3>
2209 getReadOnlyID</H3>
2210 <PRE>
2211 public int <B>getReadOnlyID</B>()
2212                   throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2213 <DL>
2214 <DD>Returns the read-only ID of this volume
2215 <P>
2216 <DD><DL>
2217 </DL>
2218 </DD>
2219 <DD><DL>
2220
2221 <DT><B>Returns:</B><DD>the read-only id
2222 <DT><B>Throws:</B>
2223 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2224 </DD>
2225 </DL>
2226 <HR>
2227
2228 <A NAME="getBackupID()"><!-- --></A><H3>
2229 getBackupID</H3>
2230 <PRE>
2231 public int <B>getBackupID</B>()
2232                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2233 <DL>
2234 <DD>Returns the backup ID of this volume
2235 <P>
2236 <DD><DL>
2237 </DL>
2238 </DD>
2239 <DD><DL>
2240
2241 <DT><B>Returns:</B><DD>the backup id
2242 <DT><B>Throws:</B>
2243 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2244 </DD>
2245 </DL>
2246 <HR>
2247
2248 <A NAME="getCreationDate()"><!-- --></A><H3>
2249 getCreationDate</H3>
2250 <PRE>
2251 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>getCreationDate</B>()
2252                                   throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2253 <DL>
2254 <DD>Returns the date the volume was created
2255 <P>
2256 <DD><DL>
2257 </DL>
2258 </DD>
2259 <DD><DL>
2260
2261 <DT><B>Returns:</B><DD>the date the volume was created
2262 <DT><B>Throws:</B>
2263 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2264 </DD>
2265 </DL>
2266 <HR>
2267
2268 <A NAME="getLastUpdateDate()"><!-- --></A><H3>
2269 getLastUpdateDate</H3>
2270 <PRE>
2271 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>getLastUpdateDate</B>()
2272                                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2273 <DL>
2274 <DD>Returns the date the volume was last updated.
2275  After this method is called once, it saves the date 
2276  and returns that date on subsequent calls, 
2277  until the <A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current 
2278  value is obtained.
2279 <P>
2280 <DD><DL>
2281 </DL>
2282 </DD>
2283 <DD><DL>
2284
2285 <DT><B>Returns:</B><DD>the date the volume was last updated
2286 <DT><B>Throws:</B>
2287 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2288 </DD>
2289 </DL>
2290 <HR>
2291
2292 <A NAME="getCopyCreationDate()"><!-- --></A><H3>
2293 getCopyCreationDate</H3>
2294 <PRE>
2295 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>getCopyCreationDate</B>()
2296                                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2297 <DL>
2298 <DD>Returns the date the volume was copied.
2299  After this method is called once, it saves the date 
2300  and returns that date on subsequent calls, 
2301  until the <A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current 
2302  value is obtained.
2303 <P>
2304 <DD><DL>
2305 </DL>
2306 </DD>
2307 <DD><DL>
2308
2309 <DT><B>Returns:</B><DD>the date the volume was copied
2310 <DT><B>Throws:</B>
2311 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2312 </DD>
2313 </DL>
2314 <HR>
2315
2316 <A NAME="getAccessesSinceMidnight()"><!-- --></A><H3>
2317 getAccessesSinceMidnight</H3>
2318 <PRE>
2319 public int <B>getAccessesSinceMidnight</B>()
2320                              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2321 <DL>
2322 <DD>Returns the number of accesses since midnight.
2323  After this method is called once, it saves the value 
2324  and returns that value on subsequent calls, 
2325  until the <A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current 
2326  value is obtained.
2327 <P>
2328 <DD><DL>
2329 </DL>
2330 </DD>
2331 <DD><DL>
2332
2333 <DT><B>Returns:</B><DD>the number of accesses since midnight
2334 <DT><B>Throws:</B>
2335 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2336 </DD>
2337 </DL>
2338 <HR>
2339
2340 <A NAME="getFileCount()"><!-- --></A><H3>
2341 getFileCount</H3>
2342 <PRE>
2343 public int <B>getFileCount</B>()
2344                  throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2345 <DL>
2346 <DD>Returns file count.
2347  After this method is called once, it saves the value 
2348  and returns that value on subsequent calls, 
2349  until the <A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current 
2350  value is obtained.
2351 <P>
2352 <DD><DL>
2353 </DL>
2354 </DD>
2355 <DD><DL>
2356
2357 <DT><B>Returns:</B><DD>the file count
2358 <DT><B>Throws:</B>
2359 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2360 </DD>
2361 </DL>
2362 <HR>
2363
2364 <A NAME="getCurrentSize()"><!-- --></A><H3>
2365 getCurrentSize</H3>
2366 <PRE>
2367 public int <B>getCurrentSize</B>()
2368                    throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2369 <DL>
2370 <DD>Returns current volume size in K.
2371  After this method is called once, it saves the value 
2372  and returns that value on subsequent calls, 
2373  until the <A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current 
2374  value is obtained.
2375 <P>
2376 <DD><DL>
2377 </DL>
2378 </DD>
2379 <DD><DL>
2380
2381 <DT><B>Returns:</B><DD>the current volume size in K
2382 <DT><B>Throws:</B>
2383 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2384 </DD>
2385 </DL>
2386 <HR>
2387
2388 <A NAME="getTotalFreeSpace()"><!-- --></A><H3>
2389 getTotalFreeSpace</H3>
2390 <PRE>
2391 public int <B>getTotalFreeSpace</B>()
2392                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2393 <DL>
2394 <DD>Returns the difference between quota and current volume size (in K).
2395
2396  <P> Please note: the product of this method is <U>not</U> saved.
2397 <P>
2398 <DD><DL>
2399 </DL>
2400 </DD>
2401 <DD><DL>
2402
2403 <DT><B>Returns:</B><DD>the current free space in K
2404 <DT><B>Throws:</B>
2405 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2406 </DD>
2407 </DL>
2408 <HR>
2409
2410 <A NAME="getQuota()"><!-- --></A><H3>
2411 getQuota</H3>
2412 <PRE>
2413 public int <B>getQuota</B>()
2414              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2415 <DL>
2416 <DD>Returns this volume's quota, expressed in kilobyte blocks (1024 
2417  kilobyte blocks equal one megabyte). After this method is called once, 
2418  it saves the value and returns that value on subsequent calls, 
2419  until the <A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current 
2420  value is obtained.
2421
2422  <P><B>Note:</B> A quota value of zero, "0", grants an unlimited quota
2423  in AFS.  Consequently, to avoid delusion this method will throw an 
2424  <A HREF="../../../org/openafs/jafs/AFSException.html"><CODE>AFSException</CODE></A> if the returning value is zero.
2425 <P>
2426 <DD><DL>
2427 </DL>
2428 </DD>
2429 <DD><DL>
2430
2431 <DT><B>Returns:</B><DD>the volume quota in K
2432 <DT><B>Throws:</B>
2433 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code or
2434                                this volume's quota is configured as
2435                                unlimited.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Volume.html#isQuotaUnlimited()"><CODE>isQuotaUnlimited()</CODE></A></DL>
2436 </DD>
2437 </DL>
2438 <HR>
2439
2440 <A NAME="isQuotaUnlimited()"><!-- --></A><H3>
2441 isQuotaUnlimited</H3>
2442 <PRE>
2443 public boolean <B>isQuotaUnlimited</B>()
2444                          throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2445 <DL>
2446 <DD>Tests whether this volume's quota is configured as unlimited.
2447
2448  <P>After this method is called once, it saves the value and returns 
2449  that value on subsequent calls, until the <A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A> 
2450  method is called and a more current value is obtained.
2451 <P>
2452 <DD><DL>
2453 </DL>
2454 </DD>
2455 <DD><DL>
2456
2457 <DT><B>Returns:</B><DD><CODE>true</CODE> if this volume's quota is configured as
2458          unlimited; otherwise <CODE>false</CODE>.
2459 <DT><B>Throws:</B>
2460 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Volume.html#getQuota()"><CODE>getQuota()</CODE></A></DL>
2461 </DD>
2462 </DL>
2463 <HR>
2464
2465 <A NAME="getStatus()"><!-- --></A><H3>
2466 getStatus</H3>
2467 <PRE>
2468 public int <B>getStatus</B>()
2469               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2470 <DL>
2471 <DD>Returns volume status. Possible values are:<ul>
2472        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_OK"><CODE>VOLUME_OK</CODE></A></li>
2473        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_SALVAGE"><CODE>VOLUME_SALVAGE</CODE></A></li>
2474        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_NO_VNODE"><CODE>VOLUME_NO_VNODE</CODE></A></li>
2475        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_NO_VOL"><CODE>VOLUME_NO_VOL</CODE></A></li>
2476        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_VOL_EXISTS"><CODE>VOLUME_VOL_EXISTS</CODE></A></li>
2477        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_NO_SERVICE"><CODE>VOLUME_NO_SERVICE</CODE></A></li>
2478        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_OFFLINE"><CODE>VOLUME_OFFLINE</CODE></A></li>
2479        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_ONLINE"><CODE>VOLUME_ONLINE</CODE></A></li>
2480        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_DISK_FULL"><CODE>VOLUME_DISK_FULL</CODE></A></li>
2481        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_OVER_QUOTA"><CODE>VOLUME_OVER_QUOTA</CODE></A></li>
2482        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_BUSY"><CODE>VOLUME_BUSY</CODE></A></li>
2483        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_MOVED"><CODE>VOLUME_MOVED</CODE></A></li></ul>
2484  Typical value is VOLUME_OK.
2485  After this method is called once, it saves the value 
2486  and returns that value on subsequent calls, 
2487  until the <A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current 
2488  value is obtained.
2489 <P>
2490 <DD><DL>
2491 </DL>
2492 </DD>
2493 <DD><DL>
2494
2495 <DT><B>Returns:</B><DD>volume status
2496 <DT><B>Throws:</B>
2497 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2498 </DD>
2499 </DL>
2500 <HR>
2501
2502 <A NAME="getDisposition()"><!-- --></A><H3>
2503 getDisposition</H3>
2504 <PRE>
2505 public int <B>getDisposition</B>()
2506                    throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2507 <DL>
2508 <DD>Returns volume disposition. Possible values are:<ul>
2509        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_OK"><CODE>VOLUME_OK</CODE></A></li>
2510        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_SALVAGE"><CODE>VOLUME_SALVAGE</CODE></A></li>
2511        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_NO_VNODE"><CODE>VOLUME_NO_VNODE</CODE></A></li>
2512        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_NO_VOL"><CODE>VOLUME_NO_VOL</CODE></A></li>
2513        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_VOL_EXISTS"><CODE>VOLUME_VOL_EXISTS</CODE></A></li>
2514        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_NO_SERVICE"><CODE>VOLUME_NO_SERVICE</CODE></A></li>
2515        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_OFFLINE"><CODE>VOLUME_OFFLINE</CODE></A></li>
2516        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_ONLINE"><CODE>VOLUME_ONLINE</CODE></A></li>
2517        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_DISK_FULL"><CODE>VOLUME_DISK_FULL</CODE></A></li>
2518        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_OVER_QUOTA"><CODE>VOLUME_OVER_QUOTA</CODE></A></li>
2519        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_BUSY"><CODE>VOLUME_BUSY</CODE></A></li>
2520        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_MOVED"><CODE>VOLUME_MOVED</CODE></A></li></ul>
2521  Typical value is VOLUME_ONLINE.
2522  After this method is called once, it saves the value 
2523  and returns that value on subsequent calls, 
2524  until the <A HREF="../../../org/openafs/jafs/Volume.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current 
2525  value is obtained.
2526 <P>
2527 <DD><DL>
2528 </DL>
2529 </DD>
2530 <DD><DL>
2531
2532 <DT><B>Returns:</B><DD>volume disposition
2533 <DT><B>Throws:</B>
2534 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2535 </DD>
2536 </DL>
2537 <HR>
2538
2539 <A NAME="getType()"><!-- --></A><H3>
2540 getType</H3>
2541 <PRE>
2542 public int <B>getType</B>()
2543             throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2544 <DL>
2545 <DD>Returns volume type. Possible values are:<ul>
2546        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_TYPE_READ_WRITE"><CODE>VOLUME_TYPE_READ_WRITE</CODE></A></li>
2547        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_TYPE_READ_ONLY"><CODE>VOLUME_TYPE_READ_ONLY</CODE></A></li>
2548        <li><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_TYPE_BACKUP"><CODE>VOLUME_TYPE_BACKUP</CODE></A></li></ul>
2549 <P>
2550 <DD><DL>
2551 </DL>
2552 </DD>
2553 <DD><DL>
2554
2555 <DT><B>Returns:</B><DD>volume type
2556 <DT><B>Throws:</B>
2557 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2558 </DD>
2559 </DL>
2560 <HR>
2561
2562 <A NAME="setQuota(int)"><!-- --></A><H3>
2563 setQuota</H3>
2564 <PRE>
2565 public void <B>setQuota</B>(int&nbsp;quota)
2566               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2567 <DL>
2568 <DD>Sets quota of volume, 0 denotes an unlimited quota.
2569 <P>
2570 <DD><DL>
2571 </DL>
2572 </DD>
2573 <DD><DL>
2574 <DT><B>Parameters:</B><DD><CODE>quota</CODE> - the new volume quota in K (0 for unlimited)
2575 <DT><B>Throws:</B>
2576 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2577 </DD>
2578 </DL>
2579 <HR>
2580
2581 <A NAME="getInfo()"><!-- --></A><H3>
2582 getInfo</H3>
2583 <PRE>
2584 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getInfo</B>()</PRE>
2585 <DL>
2586 <DD>Returns a <code>String</code> representation of this <code>Volume</code>.
2587  Contains the information fields.
2588 <P>
2589 <DD><DL>
2590 </DL>
2591 </DD>
2592 <DD><DL>
2593
2594 <DT><B>Returns:</B><DD>a <code>String</code> representation of the <code>Volume</code></DL>
2595 </DD>
2596 </DL>
2597 <HR>
2598
2599 <A NAME="compareTo(org.openafs.jafs.Volume)"><!-- --></A><H3>
2600 compareTo</H3>
2601 <PRE>
2602 public int <B>compareTo</B>(<A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>&nbsp;volume)</PRE>
2603 <DL>
2604 <DD>Compares two Volume objects respective to their names and does not
2605  factor any other attribute.    Alphabetic case is significant in 
2606  comparing names.
2607 <P>
2608 <DD><DL>
2609 </DL>
2610 </DD>
2611 <DD><DL>
2612 <DT><B>Parameters:</B><DD><CODE>volume</CODE> - The Volume object to be compared to this Volume 
2613                       instance
2614 <DT><B>Returns:</B><DD>Zero if the argument is equal to this Volume's name, a
2615                 value less than zero if this Volume's name is
2616                 lexicographically less than the argument, or a value greater
2617                 than zero if this Volume's name is lexicographically
2618                 greater than the argument</DL>
2619 </DD>
2620 </DL>
2621 <HR>
2622
2623 <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
2624 compareTo</H3>
2625 <PRE>
2626 public int <B>compareTo</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A>&nbsp;obj)</PRE>
2627 <DL>
2628 <DD>Comparable interface method.
2629 <P>
2630 <DD><DL>
2631 <DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A></CODE></DL>
2632 </DD>
2633 <DD><DL>
2634 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Volume.html#compareTo(org.openafs.jafs.Volume)"><CODE>compareTo(Volume)</CODE></A></DL>
2635 </DD>
2636 </DL>
2637 <HR>
2638
2639 <A NAME="equals(org.openafs.jafs.Volume)"><!-- --></A><H3>
2640 equals</H3>
2641 <PRE>
2642 public boolean <B>equals</B>(<A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>&nbsp;otherVolume)</PRE>
2643 <DL>
2644 <DD>Tests whether two <code>Volume</code> objects are equal, based on their 
2645  names and hosting partition.
2646 <P>
2647 <DD><DL>
2648 </DL>
2649 </DD>
2650 <DD><DL>
2651 <DT><B>Parameters:</B><DD><CODE>otherVolume</CODE> - the Volume to test
2652 <DT><B>Returns:</B><DD>whether the specifed Volume is the same as this Volume</DL>
2653 </DD>
2654 </DL>
2655 <HR>
2656
2657 <A NAME="toString()"><!-- --></A><H3>
2658 toString</H3>
2659 <PRE>
2660 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
2661 <DL>
2662 <DD>Returns the name of this <CODE>Volume</CODE>
2663 <P>
2664 <DD><DL>
2665 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#toString()">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A></CODE></DL>
2666 </DD>
2667 <DD><DL>
2668
2669 <DT><B>Returns:</B><DD>the name of this <CODE>Volume</CODE></DL>
2670 </DD>
2671 </DL>
2672 <HR>
2673
2674 <A NAME="getVolumeInfo(int, int, int, int, org.openafs.jafs.Volume)"><!-- --></A><H3>
2675 getVolumeInfo</H3>
2676 <PRE>
2677 protected static void <B>getVolumeInfo</B>(int&nbsp;cellHandle,
2678                                     int&nbsp;serverHandle,
2679                                     int&nbsp;partition,
2680                                     int&nbsp;volId,
2681                                     <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A>&nbsp;theVolume)
2682                              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2683 <DL>
2684 <DD>Fills in the information fields of the provided <code>Volume</code>.
2685 <P>
2686 <DD><DL>
2687 </DL>
2688 </DD>
2689 <DD><DL>
2690 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the volume belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server on which the volume 
2691                       resides<DD><CODE>partition</CODE> - the numeric id of the partition on which the volume 
2692                     resides<DD><CODE>volId</CODE> - the numeric id of the volume for which to get the info<DD><CODE>theVolume</CODE> - the <A HREF="../../../org/openafs/jafs/Volume.html"><CODE>Volume</CODE></A> object in which to fill in 
2693                     the information
2694 <DT><B>Throws:</B>
2695 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A>, 
2696 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
2697 </DD>
2698 </DL>
2699 <HR>
2700
2701 <A NAME="create(int, int, int, java.lang.String, int)"><!-- --></A><H3>
2702 create</H3>
2703 <PRE>
2704 protected static int <B>create</B>(int&nbsp;cellHandle,
2705                             int&nbsp;serverHandle,
2706                             int&nbsp;partition,
2707                             <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;volumeName,
2708                             int&nbsp;quota)
2709                      throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2710 <DL>
2711 <DD>Creates a volume on a particular partition.
2712 <P>
2713 <DD><DL>
2714 </DL>
2715 </DD>
2716 <DD><DL>
2717 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell in which to create the volume<DD><CODE>serverHandle</CODE> - the vos handle of the server on which to create 
2718                       the volume<DD><CODE>partition</CODE> - the numeric id of the partition on which to create 
2719                     the volume<DD><CODE>volumeName</CODE> - the name of the volume to create<DD><CODE>quota</CODE> - the amount of space (in KB) to set as this volume's quota
2720 <DT><B>Returns:</B><DD>the numeric ID assigned to the volume
2721 <DT><B>Throws:</B>
2722 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A>, 
2723 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
2724 </DD>
2725 </DL>
2726 <HR>
2727
2728 <A NAME="delete(int, int, int, int)"><!-- --></A><H3>
2729 delete</H3>
2730 <PRE>
2731 protected static void <B>delete</B>(int&nbsp;cellHandle,
2732                              int&nbsp;serverHandle,
2733                              int&nbsp;partition,
2734                              int&nbsp;volId)
2735                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2736 <DL>
2737 <DD>Deletes a volume from a particular partition.
2738 <P>
2739 <DD><DL>
2740 </DL>
2741 </DD>
2742 <DD><DL>
2743 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell in which to delete the volume<DD><CODE>serverHandle</CODE> - the vos handle of the server from which to delete 
2744                       the volume<DD><CODE>partition</CODE> - the numeric id of the partition from which to delete 
2745                     the volume<DD><CODE>volId</CODE> - the numeric id of the volume to delete
2746 <DT><B>Throws:</B>
2747 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A>, 
2748 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
2749 </DD>
2750 </DL>
2751 <HR>
2752
2753 <A NAME="createBackupVolume(int, int)"><!-- --></A><H3>
2754 createBackupVolume</H3>
2755 <PRE>
2756 protected static void <B>createBackupVolume</B>(int&nbsp;cellHandle,
2757                                          int&nbsp;volId)
2758                                   throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2759 <DL>
2760 <DD>Creates a backup volume for the specified regular volume.
2761 <P>
2762 <DD><DL>
2763 </DL>
2764 </DD>
2765 <DD><DL>
2766 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the volume belongs<DD><CODE>volId</CODE> - the numeric id of the volume for which to create a backup 
2767                volume
2768 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A></DL>
2769 </DD>
2770 </DL>
2771 <HR>
2772
2773 <A NAME="createReadOnlyVolume(int, int, int, int)"><!-- --></A><H3>
2774 createReadOnlyVolume</H3>
2775 <PRE>
2776 protected static void <B>createReadOnlyVolume</B>(int&nbsp;cellHandle,
2777                                            int&nbsp;serverHandle,
2778                                            int&nbsp;partition,
2779                                            int&nbsp;volId)
2780                                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2781 <DL>
2782 <DD>Creates a read-only volume for the specified regular volume.
2783 <P>
2784 <DD><DL>
2785 </DL>
2786 </DD>
2787 <DD><DL>
2788 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the volume belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server on which the read-only 
2789                       volume is to reside<DD><CODE>partition</CODE> - the numeric id of the partition on which the read-only 
2790                         volume is to reside<DD><CODE>volId</CODE> - the numeric id of the volume for which to create a read-only volume
2791 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A>, 
2792 <A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A></DL>
2793 </DD>
2794 </DL>
2795 <HR>
2796
2797 <A NAME="deleteReadOnlyVolume(int, int, int, int)"><!-- --></A><H3>
2798 deleteReadOnlyVolume</H3>
2799 <PRE>
2800 protected static void <B>deleteReadOnlyVolume</B>(int&nbsp;cellHandle,
2801                                            int&nbsp;serverHandle,
2802                                            int&nbsp;partition,
2803                                            int&nbsp;volId)
2804                                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2805 <DL>
2806 <DD>Deletes a read-only volume for the specified regular volume.
2807 <P>
2808 <DD><DL>
2809 </DL>
2810 </DD>
2811 <DD><DL>
2812 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the volume belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server on which the read-only 
2813                       volume residea<DD><CODE>partition</CODE> - the numeric id of the partition on which the read-only
2814                      volume resides<DD><CODE>volId</CODE> - the numeric read-write id of the volume for which to 
2815                delete the read-only volume
2816 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A>, 
2817 <A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A></DL>
2818 </DD>
2819 </DL>
2820 <HR>
2821
2822 <A NAME="changeQuota(int, int, int, int, int)"><!-- --></A><H3>
2823 changeQuota</H3>
2824 <PRE>
2825 protected static void <B>changeQuota</B>(int&nbsp;cellHandle,
2826                                   int&nbsp;serverHandle,
2827                                   int&nbsp;partition,
2828                                   int&nbsp;volId,
2829                                   int&nbsp;newQuota)
2830                            throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2831 <DL>
2832 <DD>Changes the quota of the specified volume.
2833 <P>
2834 <DD><DL>
2835 </DL>
2836 </DD>
2837 <DD><DL>
2838 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the volume belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server on which the volume 
2839                       resides<DD><CODE>partition</CODE> - the numeric id of the partition on which the volume 
2840                     resides<DD><CODE>volId</CODE> - the numeric id of the volume for which to change the quota<DD><CODE>newQuota</CODE> - the new quota (in KB) to assign the volume
2841 <DT><B>Throws:</B>
2842 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A>, 
2843 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
2844 </DD>
2845 </DL>
2846 <HR>
2847
2848 <A NAME="move(int, int, int, int, int, int)"><!-- --></A><H3>
2849 move</H3>
2850 <PRE>
2851 protected static void <B>move</B>(int&nbsp;cellHandle,
2852                            int&nbsp;fromServerHandle,
2853                            int&nbsp;fromPartition,
2854                            int&nbsp;toServerHandle,
2855                            int&nbsp;toPartition,
2856                            int&nbsp;volId)
2857                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2858 <DL>
2859 <DD>Move the specified volume to a different site.
2860 <P>
2861 <DD><DL>
2862 </DL>
2863 </DD>
2864 <DD><DL>
2865 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the volume belongs<DD><CODE>fromServerHandle</CODE> - the vos handle of the server on which the volume
2866                           currently resides<DD><CODE>fromPartition</CODE> - the numeric id of the partition on which the volume
2867                         currently resides<DD><CODE>toServerHandle</CODE> - the vos handle of the server to which the volume 
2868                         should be moved<DD><CODE>toPartition</CODE> - the numeric id of the partition to which the volume 
2869                       should be moved<DD><CODE>volId</CODE> - the numeric id of the volume to move
2870 <DT><B>Throws:</B>
2871 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A>, 
2872 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
2873 </DD>
2874 </DL>
2875 <HR>
2876
2877 <A NAME="release(int, int, boolean)"><!-- --></A><H3>
2878 release</H3>
2879 <PRE>
2880 protected static void <B>release</B>(int&nbsp;cellHandle,
2881                               int&nbsp;volId,
2882                               boolean&nbsp;forceComplete)
2883                        throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2884 <DL>
2885 <DD>Releases the specified volume that has readonly volume sites.
2886 <P>
2887 <DD><DL>
2888 </DL>
2889 </DD>
2890 <DD><DL>
2891 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the volume belongs<DD><CODE>volId</CODE> - the numeric id of the volume to release<DD><CODE>forceComplete</CODE> - whether or not to force a complete release
2892 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A></DL>
2893 </DD>
2894 </DL>
2895 <HR>
2896
2897 <A NAME="dump(int, int, int, int, int, java.lang.String)"><!-- --></A><H3>
2898 dump</H3>
2899 <PRE>
2900 protected static void <B>dump</B>(int&nbsp;cellHandle,
2901                            int&nbsp;serverHandle,
2902                            int&nbsp;partition,
2903                            int&nbsp;volId,
2904                            int&nbsp;startTime,
2905                            <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;dumpFile)
2906                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2907 <DL>
2908 <DD>Dumps the specified volume to a file.
2909 <P>
2910 <DD><DL>
2911 </DL>
2912 </DD>
2913 <DD><DL>
2914 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the volume belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server on which the volume 
2915                       resides<DD><CODE>partition</CODE> - the numeric id of the partition on which the 
2916                     volume resides<DD><CODE>volId</CODE> - the numeric id of the volume to dump<DD><CODE>startTime</CODE> - files with a modification time >= to this time will 
2917                     be dumped<DD><CODE>dumpFile</CODE> - the full path of the file to which to dump
2918 <DT><B>Throws:</B>
2919 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A>, 
2920 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
2921 </DD>
2922 </DL>
2923 <HR>
2924
2925 <A NAME="restore(int, int, int, int, java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
2926 restore</H3>
2927 <PRE>
2928 protected static void <B>restore</B>(int&nbsp;cellHandle,
2929                               int&nbsp;serverHandle,
2930                               int&nbsp;partition,
2931                               int&nbsp;volId,
2932                               <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;volumeName,
2933                               <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;dumpFile,
2934                               boolean&nbsp;incremental)
2935                        throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2936 <DL>
2937 <DD>Restores the specified volume from a dump file.
2938 <P>
2939 <DD><DL>
2940 </DL>
2941 </DD>
2942 <DD><DL>
2943 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the volume belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server on which the volume is 
2944                       to reside<DD><CODE>partition</CODE> - the numeric id of the partition on which the volume is
2945                     to reside<DD><CODE>volId</CODE> - the numeric id to assign the restored volume (can be 0)<DD><CODE>volumeName</CODE> - the name of the volume to restore as<DD><CODE>dumpFile</CODE> - the full path of the dump file from which to restore<DD><CODE>incremental</CODE> - if true, restores an incremental dump over an existing
2946                      volume (server and partition values must correctly 
2947                      indicate the current position of the existing volume),
2948                      otherwise restores a full dump
2949 <DT><B>Throws:</B>
2950 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A>, 
2951 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
2952 </DD>
2953 </DL>
2954 <HR>
2955
2956 <A NAME="rename(int, int, java.lang.String)"><!-- --></A><H3>
2957 rename</H3>
2958 <PRE>
2959 protected static void <B>rename</B>(int&nbsp;cellHandle,
2960                              int&nbsp;volId,
2961                              <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;newVolumeName)
2962                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2963 <DL>
2964 <DD>Renames the specified read-write volume.
2965 <P>
2966 <DD><DL>
2967 </DL>
2968 </DD>
2969 <DD><DL>
2970 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the volume belongs<DD><CODE>volId</CODE> - the numeric id of the read-write volume to rename<DD><CODE>newVolumeName</CODE> - the new name for the volume
2971 <DT><B>Throws:</B>
2972 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A></DL>
2973 </DD>
2974 </DL>
2975 <HR>
2976
2977 <A NAME="mount(int, int, int, int, boolean)"><!-- --></A><H3>
2978 mount</H3>
2979 <PRE>
2980 protected static void <B>mount</B>(int&nbsp;serverHandle,
2981                             int&nbsp;partition,
2982                             int&nbsp;volId,
2983                             int&nbsp;sleepTime,
2984                             boolean&nbsp;offline)
2985                      throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2986 <DL>
2987 <DD>"Mounts" the specified volume, bringing it online.
2988 <P>
2989 <DD><DL>
2990 </DL>
2991 </DD>
2992 <DD><DL>
2993 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the vos handle of the server on which the volume 
2994                       resides<DD><CODE>partition</CODE> - the numeric id of the partition on which the volume 
2995                     resides<DD><CODE>volId</CODE> - the numeric id of the volume to bring online<DD><CODE>sleepTime</CODE> - ?  (not sure what this is yet, possibly a time to wait 
2996                       before brining it online)<DD><CODE>offline</CODE> - ?  (not sure what this is either, probably the current 
2997                      status of the volume -- busy or offline)
2998 <DT><B>Throws:</B>
2999 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
3000 </DD>
3001 </DL>
3002 <HR>
3003
3004 <A NAME="unmount(int, int, int)"><!-- --></A><H3>
3005 unmount</H3>
3006 <PRE>
3007 protected static void <B>unmount</B>(int&nbsp;serverHandle,
3008                               int&nbsp;partition,
3009                               int&nbsp;volId)
3010                        throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3011 <DL>
3012 <DD>"Unmounts" the specified volume, bringing it offline.
3013 <P>
3014 <DD><DL>
3015 </DL>
3016 </DD>
3017 <DD><DL>
3018 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the vos handle of the server on which the volume 
3019                       resides<DD><CODE>partition</CODE> - the numeric id of the partition on which the volume 
3020                     resides<DD><CODE>volId</CODE> - the numeric id of the volume to bring offline
3021 <DT><B>Throws:</B>
3022 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>Server.getVosServerHandle(int, java.lang.String)</CODE></A></DL>
3023 </DD>
3024 </DL>
3025 <HR>
3026
3027 <A NAME="lock(int, int)"><!-- --></A><H3>
3028 lock</H3>
3029 <PRE>
3030 protected static void <B>lock</B>(int&nbsp;cellHandle,
3031                            int&nbsp;volId)
3032                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3033 <DL>
3034 <DD>Locks the VLDB entry specified volume
3035 <P>
3036 <DD><DL>
3037 </DL>
3038 </DD>
3039 <DD><DL>
3040 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell on which the volume resides<DD><CODE>volId</CODE> - the numeric id of the volume to lock
3041 <DT><B>Throws:</B>
3042 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A></DL>
3043 </DD>
3044 </DL>
3045 <HR>
3046
3047 <A NAME="unlock(int, int)"><!-- --></A><H3>
3048 unlock</H3>
3049 <PRE>
3050 protected static void <B>unlock</B>(int&nbsp;cellHandle,
3051                              int&nbsp;volId)
3052                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3053 <DL>
3054 <DD>Unlocks the VLDB entry of the specified volume
3055 <P>
3056 <DD><DL>
3057 </DL>
3058 </DD>
3059 <DD><DL>
3060 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell on which the volume resides<DD><CODE>volId</CODE> - the numeric id of the volume to unlock
3061 <DT><B>Throws:</B>
3062 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A></DL>
3063 </DD>
3064 </DL>
3065 <HR>
3066
3067 <A NAME="translateNameToID(int, java.lang.String, int)"><!-- --></A><H3>
3068 translateNameToID</H3>
3069 <PRE>
3070 protected static int <B>translateNameToID</B>(int&nbsp;cellHandle,
3071                                        <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
3072                                        int&nbsp;volumeType)
3073                                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3074 <DL>
3075 <DD>Translates a volume name into a volume id
3076 <P>
3077 <DD><DL>
3078 </DL>
3079 </DD>
3080 <DD><DL>
3081 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the volume belongs<DD><CODE>name</CODE> - the name of the volume in question, cannot end in backup or
3082               readonly
3083 <DT><B>Returns:</B><DD>the id of the volume in question
3084 <DT><B>Throws:</B>
3085 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A></DL>
3086 </DD>
3087 </DL>
3088 <HR>
3089
3090 <A NAME="reclaimVolumeMemory()"><!-- --></A><H3>
3091 reclaimVolumeMemory</H3>
3092 <PRE>
3093 protected static void <B>reclaimVolumeMemory</B>()</PRE>
3094 <DL>
3095 <DD>Reclaims all memory being saved by the volume portion of the native 
3096  library. This method should be called when no more <code>Volume</code> 
3097  objects are expected to be used.
3098 <P>
3099 <DD><DL>
3100 </DL>
3101 </DD>
3102 <DD><DL>
3103 </DL>
3104 </DD>
3105 </DL>
3106 <!-- ========= END OF CLASS DATA ========= -->
3107 <HR>
3108
3109 <!-- ========== START OF NAVBAR ========== -->
3110 <A NAME="navbar_bottom"><!-- --></A>
3111 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
3112 <TR>
3113 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
3114 <A NAME="navbar_bottom_firstrow"><!-- --></A>
3115 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
3116   <TR ALIGN="center" VALIGN="top">
3117   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
3118   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
3119   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Volume.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
3120   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
3121   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
3122   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
3123   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
3124   </TR>
3125 </TABLE>
3126 </TD>
3127 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
3128 <B>JAFS API v2</B></EM>
3129 </TD>
3130 </TR>
3131
3132 <TR>
3133 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
3134 &nbsp;<A HREF="../../../org/openafs/jafs/VersionInfo.html"><B>PREV CLASS</B></A>&nbsp;
3135 &nbsp;NEXT CLASS</FONT></TD>
3136 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
3137   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
3138 &nbsp;<A HREF="Volume.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
3139 &nbsp;
3140 <SCRIPT>
3141   <!--
3142   if(window==top) {
3143     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
3144   }
3145   //-->
3146 </SCRIPT>
3147 <NOSCRIPT>
3148 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
3149 </NOSCRIPT>
3150 </FONT></TD>
3151 </TR>
3152 <TR>
3153 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
3154   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
3155 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
3156 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
3157 </TR>
3158 </TABLE>
3159 <!-- =========== END OF NAVBAR =========== -->
3160
3161 <HR>
3162
3163 </BODY>
3164 </HTML>