1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
5 <!-- Generated by javadoc on Mon Jun 09 15:53:39 PDT 2003 -->
9 <META NAME="keywords" CONTENT="org.openafs.jafs.Volume,Volume class">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
15 parent.document.title="Volume (Java AFS API)";
18 <BODY BGCOLOR="white" onload="asd();">
20 <!-- ========== START OF NAVBAR ========== -->
21 <A NAME="navbar_top"><!-- --></A>
22 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
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> </TD>
29 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
30 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Volume.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
31 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
32 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
33 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
34 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 <A HREF="../../../org/openafs/jafs/VersionInfo.html"><B>PREV CLASS</B></A>
46 NEXT CLASS</FONT></TD>
47 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
48 <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
49 <A HREF="Volume.html" TARGET="_top"><B>NO FRAMES</B></A>
54 document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
70 <!-- =========== END OF NAVBAR =========== -->
73 <!-- ======== START OF CLASS DATA ======== -->
76 org.openafs.jafs</FONT>
80 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">java.lang.Object</A>
82 +--<B>org.openafs.jafs.Volume</B>
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>
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>
92 An abstract representation of an AFS volume. It holds information about
93 the server, such as what its quota is.
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>
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>
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;
123 private Server server;
124 private Partition partition;
126 public static void main(String[] args) throws Exception
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];
134 token = new Token(username, password, cellName);
135 cell = new Cell(token);
136 server = cell.getServer(serverName);
137 partition = cell.getPartition(partitionName);
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());
152 <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html" TARGET="org.openafs.jafs.Volume">Serialized Form</A></DL>
156 <!-- ======== NESTED CLASS SUMMARY ======== -->
159 <!-- =========== FIELD SUMMARY =========== -->
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>
167 <TR BGCOLOR="white" CLASS="TableRowColor">
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169 <CODE>protected int</CODE></FONT></TD>
170 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#accessesSinceMidnight">accessesSinceMidnight</A></B></CODE>
173 </TD>
175 <TR BGCOLOR="white" CLASS="TableRowColor">
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177 <CODE>protected int</CODE></FONT></TD>
178 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#backupID">backupID</A></B></CODE>
181 </TD>
183 <TR BGCOLOR="white" CLASS="TableRowColor">
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185 <CODE>protected boolean</CODE></FONT></TD>
186 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#cachedInfo">cachedInfo</A></B></CODE>
189 </TD>
191 <TR BGCOLOR="white" CLASS="TableRowColor">
192 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193 <CODE>protected <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>
197 </TD>
199 <TR BGCOLOR="white" CLASS="TableRowColor">
200 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201 <CODE>protected long</CODE></FONT></TD>
202 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#copyCreationDate">copyCreationDate</A></B></CODE>
205 </TD>
207 <TR BGCOLOR="white" CLASS="TableRowColor">
208 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209 <CODE>protected <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>
213 </TD>
215 <TR BGCOLOR="white" CLASS="TableRowColor">
216 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217 <CODE>protected long</CODE></FONT></TD>
218 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#creationDate">creationDate</A></B></CODE>
221 </TD>
223 <TR BGCOLOR="white" CLASS="TableRowColor">
224 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225 <CODE>protected <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>
229 </TD>
231 <TR BGCOLOR="white" CLASS="TableRowColor">
232 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
233 <CODE>protected int</CODE></FONT></TD>
234 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#currentSize">currentSize</A></B></CODE>
237 </TD>
239 <TR BGCOLOR="white" CLASS="TableRowColor">
240 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241 <CODE>protected int</CODE></FONT></TD>
242 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#disposition">disposition</A></B></CODE>
245 </TD>
247 <TR BGCOLOR="white" CLASS="TableRowColor">
248 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
249 <CODE>protected int</CODE></FONT></TD>
250 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#fileCount">fileCount</A></B></CODE>
253 </TD>
255 <TR BGCOLOR="white" CLASS="TableRowColor">
256 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257 <CODE>protected int</CODE></FONT></TD>
258 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#id">id</A></B></CODE>
261 </TD>
263 <TR BGCOLOR="white" CLASS="TableRowColor">
264 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265 <CODE>protected long</CODE></FONT></TD>
266 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#lastAccessDate">lastAccessDate</A></B></CODE>
269 </TD>
271 <TR BGCOLOR="white" CLASS="TableRowColor">
272 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273 <CODE>protected long</CODE></FONT></TD>
274 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#lastBackupDate">lastBackupDate</A></B></CODE>
277 </TD>
279 <TR BGCOLOR="white" CLASS="TableRowColor">
280 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
281 <CODE>protected long</CODE></FONT></TD>
282 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#lastUpdateDate">lastUpdateDate</A></B></CODE>
285 </TD>
287 <TR BGCOLOR="white" CLASS="TableRowColor">
288 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
289 <CODE>protected <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>
293 </TD>
295 <TR BGCOLOR="white" CLASS="TableRowColor">
296 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
297 <CODE>protected int</CODE></FONT></TD>
298 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#maxQuota">maxQuota</A></B></CODE>
301 </TD>
303 <TR BGCOLOR="white" CLASS="TableRowColor">
304 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305 <CODE>protected <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>
309 </TD>
311 <TR BGCOLOR="white" CLASS="TableRowColor">
312 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313 <CODE>protected <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>
317 </TD>
319 <TR BGCOLOR="white" CLASS="TableRowColor">
320 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321 <CODE>protected int</CODE></FONT></TD>
322 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#readOnlyID">readOnlyID</A></B></CODE>
325 </TD>
327 <TR BGCOLOR="white" CLASS="TableRowColor">
328 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329 <CODE>protected int</CODE></FONT></TD>
330 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#readWriteID">readWriteID</A></B></CODE>
333 </TD>
335 <TR BGCOLOR="white" CLASS="TableRowColor">
336 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337 <CODE>protected <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>
341 </TD>
343 <TR BGCOLOR="white" CLASS="TableRowColor">
344 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
345 <CODE>protected int</CODE></FONT></TD>
346 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#status">status</A></B></CODE>
349 </TD>
351 <TR BGCOLOR="white" CLASS="TableRowColor">
352 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
353 <CODE>protected int</CODE></FONT></TD>
354 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#type">type</A></B></CODE>
357 </TD>
359 <TR BGCOLOR="white" CLASS="TableRowColor">
360 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
361 <CODE>static int</CODE></FONT></TD>
362 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_BUSY">VOLUME_BUSY</A></B></CODE>
365 Status/disposition busy</TD>
367 <TR BGCOLOR="white" CLASS="TableRowColor">
368 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
369 <CODE>static int</CODE></FONT></TD>
370 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_DISK_FULL">VOLUME_DISK_FULL</A></B></CODE>
373 Status/disposition disk full</TD>
375 <TR BGCOLOR="white" CLASS="TableRowColor">
376 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
377 <CODE>static int</CODE></FONT></TD>
378 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_MOVED">VOLUME_MOVED</A></B></CODE>
381 Status/disposition moved</TD>
383 <TR BGCOLOR="white" CLASS="TableRowColor">
384 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
385 <CODE>static int</CODE></FONT></TD>
386 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_NO_SERVICE">VOLUME_NO_SERVICE</A></B></CODE>
389 Status/disposition no service</TD>
391 <TR BGCOLOR="white" CLASS="TableRowColor">
392 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
393 <CODE>static int</CODE></FONT></TD>
394 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_NO_VNODE">VOLUME_NO_VNODE</A></B></CODE>
397 Status/disposition no vnode</TD>
399 <TR BGCOLOR="white" CLASS="TableRowColor">
400 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
401 <CODE>static int</CODE></FONT></TD>
402 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_NO_VOL">VOLUME_NO_VOL</A></B></CODE>
405 Status/disposition no volume</TD>
407 <TR BGCOLOR="white" CLASS="TableRowColor">
408 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
409 <CODE>static int</CODE></FONT></TD>
410 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_OFFLINE">VOLUME_OFFLINE</A></B></CODE>
413 Status/disposition offline</TD>
415 <TR BGCOLOR="white" CLASS="TableRowColor">
416 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
417 <CODE>static int</CODE></FONT></TD>
418 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_OK">VOLUME_OK</A></B></CODE>
421 Status/disposition ok</TD>
423 <TR BGCOLOR="white" CLASS="TableRowColor">
424 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
425 <CODE>static int</CODE></FONT></TD>
426 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_ONLINE">VOLUME_ONLINE</A></B></CODE>
429 Status/disposition online</TD>
431 <TR BGCOLOR="white" CLASS="TableRowColor">
432 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
433 <CODE>static int</CODE></FONT></TD>
434 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_OVER_QUOTA">VOLUME_OVER_QUOTA</A></B></CODE>
437 Status/disposition over quota</TD>
439 <TR BGCOLOR="white" CLASS="TableRowColor">
440 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
441 <CODE>static int</CODE></FONT></TD>
442 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_SALVAGE">VOLUME_SALVAGE</A></B></CODE>
445 Status/disposition salvage</TD>
447 <TR BGCOLOR="white" CLASS="TableRowColor">
448 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
449 <CODE>static int</CODE></FONT></TD>
450 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_TYPE_BACKUP">VOLUME_TYPE_BACKUP</A></B></CODE>
453 Backup volume type</TD>
455 <TR BGCOLOR="white" CLASS="TableRowColor">
456 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
457 <CODE>static 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>
461 Read-only volume type</TD>
463 <TR BGCOLOR="white" CLASS="TableRowColor">
464 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
465 <CODE>static 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>
469 Read-write volume type</TD>
471 <TR BGCOLOR="white" CLASS="TableRowColor">
472 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
473 <CODE>static int</CODE></FONT></TD>
474 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#VOLUME_VOL_EXISTS">VOLUME_VOL_EXISTS</A></B></CODE>
477 Status/disposition volume exists</TD>
481 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
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>
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> partition)</CODE>
495 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>
499 <TR BGCOLOR="white" CLASS="TableRowColor">
500 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
501 <CODE> </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> name,
503 <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> partition)</CODE>
506 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>
510 <TR BGCOLOR="white" CLASS="TableRowColor">
511 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
512 <CODE> </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> name,
514 <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> partition,
515 boolean preloadAllMembers)</CODE>
518 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>
524 <!-- ========== METHOD SUMMARY =========== -->
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>
532 <TR BGCOLOR="white" CLASS="TableRowColor">
533 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
534 <CODE>protected static 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 cellHandle,
536 int serverHandle,
539 int newQuota)</CODE>
542 Changes the quota of the specified volume.</TD>
544 <TR BGCOLOR="white" CLASS="TableRowColor">
545 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
546 <CODE> 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> obj)</CODE>
550 Comparable interface method.</TD>
552 <TR BGCOLOR="white" CLASS="TableRowColor">
553 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
554 <CODE> 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> volume)</CODE>
558 Compares two Volume objects respective to their names and does not
559 factor any other attribute. </TD>
561 <TR BGCOLOR="white" CLASS="TableRowColor">
562 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
563 <CODE> void</CODE></FONT></TD>
564 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#create(int)">create</A></B>(int quota)</CODE>
567 Creates a new volume on the server and partition given upon construction.</TD>
569 <TR BGCOLOR="white" CLASS="TableRowColor">
570 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
571 <CODE>protected static 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 cellHandle,
573 int serverHandle,
575 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> volumeName,
576 int quota)</CODE>
579 Creates a volume on a particular partition.</TD>
581 <TR BGCOLOR="white" CLASS="TableRowColor">
582 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
583 <CODE> <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>
587 Creates a backup volume for this volume.</TD>
589 <TR BGCOLOR="white" CLASS="TableRowColor">
590 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
591 <CODE>protected static void</CODE></FONT></TD>
592 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#createBackupVolume(int, int)">createBackupVolume</A></B>(int cellHandle,
593 int volId)</CODE>
596 Creates a backup volume for the specified regular volume.</TD>
598 <TR BGCOLOR="white" CLASS="TableRowColor">
599 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
600 <CODE> 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> directory)</CODE>
604 Creates a read-write mount point for this volume. </TD>
606 <TR BGCOLOR="white" CLASS="TableRowColor">
607 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
608 <CODE> 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> directory,
610 boolean readWrite)</CODE>
613 Creates a mount point for this volume. </TD>
615 <TR BGCOLOR="white" CLASS="TableRowColor">
616 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
617 <CODE> <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> sitePartition)</CODE>
621 Creates a readonly site for this volume on the specified server and
624 <TR BGCOLOR="white" CLASS="TableRowColor">
625 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
626 <CODE>protected static void</CODE></FONT></TD>
627 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#createReadOnlyVolume(int, int, int, int)">createReadOnlyVolume</A></B>(int cellHandle,
628 int serverHandle,
630 int volId)</CODE>
633 Creates a read-only volume for the specified regular volume.</TD>
635 <TR BGCOLOR="white" CLASS="TableRowColor">
636 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
637 <CODE> void</CODE></FONT></TD>
638 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#delete()">delete</A></B>()</CODE>
641 Deletes the volume from the cell.</TD>
643 <TR BGCOLOR="white" CLASS="TableRowColor">
644 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
645 <CODE>protected static void</CODE></FONT></TD>
646 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#delete(int, int, int, int)">delete</A></B>(int cellHandle,
647 int serverHandle,
649 int volId)</CODE>
652 Deletes a volume from a particular partition.</TD>
654 <TR BGCOLOR="white" CLASS="TableRowColor">
655 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
656 <CODE>protected static void</CODE></FONT></TD>
657 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#deleteReadOnlyVolume(int, int, int, int)">deleteReadOnlyVolume</A></B>(int cellHandle,
658 int serverHandle,
660 int volId)</CODE>
663 Deletes a read-only volume for the specified regular volume.</TD>
665 <TR BGCOLOR="white" CLASS="TableRowColor">
666 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
667 <CODE>protected static 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 cellHandle,
669 int serverHandle,
673 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> dumpFile)</CODE>
676 Dumps the specified volume to a file.</TD>
678 <TR BGCOLOR="white" CLASS="TableRowColor">
679 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
680 <CODE> 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> fileName)</CODE>
684 Dumps this volume to a file. </TD>
686 <TR BGCOLOR="white" CLASS="TableRowColor">
687 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
688 <CODE> 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> fileName,
690 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> dumpSince)</CODE>
693 Dumps this volume to a file. </TD>
695 <TR BGCOLOR="white" CLASS="TableRowColor">
696 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
697 <CODE> 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> otherVolume)</CODE>
701 Tests whether two <code>Volume</code> objects are equal, based on their
702 names and hosting partition.</TD>
704 <TR BGCOLOR="white" CLASS="TableRowColor">
705 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
706 <CODE> int</CODE></FONT></TD>
707 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getAccessesSinceMidnight()">getAccessesSinceMidnight</A></B>()</CODE>
710 Returns the number of accesses since midnight.
713 <TR BGCOLOR="white" CLASS="TableRowColor">
714 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
715 <CODE> int</CODE></FONT></TD>
716 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getBackupID()">getBackupID</A></B>()</CODE>
719 Returns the backup ID of this volume</TD>
721 <TR BGCOLOR="white" CLASS="TableRowColor">
722 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
723 <CODE> <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>
727 Returns the date the volume was copied.
730 <TR BGCOLOR="white" CLASS="TableRowColor">
731 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
732 <CODE> <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>
736 Returns the date the volume was created</TD>
738 <TR BGCOLOR="white" CLASS="TableRowColor">
739 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
740 <CODE> int</CODE></FONT></TD>
741 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getCurrentSize()">getCurrentSize</A></B>()</CODE>
744 Returns current volume size in K.
747 <TR BGCOLOR="white" CLASS="TableRowColor">
748 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
749 <CODE> int</CODE></FONT></TD>
750 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getDisposition()">getDisposition</A></B>()</CODE>
753 Returns volume disposition. </TD>
755 <TR BGCOLOR="white" CLASS="TableRowColor">
756 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
757 <CODE> int</CODE></FONT></TD>
758 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getFileCount()">getFileCount</A></B>()</CODE>
761 Returns file count.
764 <TR BGCOLOR="white" CLASS="TableRowColor">
765 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
766 <CODE> int</CODE></FONT></TD>
767 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getID()">getID</A></B>()</CODE>
770 Returns the id of this volume.</TD>
772 <TR BGCOLOR="white" CLASS="TableRowColor">
773 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
774 <CODE>protected <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>
778 Returns a <code>String</code> representation of this <code>Volume</code>.
781 <TR BGCOLOR="white" CLASS="TableRowColor">
782 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
783 <CODE> <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>
787 Returns the date the volume was last updated.
790 <TR BGCOLOR="white" CLASS="TableRowColor">
791 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
792 <CODE> <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>
796 Returns the name of this volume.</TD>
798 <TR BGCOLOR="white" CLASS="TableRowColor">
799 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
800 <CODE> <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>
804 Returns this volume's hosting partition.</TD>
806 <TR BGCOLOR="white" CLASS="TableRowColor">
807 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
808 <CODE> int</CODE></FONT></TD>
809 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getQuota()">getQuota</A></B>()</CODE>
812 Returns this volume's quota, expressed in kilobyte blocks (1024
813 kilobyte blocks equal one megabyte). </TD>
815 <TR BGCOLOR="white" CLASS="TableRowColor">
816 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
817 <CODE> int</CODE></FONT></TD>
818 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getReadOnlyID()">getReadOnlyID</A></B>()</CODE>
821 Returns the read-only ID of this volume</TD>
823 <TR BGCOLOR="white" CLASS="TableRowColor">
824 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
825 <CODE> int</CODE></FONT></TD>
826 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getReadWriteID()">getReadWriteID</A></B>()</CODE>
829 Returns the read-write ID of this volume</TD>
831 <TR BGCOLOR="white" CLASS="TableRowColor">
832 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
833 <CODE> int</CODE></FONT></TD>
834 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getStatus()">getStatus</A></B>()</CODE>
837 Returns volume status. </TD>
839 <TR BGCOLOR="white" CLASS="TableRowColor">
840 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
841 <CODE> int</CODE></FONT></TD>
842 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getTotalFreeSpace()">getTotalFreeSpace</A></B>()</CODE>
845 Returns the difference between quota and current volume size (in K).
849 <TR BGCOLOR="white" CLASS="TableRowColor">
850 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
851 <CODE> int</CODE></FONT></TD>
852 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#getType()">getType</A></B>()</CODE>
855 Returns volume type. </TD>
857 <TR BGCOLOR="white" CLASS="TableRowColor">
858 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
859 <CODE>protected static 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 cellHandle,
861 int serverHandle,
864 <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A> theVolume)</CODE>
867 Fills in the information fields of the provided <code>Volume</code>.</TD>
869 <TR BGCOLOR="white" CLASS="TableRowColor">
870 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
871 <CODE> boolean</CODE></FONT></TD>
872 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#isQuotaUnlimited()">isQuotaUnlimited</A></B>()</CODE>
875 Tests whether this volume's quota is configured as unlimited.
879 <TR BGCOLOR="white" CLASS="TableRowColor">
880 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
881 <CODE> void</CODE></FONT></TD>
882 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#lock()">lock</A></B>()</CODE>
885 Locks the VLDB enrty for this volume</TD>
887 <TR BGCOLOR="white" CLASS="TableRowColor">
888 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
889 <CODE>protected static void</CODE></FONT></TD>
890 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#lock(int, int)">lock</A></B>(int cellHandle,
891 int volId)</CODE>
894 Locks the VLDB entry specified volume</TD>
896 <TR BGCOLOR="white" CLASS="TableRowColor">
897 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
898 <CODE> void</CODE></FONT></TD>
899 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#mount()">mount</A></B>()</CODE>
902 Mounts this volume, bringing it online and making it accessible.</TD>
904 <TR BGCOLOR="white" CLASS="TableRowColor">
905 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
906 <CODE>protected static 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 serverHandle,
911 boolean offline)</CODE>
914 "Mounts" the specified volume, bringing it online.</TD>
916 <TR BGCOLOR="white" CLASS="TableRowColor">
917 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
918 <CODE>protected static 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 cellHandle,
920 int fromServerHandle,
921 int fromPartition,
922 int toServerHandle,
923 int toPartition,
924 int volId)</CODE>
927 Move the specified volume to a different site.</TD>
929 <TR BGCOLOR="white" CLASS="TableRowColor">
930 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
931 <CODE> 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> newPartition)</CODE>
935 Moves this volume to the specified partition (which indirectly
936 specifies a new server, as well). </TD>
938 <TR BGCOLOR="white" CLASS="TableRowColor">
939 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
940 <CODE>protected static void</CODE></FONT></TD>
941 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#reclaimVolumeMemory()">reclaimVolumeMemory</A></B>()</CODE>
944 Reclaims all memory being saved by the volume portion of the native
947 <TR BGCOLOR="white" CLASS="TableRowColor">
948 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
949 <CODE> void</CODE></FONT></TD>
950 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#refresh()">refresh</A></B>()</CODE>
953 Refreshes the properties of this Volume object instance with values from
954 the AFS volume it represents. </TD>
956 <TR BGCOLOR="white" CLASS="TableRowColor">
957 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
958 <CODE>protected void</CODE></FONT></TD>
959 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#refresh(boolean)">refresh</A></B>(boolean all)</CODE>
962 Refreshes the properties of this Volume object instance with values from
963 the AFS volume it represents. </TD>
965 <TR BGCOLOR="white" CLASS="TableRowColor">
966 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
967 <CODE>protected void</CODE></FONT></TD>
968 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#refreshInfo()">refreshInfo</A></B>()</CODE>
971 Refreshes the information fields of this <code>Volume</code> to reflect
972 the current state of the AFS volume. </TD>
974 <TR BGCOLOR="white" CLASS="TableRowColor">
975 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
976 <CODE> void</CODE></FONT></TD>
977 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#release()">release</A></B>()</CODE>
980 Releases this volume, which updates the read-only copies of it.
984 <TR BGCOLOR="white" CLASS="TableRowColor">
985 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
986 <CODE> void</CODE></FONT></TD>
987 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#release(boolean)">release</A></B>(boolean forceComplete)</CODE>
990 Releases this volume, which updates the read-only copies of it.</TD>
992 <TR BGCOLOR="white" CLASS="TableRowColor">
993 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
994 <CODE>protected static void</CODE></FONT></TD>
995 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#release(int, int, boolean)">release</A></B>(int cellHandle,
997 boolean forceComplete)</CODE>
1000 Releases the specified volume that has readonly volume sites.</TD>
1002 <TR BGCOLOR="white" CLASS="TableRowColor">
1003 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1004 <CODE>protected static 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 cellHandle,
1007 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> newVolumeName)</CODE>
1010 Renames the specified read-write volume.</TD>
1012 <TR BGCOLOR="white" CLASS="TableRowColor">
1013 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1014 <CODE> 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> newName)</CODE>
1018 Renames this volume.</TD>
1020 <TR BGCOLOR="white" CLASS="TableRowColor">
1021 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1022 <CODE>protected static 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 cellHandle,
1024 int serverHandle,
1027 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> volumeName,
1028 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> dumpFile,
1029 boolean incremental)</CODE>
1032 Restores the specified volume from a dump file.</TD>
1034 <TR BGCOLOR="white" CLASS="TableRowColor">
1035 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1036 <CODE> 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> fileName,
1038 boolean incremental)</CODE>
1041 Restores a file to this volume. </TD>
1043 <TR BGCOLOR="white" CLASS="TableRowColor">
1044 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1045 <CODE> 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> fileName,
1047 boolean incremental,
1051 Restores a file to this volume. </TD>
1053 <TR BGCOLOR="white" CLASS="TableRowColor">
1054 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1055 <CODE> void</CODE></FONT></TD>
1056 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#salvage()">salvage</A></B>()</CODE>
1059 Salvages (restores consistency to) this volume. </TD>
1061 <TR BGCOLOR="white" CLASS="TableRowColor">
1062 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1063 <CODE> void</CODE></FONT></TD>
1064 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#setQuota(int)">setQuota</A></B>(int quota)</CODE>
1067 Sets quota of volume, 0 denotes an unlimited quota.</TD>
1069 <TR BGCOLOR="white" CLASS="TableRowColor">
1070 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1071 <CODE> <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>
1075 Returns the name of this <CODE>Volume</CODE></TD>
1077 <TR BGCOLOR="white" CLASS="TableRowColor">
1078 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1079 <CODE>protected static 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 cellHandle,
1081 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name,
1082 int volumeType)</CODE>
1085 Translates a volume name into a volume id</TD>
1087 <TR BGCOLOR="white" CLASS="TableRowColor">
1088 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1089 <CODE> void</CODE></FONT></TD>
1090 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#unlock()">unlock</A></B>()</CODE>
1093 Unlocks the VLDB entry for this volume</TD>
1095 <TR BGCOLOR="white" CLASS="TableRowColor">
1096 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1097 <CODE>protected static void</CODE></FONT></TD>
1098 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#unlock(int, int)">unlock</A></B>(int cellHandle,
1099 int volId)</CODE>
1102 Unlocks the VLDB entry of the specified volume</TD>
1104 <TR BGCOLOR="white" CLASS="TableRowColor">
1105 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1106 <CODE> void</CODE></FONT></TD>
1107 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#unmount()">unmount</A></B>()</CODE>
1110 Unmounts this volume, bringing it offline and making it inaccessible.</TD>
1112 <TR BGCOLOR="white" CLASS="TableRowColor">
1113 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1114 <CODE>protected static void</CODE></FONT></TD>
1115 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Volume.html#unmount(int, int, int)">unmount</A></B>(int serverHandle,
1117 int volId)</CODE>
1120 "Unmounts" the specified volume, bringing it offline.</TD>
1123 <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>
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>
1135 <!-- ============ FIELD DETAIL =========== -->
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>
1145 <A NAME="VOLUME_TYPE_READ_WRITE"><!-- --></A><H3>
1146 VOLUME_TYPE_READ_WRITE</H3>
1148 public static final int <B>VOLUME_TYPE_READ_WRITE</B></PRE>
1150 <DD>Read-write volume type
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>
1157 <A NAME="VOLUME_TYPE_READ_ONLY"><!-- --></A><H3>
1158 VOLUME_TYPE_READ_ONLY</H3>
1160 public static final int <B>VOLUME_TYPE_READ_ONLY</B></PRE>
1162 <DD>Read-only volume type
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>
1169 <A NAME="VOLUME_TYPE_BACKUP"><!-- --></A><H3>
1170 VOLUME_TYPE_BACKUP</H3>
1172 public static final int <B>VOLUME_TYPE_BACKUP</B></PRE>
1174 <DD>Backup volume type
1177 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_TYPE_BACKUP">Constant Field Values</A></DL>
1181 <A NAME="VOLUME_OK"><!-- --></A><H3>
1184 public static final int <B>VOLUME_OK</B></PRE>
1186 <DD>Status/disposition ok
1189 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_OK">Constant Field Values</A></DL>
1193 <A NAME="VOLUME_SALVAGE"><!-- --></A><H3>
1196 public static final int <B>VOLUME_SALVAGE</B></PRE>
1198 <DD>Status/disposition salvage
1201 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_SALVAGE">Constant Field Values</A></DL>
1205 <A NAME="VOLUME_NO_VNODE"><!-- --></A><H3>
1206 VOLUME_NO_VNODE</H3>
1208 public static final int <B>VOLUME_NO_VNODE</B></PRE>
1210 <DD>Status/disposition no vnode
1213 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_NO_VNODE">Constant Field Values</A></DL>
1217 <A NAME="VOLUME_NO_VOL"><!-- --></A><H3>
1220 public static final int <B>VOLUME_NO_VOL</B></PRE>
1222 <DD>Status/disposition no volume
1225 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_NO_VOL">Constant Field Values</A></DL>
1229 <A NAME="VOLUME_VOL_EXISTS"><!-- --></A><H3>
1230 VOLUME_VOL_EXISTS</H3>
1232 public static final int <B>VOLUME_VOL_EXISTS</B></PRE>
1234 <DD>Status/disposition volume exists
1237 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_VOL_EXISTS">Constant Field Values</A></DL>
1241 <A NAME="VOLUME_NO_SERVICE"><!-- --></A><H3>
1242 VOLUME_NO_SERVICE</H3>
1244 public static final int <B>VOLUME_NO_SERVICE</B></PRE>
1246 <DD>Status/disposition no service
1249 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_NO_SERVICE">Constant Field Values</A></DL>
1253 <A NAME="VOLUME_OFFLINE"><!-- --></A><H3>
1256 public static final int <B>VOLUME_OFFLINE</B></PRE>
1258 <DD>Status/disposition offline
1261 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_OFFLINE">Constant Field Values</A></DL>
1265 <A NAME="VOLUME_ONLINE"><!-- --></A><H3>
1268 public static final int <B>VOLUME_ONLINE</B></PRE>
1270 <DD>Status/disposition online
1273 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_ONLINE">Constant Field Values</A></DL>
1277 <A NAME="VOLUME_DISK_FULL"><!-- --></A><H3>
1278 VOLUME_DISK_FULL</H3>
1280 public static final int <B>VOLUME_DISK_FULL</B></PRE>
1282 <DD>Status/disposition disk full
1285 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_DISK_FULL">Constant Field Values</A></DL>
1289 <A NAME="VOLUME_OVER_QUOTA"><!-- --></A><H3>
1290 VOLUME_OVER_QUOTA</H3>
1292 public static final int <B>VOLUME_OVER_QUOTA</B></PRE>
1294 <DD>Status/disposition over quota
1297 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_OVER_QUOTA">Constant Field Values</A></DL>
1301 <A NAME="VOLUME_BUSY"><!-- --></A><H3>
1304 public static final int <B>VOLUME_BUSY</B></PRE>
1306 <DD>Status/disposition busy
1309 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_BUSY">Constant Field Values</A></DL>
1313 <A NAME="VOLUME_MOVED"><!-- --></A><H3>
1316 public static final int <B>VOLUME_MOVED</B></PRE>
1318 <DD>Status/disposition moved
1321 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.openafs.jafs.Volume.VOLUME_MOVED">Constant Field Values</A></DL>
1325 <A NAME="cell"><!-- --></A><H3>
1328 protected <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> <B>cell</B></PRE>
1335 <A NAME="server"><!-- --></A><H3>
1338 protected <A HREF="../../../org/openafs/jafs/Server.html">Server</A> <B>server</B></PRE>
1345 <A NAME="partition"><!-- --></A><H3>
1348 protected <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> <B>partition</B></PRE>
1355 <A NAME="name"><!-- --></A><H3>
1358 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>name</B></PRE>
1365 <A NAME="id"><!-- --></A><H3>
1368 protected int <B>id</B></PRE>
1375 <A NAME="readWriteID"><!-- --></A><H3>
1378 protected int <B>readWriteID</B></PRE>
1385 <A NAME="readOnlyID"><!-- --></A><H3>
1388 protected int <B>readOnlyID</B></PRE>
1395 <A NAME="backupID"><!-- --></A><H3>
1398 protected int <B>backupID</B></PRE>
1405 <A NAME="creationDate"><!-- --></A><H3>
1408 protected long <B>creationDate</B></PRE>
1415 <A NAME="lastAccessDate"><!-- --></A><H3>
1418 protected long <B>lastAccessDate</B></PRE>
1425 <A NAME="lastUpdateDate"><!-- --></A><H3>
1428 protected long <B>lastUpdateDate</B></PRE>
1435 <A NAME="lastBackupDate"><!-- --></A><H3>
1438 protected long <B>lastBackupDate</B></PRE>
1445 <A NAME="copyCreationDate"><!-- --></A><H3>
1446 copyCreationDate</H3>
1448 protected long <B>copyCreationDate</B></PRE>
1455 <A NAME="accessesSinceMidnight"><!-- --></A><H3>
1456 accessesSinceMidnight</H3>
1458 protected int <B>accessesSinceMidnight</B></PRE>
1465 <A NAME="fileCount"><!-- --></A><H3>
1468 protected int <B>fileCount</B></PRE>
1475 <A NAME="maxQuota"><!-- --></A><H3>
1478 protected int <B>maxQuota</B></PRE>
1485 <A NAME="currentSize"><!-- --></A><H3>
1488 protected int <B>currentSize</B></PRE>
1495 <A NAME="status"><!-- --></A><H3>
1498 protected int <B>status</B></PRE>
1505 <A NAME="disposition"><!-- --></A><H3>
1508 protected int <B>disposition</B></PRE>
1515 <A NAME="type"><!-- --></A><H3>
1518 protected int <B>type</B></PRE>
1525 <A NAME="creationDateCal"><!-- --></A><H3>
1526 creationDateCal</H3>
1528 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>creationDateCal</B></PRE>
1535 <A NAME="lastUpdateDateCal"><!-- --></A><H3>
1536 lastUpdateDateCal</H3>
1538 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>lastUpdateDateCal</B></PRE>
1545 <A NAME="copyCreationDateCal"><!-- --></A><H3>
1546 copyCreationDateCal</H3>
1548 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>copyCreationDateCal</B></PRE>
1555 <A NAME="cachedInfo"><!-- --></A><H3>
1558 protected boolean <B>cachedInfo</B></PRE>
1564 <!-- ========= CONSTRUCTOR DETAIL ======== -->
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>
1574 <A NAME="Volume(java.lang.String, org.openafs.jafs.Partition)"><!-- --></A><H3>
1577 public <B>Volume</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name,
1578 <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> partition)
1579 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
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
1592 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1595 <A NAME="Volume(java.lang.String, org.openafs.jafs.Partition, boolean)"><!-- --></A><H3>
1598 public <B>Volume</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name,
1599 <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> partition,
1600 boolean preloadAllMembers)
1601 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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
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.
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>
1626 <A NAME="Volume(org.openafs.jafs.Partition)"><!-- --></A><H3>
1629 <B>Volume</B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> partition)
1630 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
1637 <DT><B>Parameters:</B><DD><CODE>partition</CODE> - the partition on which the volume resides
1639 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1641 <!-- ============ METHOD DETAIL ========== -->
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>
1651 <A NAME="refresh()"><!-- --></A><H3>
1654 public void <B>refresh</B>()
1655 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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
1679 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1684 <A NAME="refresh(boolean)"><!-- --></A><H3>
1687 protected void <B>refresh</B>(boolean all)
1688 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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.
1704 <DT><B>Parameters:</B><DD><CODE>all</CODE> - if true set or renew all object properties; otherwise renew
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>
1712 <A NAME="refreshInfo()"><!-- --></A><H3>
1715 protected void <B>refreshInfo</B>()
1716 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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,
1728 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1733 <A NAME="create(int)"><!-- --></A><H3>
1736 public void <B>create</B>(int quota)
1737 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1739 <DD>Creates a new volume on the server and partition given upon construction.
1745 <DT><B>Parameters:</B><DD><CODE>quota</CODE> - the quota for the volume in K, 0 indicates an unlimited
1748 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1753 <A NAME="createBackup()"><!-- --></A><H3>
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>
1759 <DD>Creates a backup volume for this volume.
1766 <DT><B>Returns:</B><DD>the <code>Volume</code> object representation for the
1767 backup volume that was created
1769 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1774 <A NAME="createReadOnly(org.openafs.jafs.Partition)"><!-- --></A><H3>
1777 public <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A> <B>createReadOnly</B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> sitePartition)
1778 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1780 <DD>Creates a readonly site for this volume on the specified server and
1781 partition. Automatically releases the volume.
1787 <DT><B>Parameters:</B><DD><CODE>sitePartition</CODE> - the partition on which the readonly volume is
1789 <DT><B>Returns:</B><DD>the <code>Volume</code> representation for the
1790 read-only volume that was created
1792 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1797 <A NAME="delete()"><!-- --></A><H3>
1800 public void <B>delete</B>()
1801 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1803 <DD>Deletes the volume from the cell.
1811 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1816 <A NAME="release()"><!-- --></A><H3>
1819 public void <B>release</B>()
1820 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1822 <DD>Releases this volume, which updates the read-only copies of it.
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.
1833 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1838 <A NAME="release(boolean)"><!-- --></A><H3>
1841 public void <B>release</B>(boolean forceComplete)
1842 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1844 <DD>Releases this volume, which updates the read-only copies of it.
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
1854 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1859 <A NAME="dump(java.lang.String, java.util.GregorianCalendar)"><!-- --></A><H3>
1862 public void <B>dump</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> fileName,
1863 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> dumpSince)
1864 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>
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
1878 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1883 <A NAME="dump(java.lang.String)"><!-- --></A><H3>
1886 public void <B>dump</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> fileName)
1887 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1889 <DD>Dumps this volume to a file. Creates a full dump.
1895 <DT><B>Parameters:</B><DD><CODE>fileName</CODE> - the path name of the file to which to dump this volume
1897 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1902 <A NAME="restore(java.lang.String, boolean)"><!-- --></A><H3>
1905 public void <B>restore</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> fileName,
1906 boolean incremental)
1907 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
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
1924 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1929 <A NAME="restore(java.lang.String, boolean, int)"><!-- --></A><H3>
1932 public void <B>restore</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> fileName,
1933 boolean incremental,
1935 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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
1950 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1955 <A NAME="mount()"><!-- --></A><H3>
1958 public void <B>mount</B>()
1959 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1961 <DD>Mounts this volume, bringing it online and making it accessible.
1969 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1974 <A NAME="unmount()"><!-- --></A><H3>
1977 public void <B>unmount</B>()
1978 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1980 <DD>Unmounts this volume, bringing it offline and making it inaccessible.
1988 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1993 <A NAME="lock()"><!-- --></A><H3>
1996 public void <B>lock</B>()
1997 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1999 <DD>Locks the VLDB enrty for this volume
2007 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2012 <A NAME="unlock()"><!-- --></A><H3>
2015 public void <B>unlock</B>()
2016 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2018 <DD>Unlocks the VLDB entry for this volume
2026 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2031 <A NAME="moveTo(org.openafs.jafs.Partition)"><!-- --></A><H3>
2034 public void <B>moveTo</B>(<A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> newPartition)
2035 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
2045 <DT><B>Parameters:</B><DD><CODE>newPartition</CODE> - the partition to which to move the volume
2047 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2052 <A NAME="rename(java.lang.String)"><!-- --></A><H3>
2055 public void <B>rename</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> newName)
2056 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2058 <DD>Renames this volume.
2064 <DT><B>Parameters:</B><DD><CODE>newName</CODE> - the new name for this volume
2066 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2071 <A NAME="salvage()"><!-- --></A><H3>
2074 public void <B>salvage</B>()
2075 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2077 <DD>Salvages (restores consistency to) this volume. Uses default values for
2078 most salvager options in order to simplify the API.
2086 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2091 <A NAME="createMountPoint(java.lang.String)"><!-- --></A><H3>
2092 createMountPoint</H3>
2094 public void <B>createMountPoint</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> directory)
2095 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2097 <DD>Creates a read-write mount point for this volume. Does not ensure the
2098 volume already exists.
2104 <DT><B>Parameters:</B><DD><CODE>directory</CODE> - the name of the directory where this volume
2107 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2112 <A NAME="createMountPoint(java.lang.String, boolean)"><!-- --></A><H3>
2113 createMountPoint</H3>
2115 public void <B>createMountPoint</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> directory,
2116 boolean readWrite)
2117 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2119 <DD>Creates a mount point for this volume. Does not ensure the volume
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
2129 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2134 <A NAME="getName()"><!-- --></A><H3>
2137 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>
2139 <DD>Returns the name of this volume.
2146 <DT><B>Returns:</B><DD>the name of this volume</DL>
2151 <A NAME="getPartition()"><!-- --></A><H3>
2154 public <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> <B>getPartition</B>()</PRE>
2156 <DD>Returns this volume's hosting partition.
2163 <DT><B>Returns:</B><DD>this volume's partition</DL>
2168 <A NAME="getID()"><!-- --></A><H3>
2171 public int <B>getID</B>()
2172 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2174 <DD>Returns the id of this volume.
2181 <DT><B>Returns:</B><DD>the id of this volume
2183 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2188 <A NAME="getReadWriteID()"><!-- --></A><H3>
2191 public int <B>getReadWriteID</B>()
2192 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2194 <DD>Returns the read-write ID of this volume
2201 <DT><B>Returns:</B><DD>the read-write id
2203 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2208 <A NAME="getReadOnlyID()"><!-- --></A><H3>
2211 public int <B>getReadOnlyID</B>()
2212 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2214 <DD>Returns the read-only ID of this volume
2221 <DT><B>Returns:</B><DD>the read-only id
2223 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2228 <A NAME="getBackupID()"><!-- --></A><H3>
2231 public int <B>getBackupID</B>()
2232 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2234 <DD>Returns the backup ID of this volume
2241 <DT><B>Returns:</B><DD>the backup id
2243 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2248 <A NAME="getCreationDate()"><!-- --></A><H3>
2249 getCreationDate</H3>
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>
2254 <DD>Returns the date the volume was created
2261 <DT><B>Returns:</B><DD>the date the volume was created
2263 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2268 <A NAME="getLastUpdateDate()"><!-- --></A><H3>
2269 getLastUpdateDate</H3>
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>
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
2285 <DT><B>Returns:</B><DD>the date the volume was last updated
2287 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2292 <A NAME="getCopyCreationDate()"><!-- --></A><H3>
2293 getCopyCreationDate</H3>
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>
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
2309 <DT><B>Returns:</B><DD>the date the volume was copied
2311 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2316 <A NAME="getAccessesSinceMidnight()"><!-- --></A><H3>
2317 getAccessesSinceMidnight</H3>
2319 public int <B>getAccessesSinceMidnight</B>()
2320 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
2333 <DT><B>Returns:</B><DD>the number of accesses since midnight
2335 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2340 <A NAME="getFileCount()"><!-- --></A><H3>
2343 public int <B>getFileCount</B>()
2344 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
2357 <DT><B>Returns:</B><DD>the file count
2359 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2364 <A NAME="getCurrentSize()"><!-- --></A><H3>
2367 public int <B>getCurrentSize</B>()
2368 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
2381 <DT><B>Returns:</B><DD>the current volume size in K
2383 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2388 <A NAME="getTotalFreeSpace()"><!-- --></A><H3>
2389 getTotalFreeSpace</H3>
2391 public int <B>getTotalFreeSpace</B>()
2392 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2394 <DD>Returns the difference between quota and current volume size (in K).
2396 <P> Please note: the product of this method is <U>not</U> saved.
2403 <DT><B>Returns:</B><DD>the current free space in K
2405 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2410 <A NAME="getQuota()"><!-- --></A><H3>
2413 public int <B>getQuota</B>()
2414 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
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.
2431 <DT><B>Returns:</B><DD>the volume quota in K
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>
2440 <A NAME="isQuotaUnlimited()"><!-- --></A><H3>
2441 isQuotaUnlimited</H3>
2443 public boolean <B>isQuotaUnlimited</B>()
2444 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2446 <DD>Tests whether this volume's quota is configured as unlimited.
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.
2457 <DT><B>Returns:</B><DD><CODE>true</CODE> if this volume's quota is configured as
2458 unlimited; otherwise <CODE>false</CODE>.
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>
2465 <A NAME="getStatus()"><!-- --></A><H3>
2468 public int <B>getStatus</B>()
2469 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
2495 <DT><B>Returns:</B><DD>volume status
2497 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2502 <A NAME="getDisposition()"><!-- --></A><H3>
2505 public int <B>getDisposition</B>()
2506 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
2532 <DT><B>Returns:</B><DD>volume disposition
2534 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2539 <A NAME="getType()"><!-- --></A><H3>
2542 public int <B>getType</B>()
2543 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>
2555 <DT><B>Returns:</B><DD>volume type
2557 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2562 <A NAME="setQuota(int)"><!-- --></A><H3>
2565 public void <B>setQuota</B>(int quota)
2566 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2568 <DD>Sets quota of volume, 0 denotes an unlimited quota.
2574 <DT><B>Parameters:</B><DD><CODE>quota</CODE> - the new volume quota in K (0 for unlimited)
2576 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2581 <A NAME="getInfo()"><!-- --></A><H3>
2584 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getInfo</B>()</PRE>
2586 <DD>Returns a <code>String</code> representation of this <code>Volume</code>.
2587 Contains the information fields.
2594 <DT><B>Returns:</B><DD>a <code>String</code> representation of the <code>Volume</code></DL>
2599 <A NAME="compareTo(org.openafs.jafs.Volume)"><!-- --></A><H3>
2602 public int <B>compareTo</B>(<A HREF="../../../org/openafs/jafs/Volume.html">Volume</A> volume)</PRE>
2604 <DD>Compares two Volume objects respective to their names and does not
2605 factor any other attribute. Alphabetic case is significant in
2612 <DT><B>Parameters:</B><DD><CODE>volume</CODE> - The Volume object to be compared to this Volume
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>
2623 <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
2626 public int <B>compareTo</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A> obj)</PRE>
2628 <DD>Comparable interface method.
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>
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>
2639 <A NAME="equals(org.openafs.jafs.Volume)"><!-- --></A><H3>
2642 public boolean <B>equals</B>(<A HREF="../../../org/openafs/jafs/Volume.html">Volume</A> otherVolume)</PRE>
2644 <DD>Tests whether two <code>Volume</code> objects are equal, based on their
2645 names and hosting partition.
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>
2657 <A NAME="toString()"><!-- --></A><H3>
2660 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
2662 <DD>Returns the name of this <CODE>Volume</CODE>
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>
2669 <DT><B>Returns:</B><DD>the name of this <CODE>Volume</CODE></DL>
2674 <A NAME="getVolumeInfo(int, int, int, int, org.openafs.jafs.Volume)"><!-- --></A><H3>
2677 protected static void <B>getVolumeInfo</B>(int cellHandle,
2678 int serverHandle,
2681 <A HREF="../../../org/openafs/jafs/Volume.html">Volume</A> theVolume)
2682 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2684 <DD>Fills in the information fields of the provided <code>Volume</code>.
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
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>
2701 <A NAME="create(int, int, int, java.lang.String, int)"><!-- --></A><H3>
2704 protected static int <B>create</B>(int cellHandle,
2705 int serverHandle,
2707 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> volumeName,
2709 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2711 <DD>Creates a volume on a particular partition.
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
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>
2728 <A NAME="delete(int, int, int, int)"><!-- --></A><H3>
2731 protected static void <B>delete</B>(int cellHandle,
2732 int serverHandle,
2735 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2737 <DD>Deletes a volume from a particular partition.
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
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>
2753 <A NAME="createBackupVolume(int, int)"><!-- --></A><H3>
2754 createBackupVolume</H3>
2756 protected static void <B>createBackupVolume</B>(int cellHandle,
2758 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2760 <DD>Creates a backup volume for the specified regular volume.
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
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>
2773 <A NAME="createReadOnlyVolume(int, int, int, int)"><!-- --></A><H3>
2774 createReadOnlyVolume</H3>
2776 protected static void <B>createReadOnlyVolume</B>(int cellHandle,
2777 int serverHandle,
2780 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2782 <DD>Creates a read-only volume for the specified regular volume.
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>
2797 <A NAME="deleteReadOnlyVolume(int, int, int, int)"><!-- --></A><H3>
2798 deleteReadOnlyVolume</H3>
2800 protected static void <B>deleteReadOnlyVolume</B>(int cellHandle,
2801 int serverHandle,
2804 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2806 <DD>Deletes a read-only volume for the specified regular volume.
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>
2822 <A NAME="changeQuota(int, int, int, int, int)"><!-- --></A><H3>
2825 protected static void <B>changeQuota</B>(int cellHandle,
2826 int serverHandle,
2830 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2832 <DD>Changes the quota of the specified volume.
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
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>
2848 <A NAME="move(int, int, int, int, int, int)"><!-- --></A><H3>
2851 protected static void <B>move</B>(int cellHandle,
2852 int fromServerHandle,
2853 int fromPartition,
2854 int toServerHandle,
2855 int toPartition,
2857 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2859 <DD>Move the specified volume to a different site.
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
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>
2877 <A NAME="release(int, int, boolean)"><!-- --></A><H3>
2880 protected static void <B>release</B>(int cellHandle,
2882 boolean forceComplete)
2883 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2885 <DD>Releases the specified volume that has readonly volume sites.
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>
2897 <A NAME="dump(int, int, int, int, int, java.lang.String)"><!-- --></A><H3>
2900 protected static void <B>dump</B>(int cellHandle,
2901 int serverHandle,
2905 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> dumpFile)
2906 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2908 <DD>Dumps the specified volume to a file.
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
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>
2925 <A NAME="restore(int, int, int, int, java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
2928 protected static void <B>restore</B>(int cellHandle,
2929 int serverHandle,
2932 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> volumeName,
2933 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> dumpFile,
2934 boolean incremental)
2935 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2937 <DD>Restores the specified volume from a dump file.
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
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>
2956 <A NAME="rename(int, int, java.lang.String)"><!-- --></A><H3>
2959 protected static void <B>rename</B>(int cellHandle,
2961 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> newVolumeName)
2962 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2964 <DD>Renames the specified read-write volume.
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
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>
2977 <A NAME="mount(int, int, int, int, boolean)"><!-- --></A><H3>
2980 protected static void <B>mount</B>(int serverHandle,
2984 boolean offline)
2985 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2987 <DD>"Mounts" the specified volume, bringing it online.
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)
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>
3004 <A NAME="unmount(int, int, int)"><!-- --></A><H3>
3007 protected static void <B>unmount</B>(int serverHandle,
3010 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3012 <DD>"Unmounts" the specified volume, bringing it offline.
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
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>
3027 <A NAME="lock(int, int)"><!-- --></A><H3>
3030 protected static void <B>lock</B>(int cellHandle,
3032 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3034 <DD>Locks the VLDB entry specified volume
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
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>
3047 <A NAME="unlock(int, int)"><!-- --></A><H3>
3050 protected static void <B>unlock</B>(int cellHandle,
3052 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3054 <DD>Unlocks the VLDB entry of the specified volume
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
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>
3067 <A NAME="translateNameToID(int, java.lang.String, int)"><!-- --></A><H3>
3068 translateNameToID</H3>
3070 protected static int <B>translateNameToID</B>(int cellHandle,
3071 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name,
3072 int volumeType)
3073 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3075 <DD>Translates a volume name into a volume id
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
3083 <DT><B>Returns:</B><DD>the id of the volume in question
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>
3090 <A NAME="reclaimVolumeMemory()"><!-- --></A><H3>
3091 reclaimVolumeMemory</H3>
3093 protected static void <B>reclaimVolumeMemory</B>()</PRE>
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.
3106 <!-- ========= END OF CLASS DATA ========= -->
3109 <!-- ========== START OF NAVBAR ========== -->
3110 <A NAME="navbar_bottom"><!-- --></A>
3111 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
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> </TD>
3118 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
3119 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Volume.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
3120 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
3121 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
3122 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
3123 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
3127 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
3128 <B>JAFS API v2</B></EM>
3133 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
3134 <A HREF="../../../org/openafs/jafs/VersionInfo.html"><B>PREV CLASS</B></A>
3135 NEXT CLASS</FONT></TD>
3136 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
3137 <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
3138 <A HREF="Volume.html" TARGET="_top"><B>NO FRAMES</B></A>
3143 document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
3148 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
3153 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
3154 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
3155 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
3156 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
3159 <!-- =========== END OF NAVBAR =========== -->