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:38 PDT 2003 -->
9 <META NAME="keywords" CONTENT="org.openafs.jafs.Server,Server class">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
15 parent.document.title="Server (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/Server.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/Process.html"><B>PREV CLASS</B></A>
46 <A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html"><B>NEXT CLASS</B></A></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="Server.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: <A HREF="#nested_class_summary">NESTED</A> | <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.Server</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>Server</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 server. It holds information about
93 the server, such as what its processes are.
96 Constructing an instance of a <code>Server</code> does not mean an actual
97 AFS server is created and added to a cell -- on the contrary, a
98 <code>Server</code> object must be a representation of an already existing
99 AFS server. There is no way to create a new AFS server through this API.
100 See <a href="http://www.openafs.org">OpenAFS.org</a> for information on how
101 to create a new AFS server.<BR><BR>
103 A <code>Server</code> object may represent either an AFS file server,
104 an AFS database server, or both if the same machine serves both
107 Each <code>Server</code> object has its own individual set of
108 <code>Partition</code>s, <code>Process</code>es, and <code>Key</code>s.
109 This represents the properties and attributes of an actual AFS server.
112 <!--Example of how to use class-->
113 The following is a simple example of how to construct and use a Server
114 object. This example constructs a <code>Server</code> using the
115 <code>Cell</code> representing teh AFS cell to which the server belongs,
116 and prints out the names of all the partitions residing on the server.
120 import org.openafs.jafs.Cell;
121 import org.openafs.jafs.AFSException;
122 import org.openafs.jafs.Partition;
123 import org.openafs.jafs.Server;
129 private Server server;
131 public static void main(String[] args) throws Exception
133 String username = arg[0];
134 String password = arg[1];
135 String cellName = arg[2];
136 String serverName = arg[3];
138 token = new Token(username, password, cellName);
139 cell = new Cell(token);
140 server = new Server(serverName, cell);
142 System.out.println("Partitions in Server " + server.getName() + ":");
143 if( server.isFileServer() ) {
144 Partition[] partitions = server.getPartitions();
145 for (int i = 0; i < partitions.length; i++) {
146 System.out.println(" -> " + partitions[i]);
157 <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html" TARGET="org.openafs.jafs.Server">Serialized Form</A></DL>
161 <!-- ======== NESTED CLASS SUMMARY ======== -->
163 <A NAME="nested_class_summary"><!-- --></A>
164 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
165 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
166 <TD COLSPAN=2><FONT SIZE="+2">
167 <B>Nested Class Summary</B></FONT></TD>
169 <TR BGCOLOR="white" CLASS="TableRowColor">
170 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171 <CODE>static class</CODE></FONT></TD>
172 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A></B></CODE>
175 </TD>
179 <!-- =========== FIELD SUMMARY =========== -->
181 <A NAME="field_summary"><!-- --></A>
182 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
183 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
184 <TD COLSPAN=2><FONT SIZE="+2">
185 <B>Field Summary</B></FONT></TD>
187 <TR BGCOLOR="white" CLASS="TableRowColor">
188 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A></CODE></FONT></TD>
190 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#adminNames">adminNames</A></B></CODE>
193 </TD>
195 <TR BGCOLOR="white" CLASS="TableRowColor">
196 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
197 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A></CODE></FONT></TD>
198 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#admins">admins</A></B></CODE>
201 </TD>
203 <TR BGCOLOR="white" CLASS="TableRowColor">
204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
205 <CODE>protected boolean</CODE></FONT></TD>
206 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#badDatabase">badDatabase</A></B></CODE>
209 </TD>
211 <TR BGCOLOR="white" CLASS="TableRowColor">
212 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213 <CODE>protected boolean</CODE></FONT></TD>
214 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#badFileServer">badFileServer</A></B></CODE>
217 </TD>
219 <TR BGCOLOR="white" CLASS="TableRowColor">
220 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221 <CODE>protected <A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A></CODE></FONT></TD>
222 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#binRestartTime">binRestartTime</A></B></CODE>
225 </TD>
227 <TR BGCOLOR="white" CLASS="TableRowColor">
228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229 <CODE>protected int</CODE></FONT></TD>
230 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#bosHandle">bosHandle</A></B></CODE>
233 </TD>
235 <TR BGCOLOR="white" CLASS="TableRowColor">
236 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237 <CODE>protected boolean</CODE></FONT></TD>
238 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#cachedInfo">cachedInfo</A></B></CODE>
241 </TD>
243 <TR BGCOLOR="white" CLASS="TableRowColor">
244 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
245 <CODE>protected <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A></CODE></FONT></TD>
246 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#cell">cell</A></B></CODE>
249 </TD>
251 <TR BGCOLOR="white" CLASS="TableRowColor">
252 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253 <CODE>protected boolean</CODE></FONT></TD>
254 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#database">database</A></B></CODE>
257 </TD>
259 <TR BGCOLOR="white" CLASS="TableRowColor">
260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261 <CODE>protected boolean</CODE></FONT></TD>
262 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#fileServer">fileServer</A></B></CODE>
265 </TD>
267 <TR BGCOLOR="white" CLASS="TableRowColor">
268 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269 <CODE>protected <A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A></CODE></FONT></TD>
270 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#genRestartTime">genRestartTime</A></B></CODE>
273 </TD>
275 <TR BGCOLOR="white" CLASS="TableRowColor">
276 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
277 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
278 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#ipAddresses">ipAddresses</A></B></CODE>
281 </TD>
283 <TR BGCOLOR="white" CLASS="TableRowColor">
284 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A></CODE></FONT></TD>
286 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#keys">keys</A></B></CODE>
289 </TD>
291 <TR BGCOLOR="white" CLASS="TableRowColor">
292 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
294 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#name">name</A></B></CODE>
297 </TD>
299 <TR BGCOLOR="white" CLASS="TableRowColor">
300 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A></CODE></FONT></TD>
302 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#partitionNames">partitionNames</A></B></CODE>
305 </TD>
307 <TR BGCOLOR="white" CLASS="TableRowColor">
308 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
309 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A></CODE></FONT></TD>
310 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#partitions">partitions</A></B></CODE>
313 </TD>
315 <TR BGCOLOR="white" CLASS="TableRowColor">
316 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
317 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A></CODE></FONT></TD>
318 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#processes">processes</A></B></CODE>
321 </TD>
323 <TR BGCOLOR="white" CLASS="TableRowColor">
324 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
325 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A></CODE></FONT></TD>
326 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#processNames">processNames</A></B></CODE>
329 </TD>
331 <TR BGCOLOR="white" CLASS="TableRowColor">
332 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
333 <CODE>protected int</CODE></FONT></TD>
334 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#totalFreeSpace">totalFreeSpace</A></B></CODE>
337 </TD>
339 <TR BGCOLOR="white" CLASS="TableRowColor">
340 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
341 <CODE>protected int</CODE></FONT></TD>
342 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#totalQuota">totalQuota</A></B></CODE>
345 </TD>
347 <TR BGCOLOR="white" CLASS="TableRowColor">
348 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
349 <CODE>protected int</CODE></FONT></TD>
350 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#totalSpace">totalSpace</A></B></CODE>
353 </TD>
355 <TR BGCOLOR="white" CLASS="TableRowColor">
356 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
357 <CODE>protected int</CODE></FONT></TD>
358 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#totalUsedSpace">totalUsedSpace</A></B></CODE>
361 </TD>
363 <TR BGCOLOR="white" CLASS="TableRowColor">
364 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
365 <CODE>protected int</CODE></FONT></TD>
366 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#vosHandle">vosHandle</A></B></CODE>
369 </TD>
373 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
375 <A NAME="constructor_summary"><!-- --></A>
376 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
377 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
378 <TD COLSPAN=2><FONT SIZE="+2">
379 <B>Constructor Summary</B></FONT></TD>
381 <TR BGCOLOR="white" CLASS="TableRowColor">
382 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
383 <CODE>(package private)</CODE></FONT></TD>
384 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#Server(org.openafs.jafs.Cell)">Server</A></B>(<A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> cell)</CODE>
387 Constructs a blank <code>Server</code> object instance given the cell to
388 which the server belongs. </TD>
390 <TR BGCOLOR="white" CLASS="TableRowColor">
391 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
392 <CODE> </CODE></FONT></TD>
393 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#Server(java.lang.String, org.openafs.jafs.Cell)">Server</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name,
394 <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> cell)</CODE>
397 Constructs a new <CODE>Server</CODE> object instance given the
398 name of the AFS server and the AFS cell, represented by
399 <CODE>cell</CODE>, to which it belongs. </TD>
401 <TR BGCOLOR="white" CLASS="TableRowColor">
402 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
403 <CODE> </CODE></FONT></TD>
404 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#Server(java.lang.String, org.openafs.jafs.Cell, boolean)">Server</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name,
405 <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> cell,
406 boolean preloadAllMembers)</CODE>
409 Constructs a new <CODE>Server</CODE> object instance given the name
410 of the AFS server and the AFS cell, represented by <CODE>cell</CODE>,
411 to which it belongs. </TD>
415 <!-- ========== METHOD SUMMARY =========== -->
417 <A NAME="method_summary"><!-- --></A>
418 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
419 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
420 <TD COLSPAN=2><FONT SIZE="+2">
421 <B>Method Summary</B></FONT></TD>
423 <TR BGCOLOR="white" CLASS="TableRowColor">
424 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
425 <CODE> void</CODE></FONT></TD>
426 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#addAdmin(org.openafs.jafs.User)">addAdmin</A></B>(<A HREF="../../../org/openafs/jafs/User.html">User</A> admin)</CODE>
429 Add a bos admin to the UserList file of this server, in order to
430 given the AFS user represented by <code>admin</code> full bos
431 administrative privileges on this server.</TD>
433 <TR BGCOLOR="white" CLASS="TableRowColor">
434 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
435 <CODE>protected static void</CODE></FONT></TD>
436 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#addBosAdmin(int, java.lang.String)">addBosAdmin</A></B>(int serverHandle,
437 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> adminName)</CODE>
440 Adds the given to name to the list of bos administrators on that server.</TD>
442 <TR BGCOLOR="white" CLASS="TableRowColor">
443 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
444 <CODE> void</CODE></FONT></TD>
445 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#close()">close</A></B>()</CODE>
448 Unauthenticates all server-related tokens that have been obtained by
449 this <code>Server</code> object, and shuts this server object down.
452 <TR BGCOLOR="white" CLASS="TableRowColor">
453 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
454 <CODE>protected static void</CODE></FONT></TD>
455 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#closeBosServerHandle(int)">closeBosServerHandle</A></B>(int bosHandle)</CODE>
458 Closes the given currently open bos server handle.</TD>
460 <TR BGCOLOR="white" CLASS="TableRowColor">
461 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
462 <CODE>protected static void</CODE></FONT></TD>
463 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#closeVosServerHandle(int)">closeVosServerHandle</A></B>(int vosHandle)</CODE>
466 Closes the given currently open vos server handle.</TD>
468 <TR BGCOLOR="white" CLASS="TableRowColor">
469 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
470 <CODE> int</CODE></FONT></TD>
471 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.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>
474 Comparable interface method.</TD>
476 <TR BGCOLOR="white" CLASS="TableRowColor">
477 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
478 <CODE> int</CODE></FONT></TD>
479 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#compareTo(org.openafs.jafs.Server)">compareTo</A></B>(<A HREF="../../../org/openafs/jafs/Server.html">Server</A> server)</CODE>
482 Compares two Server objects respective to their names and does not
483 factor any other attribute. </TD>
485 <TR BGCOLOR="white" CLASS="TableRowColor">
486 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
487 <CODE> boolean</CODE></FONT></TD>
488 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#equals(org.openafs.jafs.Server)">equals</A></B>(<A HREF="../../../org/openafs/jafs/Server.html">Server</A> otherServer)</CODE>
491 Tests whether two <code>Server</code> objects are equal, based on their
492 names and hosting Cell.</TD>
494 <TR BGCOLOR="white" CLASS="TableRowColor">
495 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
496 <CODE> int</CODE></FONT></TD>
497 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getAdminCount()">getAdminCount</A></B>()</CODE>
500 Returns the number of BOS administrators assigned to this server.
504 <TR BGCOLOR="white" CLASS="TableRowColor">
505 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
506 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
507 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getAdminNames()">getAdminNames</A></B>()</CODE>
510 Retrieves an array containing all of the names of bos admins
511 associated with this <code>Server</code>. </TD>
513 <TR BGCOLOR="white" CLASS="TableRowColor">
514 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
515 <CODE> <A HREF="../../../org/openafs/jafs/User.html">User</A>[]</CODE></FONT></TD>
516 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getAdmins()">getAdmins</A></B>()</CODE>
519 Retrieves an array containing all of the admin <code>User</code> objects
520 associated with this <code>Server</code>, each of which are an abstract
521 representation of an actual bos administrator of the AFS server.
524 <TR BGCOLOR="white" CLASS="TableRowColor">
525 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
526 <CODE> <A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A></CODE></FONT></TD>
527 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBinaryRestartTime()">getBinaryRestartTime</A></B>()</CODE>
530 Returns the BOS Server's binary restart time in the form of an
531 ExecutableTime object. </TD>
533 <TR BGCOLOR="white" CLASS="TableRowColor">
534 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
535 <CODE>protected static int</CODE></FONT></TD>
536 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBosAdminCount(int)">getBosAdminCount</A></B>(int serverHandle)</CODE>
539 Returns the total number of BOS administrators associated with the server
540 denoted by <CODE>serverHandle</CODE>.</TD>
542 <TR BGCOLOR="white" CLASS="TableRowColor">
543 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
544 <CODE>protected static int</CODE></FONT></TD>
545 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBosAdminsBegin(int)">getBosAdminsBegin</A></B>(int serverHandle)</CODE>
548 Begin the process of getting the bos amdinistrators on a server. </TD>
550 <TR BGCOLOR="white" CLASS="TableRowColor">
551 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
552 <CODE>protected static void</CODE></FONT></TD>
553 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBosAdminsDone(int)">getBosAdminsDone</A></B>(int iterationId)</CODE>
556 Signals that the iteration is complete and will not be accessed anymore.</TD>
558 <TR BGCOLOR="white" CLASS="TableRowColor">
559 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
560 <CODE>protected static int</CODE></FONT></TD>
561 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBosAdminsNext(int, int, org.openafs.jafs.User)">getBosAdminsNext</A></B>(int cellHandle,
562 int iterationId,
563 <A HREF="../../../org/openafs/jafs/User.html">User</A> theUser)</CODE>
566 Returns the next bos admin of the server. </TD>
568 <TR BGCOLOR="white" CLASS="TableRowColor">
569 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
570 <CODE>protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
571 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBosAdminsNextString(int)">getBosAdminsNextString</A></B>(int iterationId)</CODE>
574 Returns the next bos admin of the server. </TD>
576 <TR BGCOLOR="white" CLASS="TableRowColor">
577 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
578 <CODE>protected int</CODE></FONT></TD>
579 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBosHandle()">getBosHandle</A></B>()</CODE>
582 Returns this server's bos handle.</TD>
584 <TR BGCOLOR="white" CLASS="TableRowColor">
585 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
586 <CODE>protected static int</CODE></FONT></TD>
587 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBosServerHandle(int, java.lang.String)">getBosServerHandle</A></B>(int cellHandle,
588 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> serverName)</CODE>
591 Opens a server for administrative bos use, based on the cell handle
594 <TR BGCOLOR="white" CLASS="TableRowColor">
595 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
596 <CODE> <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A></CODE></FONT></TD>
597 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getCell()">getCell</A></B>()</CODE>
600 Returns the <code>Cell</code> object with which this <code>Server</code>
601 was constructed. </TD>
603 <TR BGCOLOR="white" CLASS="TableRowColor">
604 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
605 <CODE> <A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A></CODE></FONT></TD>
606 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getGeneralRestartTime()">getGeneralRestartTime</A></B>()</CODE>
609 Returns the BOS Server's general restart time in the form of an
610 ExecutableTime object. </TD>
612 <TR BGCOLOR="white" CLASS="TableRowColor">
613 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
614 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
615 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getInfo()">getInfo</A></B>()</CODE>
618 Returns a <code>String</code> representation of this <code>Server</code>.
621 <TR BGCOLOR="white" CLASS="TableRowColor">
622 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
623 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
624 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getInfoKeys()">getInfoKeys</A></B>()</CODE>
627 Returns a <code>String</code> containing the <code>String</code>
628 representations of all the keys of this <code>Server</code>.</TD>
630 <TR BGCOLOR="white" CLASS="TableRowColor">
631 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
632 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
633 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getInfoPartitions()">getInfoPartitions</A></B>()</CODE>
636 Returns a <code>String</code> containing the <code>String</code>
637 representations of all the partitions of this <code>Server</code>.</TD>
639 <TR BGCOLOR="white" CLASS="TableRowColor">
640 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
641 <CODE>protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
642 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getInfoProcesses()">getInfoProcesses</A></B>()</CODE>
645 Returns a <code>String</code> containing the <code>String</code>
646 representations of all the processes of this <code>Server</code>.</TD>
648 <TR BGCOLOR="white" CLASS="TableRowColor">
649 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
650 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
651 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getIPAddresses()">getIPAddresses</A></B>()</CODE>
654 Returns this server's IP address as a String. </TD>
656 <TR BGCOLOR="white" CLASS="TableRowColor">
657 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
658 <CODE> <A HREF="../../../org/openafs/jafs/Key.html">Key</A></CODE></FONT></TD>
659 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getKey(int)">getKey</A></B>(int keyVersion)</CODE>
662 Retrieves the <CODE>Key</CODE> object (which is an abstract
663 representation of an actual AFS partition of this server) designated
664 by <code>nkeyVersion</code>. </TD>
666 <TR BGCOLOR="white" CLASS="TableRowColor">
667 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
668 <CODE> int</CODE></FONT></TD>
669 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getKeyCount()">getKeyCount</A></B>()</CODE>
672 Returns the number of keys on this server.
676 <TR BGCOLOR="white" CLASS="TableRowColor">
677 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
678 <CODE>protected static int</CODE></FONT></TD>
679 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getKeyCount(int)">getKeyCount</A></B>(int serverHandle)</CODE>
682 Returns the total number of keys hosted by the server denoted by
683 <CODE>serverHandle</CODE>.</TD>
685 <TR BGCOLOR="white" CLASS="TableRowColor">
686 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
687 <CODE> <A HREF="../../../org/openafs/jafs/Key.html">Key</A>[]</CODE></FONT></TD>
688 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getKeys()">getKeys</A></B>()</CODE>
691 Retrieves an array containing all of the <code>Key</code> objects
692 associated with this <code>Server</code>, each of which are an abstract
693 representation of an actual AFS key of the AFS server.
696 <TR BGCOLOR="white" CLASS="TableRowColor">
697 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
698 <CODE>protected static int</CODE></FONT></TD>
699 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getKeysBegin(int)">getKeysBegin</A></B>(int serverHandle)</CODE>
702 Begin the process of getting the keys of a server. </TD>
704 <TR BGCOLOR="white" CLASS="TableRowColor">
705 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
706 <CODE>protected static void</CODE></FONT></TD>
707 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getKeysDone(int)">getKeysDone</A></B>(int iterationId)</CODE>
710 Signals that the iteration is complete and will not be accessed anymore.</TD>
712 <TR BGCOLOR="white" CLASS="TableRowColor">
713 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
714 <CODE>protected static int</CODE></FONT></TD>
715 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getKeysNext(int, org.openafs.jafs.Key)">getKeysNext</A></B>(int iterationId,
716 <A HREF="../../../org/openafs/jafs/Key.html">Key</A> theKey)</CODE>
719 Returns the next key of the server. </TD>
721 <TR BGCOLOR="white" CLASS="TableRowColor">
722 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
723 <CODE>protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
724 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getLog(int, java.lang.String)">getLog</A></B>(int serverHandle,
725 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> logLocation)</CODE>
728 Retrieves a specified bos log from a server. </TD>
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/lang/String.html">String</A></CODE></FONT></TD>
733 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getLog(java.lang.String)">getLog</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> logLocation)</CODE>
736 Gets the contents of a log file, in one large <code>String</code>.
739 <TR BGCOLOR="white" CLASS="TableRowColor">
740 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
741 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
742 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getName()">getName</A></B>()</CODE>
745 Returns the name of this server.</TD>
747 <TR BGCOLOR="white" CLASS="TableRowColor">
748 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
749 <CODE> <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A></CODE></FONT></TD>
750 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartition(java.lang.String)">getPartition</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name)</CODE>
753 Retrieves the <CODE>Partition</CODE> object (which is an abstract
754 representation of an actual AFS partition of this server) designated
755 by <code>name</code> (i.e. </TD>
757 <TR BGCOLOR="white" CLASS="TableRowColor">
758 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
759 <CODE> int</CODE></FONT></TD>
760 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartitionCount()">getPartitionCount</A></B>()</CODE>
763 Returns the number of partitions on this server.
767 <TR BGCOLOR="white" CLASS="TableRowColor">
768 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
769 <CODE>protected static int</CODE></FONT></TD>
770 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartitionCount(int, int)">getPartitionCount</A></B>(int cellHandle,
771 int serverHandle)</CODE>
774 Returns the total number of partitions hosted by the server denoted by
775 <CODE>serverHandle</CODE>, if the server is a fileserver.</TD>
777 <TR BGCOLOR="white" CLASS="TableRowColor">
778 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
779 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
780 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartitionNames()">getPartitionNames</A></B>()</CODE>
783 Retrieves an array containing all of the names of partitions
784 associated with this <code>Server</code> (i.e. </TD>
786 <TR BGCOLOR="white" CLASS="TableRowColor">
787 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
788 <CODE> <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>[]</CODE></FONT></TD>
789 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartitions()">getPartitions</A></B>()</CODE>
792 Retrieves an array containing all of the <code>Partition</code> objects
793 associated with this <code>Server</code>, each of which are an abstract
794 representation of an actual AFS partition of the AFS server.
797 <TR BGCOLOR="white" CLASS="TableRowColor">
798 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
799 <CODE>protected static int</CODE></FONT></TD>
800 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartitionsBegin(int, int)">getPartitionsBegin</A></B>(int cellHandle,
801 int serverHandle)</CODE>
804 Begin the process of getting the partitions on a server. </TD>
806 <TR BGCOLOR="white" CLASS="TableRowColor">
807 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
808 <CODE>protected static void</CODE></FONT></TD>
809 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartitionsDone(int)">getPartitionsDone</A></B>(int iterationId)</CODE>
812 Signals that the iteration is complete and will not be accessed anymore.</TD>
814 <TR BGCOLOR="white" CLASS="TableRowColor">
815 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
816 <CODE>protected static int</CODE></FONT></TD>
817 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartitionsNext(int, org.openafs.jafs.Partition)">getPartitionsNext</A></B>(int iterationId,
818 <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> thePartition)</CODE>
821 Fills the next partition object of the server. </TD>
823 <TR BGCOLOR="white" CLASS="TableRowColor">
824 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
825 <CODE>protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
826 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartitionsNextString(int)">getPartitionsNextString</A></B>(int iterationId)</CODE>
829 Returns the next partition of the server. </TD>
831 <TR BGCOLOR="white" CLASS="TableRowColor">
832 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
833 <CODE> <A HREF="../../../org/openafs/jafs/Process.html">Process</A></CODE></FONT></TD>
834 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcess(java.lang.String)">getProcess</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name)</CODE>
837 Retrieves the <CODE>Process</CODE> object (which is an abstract
838 representation of an actual AFS process of this server) designated
839 by <code>name</code> (i.e. </TD>
841 <TR BGCOLOR="white" CLASS="TableRowColor">
842 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
843 <CODE> int</CODE></FONT></TD>
844 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcessCount()">getProcessCount</A></B>()</CODE>
847 Returns the number of processes hosted by this server.
851 <TR BGCOLOR="white" CLASS="TableRowColor">
852 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
853 <CODE>protected static int</CODE></FONT></TD>
854 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcessCount(int)">getProcessCount</A></B>(int serverHandle)</CODE>
857 Returns the total number of processes hosted by the server denoted by
858 <CODE>serverHandle</CODE>.</TD>
860 <TR BGCOLOR="white" CLASS="TableRowColor">
861 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
862 <CODE> <A HREF="../../../org/openafs/jafs/Process.html">Process</A>[]</CODE></FONT></TD>
863 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcesses()">getProcesses</A></B>()</CODE>
866 Retrieves an array containing all of the <code>Process</code> objects
867 associated with this <code>Server</code>, each of which are an abstract
868 representation of an actual AFS process of the AFS server.
871 <TR BGCOLOR="white" CLASS="TableRowColor">
872 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
873 <CODE>protected static int</CODE></FONT></TD>
874 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcessesBegin(int)">getProcessesBegin</A></B>(int serverHandle)</CODE>
877 Begin the process of getting the processes on a server. </TD>
879 <TR BGCOLOR="white" CLASS="TableRowColor">
880 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
881 <CODE>protected static void</CODE></FONT></TD>
882 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcessesDone(int)">getProcessesDone</A></B>(int iterationId)</CODE>
885 Signals that the iteration is complete and will not be accessed anymore.</TD>
887 <TR BGCOLOR="white" CLASS="TableRowColor">
888 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
889 <CODE>protected static int</CODE></FONT></TD>
890 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcessesNext(int, int, org.openafs.jafs.Process)">getProcessesNext</A></B>(int serverHandle,
891 int iterationId,
892 <A HREF="../../../org/openafs/jafs/Process.html">Process</A> theProcess)</CODE>
895 Fills the next process object of the server. </TD>
897 <TR BGCOLOR="white" CLASS="TableRowColor">
898 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
899 <CODE>protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
900 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcessesNextString(int)">getProcessesNextString</A></B>(int iterationId)</CODE>
903 Returns the next process of the server. </TD>
905 <TR BGCOLOR="white" CLASS="TableRowColor">
906 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
907 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[]</CODE></FONT></TD>
908 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcessNames()">getProcessNames</A></B>()</CODE>
911 Retrieves an array containing all of the names of processes
912 associated with this <code>Server</code> (i.e. </TD>
914 <TR BGCOLOR="white" CLASS="TableRowColor">
915 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
916 <CODE>protected static void</CODE></FONT></TD>
917 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getServerInfo(int, java.lang.String, org.openafs.jafs.Server)">getServerInfo</A></B>(int cellHandle,
918 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name,
919 <A HREF="../../../org/openafs/jafs/Server.html">Server</A> server)</CODE>
922 Fills in the information fields of the provided <code>Server</code>.</TD>
924 <TR BGCOLOR="white" CLASS="TableRowColor">
925 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
926 <CODE> int</CODE></FONT></TD>
927 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getTotalFreeSpace()">getTotalFreeSpace</A></B>()</CODE>
930 Returns the total free space on this server (a sum of the free space of
931 all the partitions associated with this server). </TD>
933 <TR BGCOLOR="white" CLASS="TableRowColor">
934 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
935 <CODE> int</CODE></FONT></TD>
936 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getTotalSpace()">getTotalSpace</A></B>()</CODE>
939 Returns the total space on this server (a sum of the space of all the
940 partitions associated with this server). </TD>
942 <TR BGCOLOR="white" CLASS="TableRowColor">
943 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
944 <CODE> int</CODE></FONT></TD>
945 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getTotalUsedSpace()">getTotalUsedSpace</A></B>()</CODE>
948 Returns the total used space on this server (a sum of the used space of
949 all the partitions associated with this server). </TD>
951 <TR BGCOLOR="white" CLASS="TableRowColor">
952 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
953 <CODE>protected int</CODE></FONT></TD>
954 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getVosHandle()">getVosHandle</A></B>()</CODE>
957 Returns this server's vos handle.</TD>
959 <TR BGCOLOR="white" CLASS="TableRowColor">
960 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
961 <CODE>protected static int</CODE></FONT></TD>
962 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)">getVosServerHandle</A></B>(int cellHandle,
963 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> serverName)</CODE>
966 Opens a server for administrative vos use, based on the cell handle
969 <TR BGCOLOR="white" CLASS="TableRowColor">
970 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
971 <CODE> boolean</CODE></FONT></TD>
972 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#isBadDatabase()">isBadDatabase</A></B>()</CODE>
975 Returns whether or not this server is a database machine AND
976 either it isn't in reality (e.g. it's incorrectly configured)
977 or it's currently down.</TD>
979 <TR BGCOLOR="white" CLASS="TableRowColor">
980 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
981 <CODE> boolean</CODE></FONT></TD>
982 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#isBadFileServer()">isBadFileServer</A></B>()</CODE>
985 Returns whether this machine thinks it's a file server AND
986 either it isn't in reality (e.g. it's incorrectly configured)
987 or it's currently down.</TD>
989 <TR BGCOLOR="white" CLASS="TableRowColor">
990 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
991 <CODE> boolean</CODE></FONT></TD>
992 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#isDatabase()">isDatabase</A></B>()</CODE>
995 Returns whether or not this server is a database machine, meaning it runs
996 processes such as the "kaserver" and "vlserver", and participates in
999 <TR BGCOLOR="white" CLASS="TableRowColor">
1000 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1001 <CODE> boolean</CODE></FONT></TD>
1002 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#isFileServer()">isFileServer</A></B>()</CODE>
1005 Returns whether or not this server is a file server machine, meaning it
1006 runs the "fs" process and stores AFS volumes.</TD>
1008 <TR BGCOLOR="white" CLASS="TableRowColor">
1009 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1010 <CODE>protected static void</CODE></FONT></TD>
1011 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#reclaimServerMemory()">reclaimServerMemory</A></B>()</CODE>
1014 Reclaims all memory being saved by the server portion of the native
1017 <TR BGCOLOR="white" CLASS="TableRowColor">
1018 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1019 <CODE> void</CODE></FONT></TD>
1020 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refresh()">refresh</A></B>()</CODE>
1023 Refreshes the properties of this Server object instance with values
1024 from the AFS server it represents. </TD>
1026 <TR BGCOLOR="white" CLASS="TableRowColor">
1027 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1028 <CODE>protected void</CODE></FONT></TD>
1029 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refresh(boolean)">refresh</A></B>(boolean all)</CODE>
1032 Refreshes the properties of this Server object instance with values
1033 from the AFS server it represents. </TD>
1035 <TR BGCOLOR="white" CLASS="TableRowColor">
1036 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1037 <CODE>protected void</CODE></FONT></TD>
1038 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshAdminNames()">refreshAdminNames</A></B>()</CODE>
1041 Obtains the most current list of bos admin names of this server.</TD>
1043 <TR BGCOLOR="white" CLASS="TableRowColor">
1044 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1045 <CODE>protected void</CODE></FONT></TD>
1046 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshAdmins()">refreshAdmins</A></B>()</CODE>
1049 Obtains the most current list of admin <code>User</code> objects of
1052 <TR BGCOLOR="white" CLASS="TableRowColor">
1053 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1054 <CODE>protected void</CODE></FONT></TD>
1055 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshBinaryRestart()">refreshBinaryRestart</A></B>()</CODE>
1058 Refreshes the binary restart time fields of this <code>Server</code>
1059 to reflect the current state of the AFS server.</TD>
1061 <TR BGCOLOR="white" CLASS="TableRowColor">
1062 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1063 <CODE>protected void</CODE></FONT></TD>
1064 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshGeneralRestart()">refreshGeneralRestart</A></B>()</CODE>
1067 Refreshes the general restart time fields of this <code>Server</code>
1068 to reflect the current state of the AFS server.</TD>
1070 <TR BGCOLOR="white" CLASS="TableRowColor">
1071 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1072 <CODE>protected void</CODE></FONT></TD>
1073 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshInfo()">refreshInfo</A></B>()</CODE>
1076 Refreshes the information fields of this <code>Server</code> to
1077 reflect the current state of the AFS server. </TD>
1079 <TR BGCOLOR="white" CLASS="TableRowColor">
1080 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1081 <CODE>protected void</CODE></FONT></TD>
1082 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshKeys()">refreshKeys</A></B>()</CODE>
1085 Obtains the most current list of <code>Key</code> objects of this server.</TD>
1087 <TR BGCOLOR="white" CLASS="TableRowColor">
1088 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1089 <CODE>protected void</CODE></FONT></TD>
1090 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshPartitionNames()">refreshPartitionNames</A></B>()</CODE>
1093 Obtains the most current list of partition names of this server.</TD>
1095 <TR BGCOLOR="white" CLASS="TableRowColor">
1096 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1097 <CODE>protected void</CODE></FONT></TD>
1098 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshPartitions()">refreshPartitions</A></B>()</CODE>
1101 Obtains the most current list of <code>Partition</code> objects
1102 of this server.</TD>
1104 <TR BGCOLOR="white" CLASS="TableRowColor">
1105 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1106 <CODE>protected void</CODE></FONT></TD>
1107 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshPartitions(boolean)">refreshPartitions</A></B>(boolean refreshVolumes)</CODE>
1110 Obtains the most current list of <code>Partition</code> objects of
1113 <TR BGCOLOR="white" CLASS="TableRowColor">
1114 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1115 <CODE>protected void</CODE></FONT></TD>
1116 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshProcesses()">refreshProcesses</A></B>()</CODE>
1119 Obtains the most current list of <code>Process</code> objects of
1122 <TR BGCOLOR="white" CLASS="TableRowColor">
1123 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1124 <CODE>protected void</CODE></FONT></TD>
1125 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshProcessNames()">refreshProcessNames</A></B>()</CODE>
1128 Obtains the most current list of process names of this server.</TD>
1130 <TR BGCOLOR="white" CLASS="TableRowColor">
1131 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1132 <CODE> void</CODE></FONT></TD>
1133 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#removeAdmin(org.openafs.jafs.User)">removeAdmin</A></B>(<A HREF="../../../org/openafs/jafs/User.html">User</A> admin)</CODE>
1136 Remove a bos admin from the UserList file of this server, in order to
1137 take away from the AFS user represented by <code>admin</code> bos
1138 administrative privileges on this machine.</TD>
1140 <TR BGCOLOR="white" CLASS="TableRowColor">
1141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1142 <CODE>protected static void</CODE></FONT></TD>
1143 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#removeBosAdmin(int, java.lang.String)">removeBosAdmin</A></B>(int serverHandle,
1144 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> adminName)</CODE>
1147 Removes the given to name from the list of bos administrators on
1150 <TR BGCOLOR="white" CLASS="TableRowColor">
1151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1152 <CODE> void</CODE></FONT></TD>
1153 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#restartAllProcesses()">restartAllProcesses</A></B>()</CODE>
1156 Restarts all bos processes on this server.</TD>
1158 <TR BGCOLOR="white" CLASS="TableRowColor">
1159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1160 <CODE>protected static void</CODE></FONT></TD>
1161 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#restartAllProcesses(int, boolean)">restartAllProcesses</A></B>(int serverHandle,
1162 boolean restartBosServer)</CODE>
1165 Restart all server processes.</TD>
1167 <TR BGCOLOR="white" CLASS="TableRowColor">
1168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1169 <CODE> void</CODE></FONT></TD>
1170 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#restartBosServer()">restartBosServer</A></B>()</CODE>
1173 Restarts bos server and all bos processes on this server.</TD>
1175 <TR BGCOLOR="white" CLASS="TableRowColor">
1176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1177 <CODE> void</CODE></FONT></TD>
1178 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#salvage()">salvage</A></B>()</CODE>
1181 Salvages (restores consistency to) this server. </TD>
1183 <TR BGCOLOR="white" CLASS="TableRowColor">
1184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1185 <CODE>protected static void</CODE></FONT></TD>
1186 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#salvage(int, int, java.lang.String, java.lang.String, int, java.lang.String, java.lang.String, boolean, boolean, boolean, boolean, boolean, boolean)">salvage</A></B>(int cellHandle,
1187 int serverHandle,
1188 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> partitionName,
1189 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> volName,
1190 int numSalvagers,
1191 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> tempDir,
1192 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> logFile,
1193 boolean inspectAllVolumes,
1194 boolean removeBadlyDamaged,
1195 boolean writeInodes,
1196 boolean writeRootInodes,
1197 boolean forceDirectory,
1198 boolean forceBlockReads)</CODE>
1201 Salvages (restores consistency to) a volume, partition, or server</TD>
1203 <TR BGCOLOR="white" CLASS="TableRowColor">
1204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1205 <CODE> void</CODE></FONT></TD>
1206 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#setBinaryRestartTime(org.openafs.jafs.Server.ExecutableTime)">setBinaryRestartTime</A></B>(<A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A> executableTime)</CODE>
1209 Sets the BOS binary restart time. </TD>
1211 <TR BGCOLOR="white" CLASS="TableRowColor">
1212 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1213 <CODE> void</CODE></FONT></TD>
1214 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#setGeneralRestartTime(org.openafs.jafs.Server.ExecutableTime)">setGeneralRestartTime</A></B>(<A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A> executableTime)</CODE>
1217 Sets the BOS general restart time. </TD>
1219 <TR BGCOLOR="white" CLASS="TableRowColor">
1220 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1221 <CODE> void</CODE></FONT></TD>
1222 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#startAllProcesses()">startAllProcesses</A></B>()</CODE>
1225 Starts up all bos processes on this server.</TD>
1227 <TR BGCOLOR="white" CLASS="TableRowColor">
1228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1229 <CODE>protected static void</CODE></FONT></TD>
1230 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#startAllProcesses(int)">startAllProcesses</A></B>(int serverHandle)</CODE>
1233 Start all server processes.</TD>
1235 <TR BGCOLOR="white" CLASS="TableRowColor">
1236 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1237 <CODE> void</CODE></FONT></TD>
1238 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#stopAllProcesses()">stopAllProcesses</A></B>()</CODE>
1241 Stops all bos processes on this server.</TD>
1243 <TR BGCOLOR="white" CLASS="TableRowColor">
1244 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1245 <CODE>protected static void</CODE></FONT></TD>
1246 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#stopAllProcesses(int)">stopAllProcesses</A></B>(int serverHandle)</CODE>
1249 Stop all server processes.</TD>
1251 <TR BGCOLOR="white" CLASS="TableRowColor">
1252 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1253 <CODE> void</CODE></FONT></TD>
1254 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#syncServer()">syncServer</A></B>()</CODE>
1257 Syncs this server to the VLDB.</TD>
1259 <TR BGCOLOR="white" CLASS="TableRowColor">
1260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1261 <CODE>protected static void</CODE></FONT></TD>
1262 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#syncServerWithVLDB(int, int, int)">syncServerWithVLDB</A></B>(int cellHandle,
1263 int serverHandle,
1264 int partition)</CODE>
1267 Synchronizes a particular server with the volume location database.</TD>
1269 <TR BGCOLOR="white" CLASS="TableRowColor">
1270 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1271 <CODE> void</CODE></FONT></TD>
1272 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#syncVLDB()">syncVLDB</A></B>()</CODE>
1275 Syncs the VLDB to this server.</TD>
1277 <TR BGCOLOR="white" CLASS="TableRowColor">
1278 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1279 <CODE>protected static void</CODE></FONT></TD>
1280 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#syncVLDBWithServer(int, int, int, boolean)">syncVLDBWithServer</A></B>(int cellHandle,
1281 int serverHandle,
1283 boolean forceDeletion)</CODE>
1286 Synchronizes the volume location database with a particular server.</TD>
1288 <TR BGCOLOR="white" CLASS="TableRowColor">
1289 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1290 <CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
1291 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#toString()">toString</A></B>()</CODE>
1294 Returns the name of this <CODE>Server</CODE></TD>
1297 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
1298 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1299 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
1300 <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>
1302 <TR BGCOLOR="white" CLASS="TableRowColor">
1303 <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>
1309 <!-- ============ FIELD DETAIL =========== -->
1311 <A NAME="field_detail"><!-- --></A>
1312 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1313 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1314 <TD COLSPAN=1><FONT SIZE="+2">
1315 <B>Field Detail</B></FONT></TD>
1319 <A NAME="name"><!-- --></A><H3>
1322 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>name</B></PRE>
1329 <A NAME="cell"><!-- --></A><H3>
1332 protected <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> <B>cell</B></PRE>
1339 <A NAME="vosHandle"><!-- --></A><H3>
1342 protected int <B>vosHandle</B></PRE>
1349 <A NAME="bosHandle"><!-- --></A><H3>
1352 protected int <B>bosHandle</B></PRE>
1359 <A NAME="database"><!-- --></A><H3>
1362 protected boolean <B>database</B></PRE>
1369 <A NAME="fileServer"><!-- --></A><H3>
1372 protected boolean <B>fileServer</B></PRE>
1379 <A NAME="badFileServer"><!-- --></A><H3>
1382 protected boolean <B>badFileServer</B></PRE>
1389 <A NAME="badDatabase"><!-- --></A><H3>
1392 protected boolean <B>badDatabase</B></PRE>
1399 <A NAME="ipAddresses"><!-- --></A><H3>
1402 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[] <B>ipAddresses</B></PRE>
1409 <A NAME="partitionNames"><!-- --></A><H3>
1412 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>partitionNames</B></PRE>
1419 <A NAME="partitions"><!-- --></A><H3>
1422 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>partitions</B></PRE>
1429 <A NAME="adminNames"><!-- --></A><H3>
1432 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>adminNames</B></PRE>
1439 <A NAME="admins"><!-- --></A><H3>
1442 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>admins</B></PRE>
1449 <A NAME="keys"><!-- --></A><H3>
1452 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>keys</B></PRE>
1459 <A NAME="processNames"><!-- --></A><H3>
1462 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>processNames</B></PRE>
1469 <A NAME="processes"><!-- --></A><H3>
1472 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>processes</B></PRE>
1479 <A NAME="totalSpace"><!-- --></A><H3>
1482 protected int <B>totalSpace</B></PRE>
1489 <A NAME="totalQuota"><!-- --></A><H3>
1492 protected int <B>totalQuota</B></PRE>
1499 <A NAME="totalFreeSpace"><!-- --></A><H3>
1502 protected int <B>totalFreeSpace</B></PRE>
1509 <A NAME="totalUsedSpace"><!-- --></A><H3>
1512 protected int <B>totalUsedSpace</B></PRE>
1519 <A NAME="genRestartTime"><!-- --></A><H3>
1522 protected <A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A> <B>genRestartTime</B></PRE>
1529 <A NAME="binRestartTime"><!-- --></A><H3>
1532 protected <A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A> <B>binRestartTime</B></PRE>
1539 <A NAME="cachedInfo"><!-- --></A><H3>
1542 protected boolean <B>cachedInfo</B></PRE>
1548 <!-- ========= CONSTRUCTOR DETAIL ======== -->
1550 <A NAME="constructor_detail"><!-- --></A>
1551 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1552 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1553 <TD COLSPAN=1><FONT SIZE="+2">
1554 <B>Constructor Detail</B></FONT></TD>
1558 <A NAME="Server(java.lang.String, org.openafs.jafs.Cell)"><!-- --></A><H3>
1561 public <B>Server</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name,
1562 <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> cell)
1563 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1565 <DD>Constructs a new <CODE>Server</CODE> object instance given the
1566 name of the AFS server and the AFS cell, represented by
1567 <CODE>cell</CODE>, to which it belongs. This does not actually
1568 create a new AFS server, it just represents an existing one.
1569 If <code>name</code> is not an actual AFS server, exceptions
1570 will be thrown during subsequent method invocations on this
1573 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the server to represent<DD><CODE>cell</CODE> - the cell to which the server belongs.
1575 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1578 <A NAME="Server(java.lang.String, org.openafs.jafs.Cell, boolean)"><!-- --></A><H3>
1581 public <B>Server</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name,
1582 <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> cell,
1583 boolean preloadAllMembers)
1584 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1586 <DD>Constructs a new <CODE>Server</CODE> object instance given the name
1587 of the AFS server and the AFS cell, represented by <CODE>cell</CODE>,
1588 to which it belongs. This does not actually
1589 create a new AFS server, it just represents an existing one.
1590 If <code>name</code> is not an actual AFS server, exceptions
1591 will be thrown during subsequent method invocations on this
1594 <P> This constructor is ideal for point-in-time representation and
1595 transient applications. It ensures all data member values are set
1596 and available without calling back to the filesystem at the first
1597 request for them. Use the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method to address any
1600 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the server to represent<DD><CODE>cell</CODE> - the cell to which the server belongs.<DD><CODE>preloadAllMembers</CODE> - true will ensure all object members are
1601 set upon construction;
1602 otherwise members will be set upon access,
1603 which is the default behavior.
1605 <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#refresh()"><CODE>refresh()</CODE></A></DL>
1608 <A NAME="Server(org.openafs.jafs.Cell)"><!-- --></A><H3>
1611 <B>Server</B>(<A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> cell)
1612 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1614 <DD>Constructs a blank <code>Server</code> object instance given the cell to
1615 which the server belongs. This blank object can then be passed into
1616 other methods to fill out its properties.
1618 <DT><B>Parameters:</B><DD><CODE>cell</CODE> - the cell to which the server belongs.
1620 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1622 <!-- ============ METHOD DETAIL ========== -->
1624 <A NAME="method_detail"><!-- --></A>
1625 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
1626 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1627 <TD COLSPAN=1><FONT SIZE="+2">
1628 <B>Method Detail</B></FONT></TD>
1632 <A NAME="refresh()"><!-- --></A><H3>
1635 public void <B>refresh</B>()
1636 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1638 <DD>Refreshes the properties of this Server object instance with values
1639 from the AFS server it represents. All properties that have been
1640 initialized and/or accessed will be renewed according to the values
1641 of the AFS server this Server object instance represents.
1643 <P>Since in most environments administrative changes can be administered
1644 from an AFS command-line program or an alternate GUI application, this
1645 method provides a means to refresh the Java object representation and
1646 thereby ascertain any possible modifications that may have been made
1647 from such alternate administrative programs. Using this method before
1648 an associated instance accessor will ensure the highest level of
1649 representative accuracy, accommodating changes made external to the
1650 Java application space. If administrative changes to the underlying AFS
1651 system are only allowed via this API, then the use of this method is
1660 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1665 <A NAME="refresh(boolean)"><!-- --></A><H3>
1668 protected void <B>refresh</B>(boolean all)
1669 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1671 <DD>Refreshes the properties of this Server object instance with values
1672 from the AFS server it represents. If <CODE>all</CODE> is
1673 <CODE>true</CODE> then <U>all</U> of the properties of this Server
1674 object instance will be set, or renewed, according to the values of the
1675 AFS server it represents, disregarding any previously set properties.
1677 <P> Thus, if <CODE>all</CODE> is <CODE>false</CODE> then properties that
1678 are currently set will be refreshed and properties that are not set
1679 will remain uninitialized.
1680 See <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> for more information.
1686 <DT><B>Parameters:</B><DD><CODE>all</CODE> - if true set or renew all object properties;
1687 otherwise renew all set properties
1689 <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#refresh()"><CODE>refresh()</CODE></A></DL>
1694 <A NAME="refreshInfo()"><!-- --></A><H3>
1697 protected void <B>refreshInfo</B>()
1698 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1700 <DD>Refreshes the information fields of this <code>Server</code> to
1701 reflect the current state of the AFS server. These fields include
1702 the IP addresses and the fileserver types.
1710 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1715 <A NAME="refreshGeneralRestart()"><!-- --></A><H3>
1716 refreshGeneralRestart</H3>
1718 protected void <B>refreshGeneralRestart</B>()
1719 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1721 <DD>Refreshes the general restart time fields of this <code>Server</code>
1722 to reflect the current state of the AFS server.
1730 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1735 <A NAME="refreshBinaryRestart()"><!-- --></A><H3>
1736 refreshBinaryRestart</H3>
1738 protected void <B>refreshBinaryRestart</B>()
1739 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1741 <DD>Refreshes the binary restart time fields of this <code>Server</code>
1742 to reflect the current state of the AFS server.
1750 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1755 <A NAME="refreshPartitions()"><!-- --></A><H3>
1756 refreshPartitions</H3>
1758 protected void <B>refreshPartitions</B>()
1759 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1761 <DD>Obtains the most current list of <code>Partition</code> objects
1770 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1775 <A NAME="refreshPartitions(boolean)"><!-- --></A><H3>
1776 refreshPartitions</H3>
1778 protected void <B>refreshPartitions</B>(boolean refreshVolumes)
1779 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1781 <DD>Obtains the most current list of <code>Partition</code> objects of
1788 <DT><B>Parameters:</B><DD><CODE>refreshVolumes</CODE> - force all volumes contained in each
1789 partition to be refreshed.
1791 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1796 <A NAME="refreshPartitionNames()"><!-- --></A><H3>
1797 refreshPartitionNames</H3>
1799 protected void <B>refreshPartitionNames</B>()
1800 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1802 <DD>Obtains the most current list of partition names of this server.
1810 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1815 <A NAME="refreshAdminNames()"><!-- --></A><H3>
1816 refreshAdminNames</H3>
1818 protected void <B>refreshAdminNames</B>()
1819 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1821 <DD>Obtains the most current list of bos admin names of this server.
1829 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1834 <A NAME="refreshAdmins()"><!-- --></A><H3>
1837 protected void <B>refreshAdmins</B>()
1838 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1840 <DD>Obtains the most current list of admin <code>User</code> objects of
1849 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1854 <A NAME="refreshKeys()"><!-- --></A><H3>
1857 protected void <B>refreshKeys</B>()
1858 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1860 <DD>Obtains the most current list of <code>Key</code> objects of this server.
1868 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1873 <A NAME="refreshProcessNames()"><!-- --></A><H3>
1874 refreshProcessNames</H3>
1876 protected void <B>refreshProcessNames</B>()
1877 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1879 <DD>Obtains the most current list of process names of this server.
1887 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1892 <A NAME="refreshProcesses()"><!-- --></A><H3>
1893 refreshProcesses</H3>
1895 protected void <B>refreshProcesses</B>()
1896 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1898 <DD>Obtains the most current list of <code>Process</code> objects of
1907 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1912 <A NAME="addAdmin(org.openafs.jafs.User)"><!-- --></A><H3>
1915 public void <B>addAdmin</B>(<A HREF="../../../org/openafs/jafs/User.html">User</A> admin)
1916 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1918 <DD>Add a bos admin to the UserList file of this server, in order to
1919 given the AFS user represented by <code>admin</code> full bos
1920 administrative privileges on this server.
1926 <DT><B>Parameters:</B><DD><CODE>admin</CODE> - the admin to add
1928 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1933 <A NAME="removeAdmin(org.openafs.jafs.User)"><!-- --></A><H3>
1936 public void <B>removeAdmin</B>(<A HREF="../../../org/openafs/jafs/User.html">User</A> admin)
1937 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1939 <DD>Remove a bos admin from the UserList file of this server, in order to
1940 take away from the AFS user represented by <code>admin</code> bos
1941 administrative privileges on this machine.
1947 <DT><B>Parameters:</B><DD><CODE>admin</CODE> - the admin to remove
1949 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1954 <A NAME="syncServer()"><!-- --></A><H3>
1957 public void <B>syncServer</B>()
1958 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1960 <DD>Syncs this server to the VLDB.
1968 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1973 <A NAME="syncVLDB()"><!-- --></A><H3>
1976 public void <B>syncVLDB</B>()
1977 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1979 <DD>Syncs the VLDB to this server.
1987 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1992 <A NAME="salvage()"><!-- --></A><H3>
1995 public void <B>salvage</B>()
1996 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1998 <DD>Salvages (restores consistency to) this server. Uses default values for
1999 most salvager options in order to simplify the API.
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="startAllProcesses()"><!-- --></A><H3>
2013 startAllProcesses</H3>
2015 public void <B>startAllProcesses</B>()
2016 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2018 <DD>Starts up all bos processes on this server.
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="stopAllProcesses()"><!-- --></A><H3>
2032 stopAllProcesses</H3>
2034 public void <B>stopAllProcesses</B>()
2035 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2037 <DD>Stops all bos processes on this server.
2045 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2050 <A NAME="restartAllProcesses()"><!-- --></A><H3>
2051 restartAllProcesses</H3>
2053 public void <B>restartAllProcesses</B>()
2054 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2056 <DD>Restarts all bos processes on this server.
2064 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2069 <A NAME="restartBosServer()"><!-- --></A><H3>
2070 restartBosServer</H3>
2072 public void <B>restartBosServer</B>()
2073 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2075 <DD>Restarts bos server and all bos processes on this server.
2083 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2088 <A NAME="getLog(java.lang.String)"><!-- --></A><H3>
2091 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getLog</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> logLocation)
2092 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2094 <DD>Gets the contents of a log file, in one large <code>String</code>.
2095 The log cannot be in AFS file space.
2102 <DT><B>Returns:</B><DD>a <code>String</code> containing the contents of the log file
2104 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2109 <A NAME="close()"><!-- --></A><H3>
2112 public void <B>close</B>()
2113 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2115 <DD>Unauthenticates all server-related tokens that have been obtained by
2116 this <code>Server</code> object, and shuts this server object down.
2117 This method should only be called when this <code>Server</code> or any
2118 of the objects constructed using this <code>Server</code> will not be
2119 used anymore. Note that this does not effect the actual AFS server;
2120 it merely closes the representation.
2128 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2133 <A NAME="getName()"><!-- --></A><H3>
2136 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>
2138 <DD>Returns the name of this server.
2145 <DT><B>Returns:</B><DD>the name of this server</DL>
2150 <A NAME="getCell()"><!-- --></A><H3>
2153 public <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> <B>getCell</B>()</PRE>
2155 <DD>Returns the <code>Cell</code> object with which this <code>Server</code>
2156 was constructed. It represents the actual AFS cell to which this
2164 <DT><B>Returns:</B><DD>this server's cell</DL>
2169 <A NAME="getAdminCount()"><!-- --></A><H3>
2172 public int <B>getAdminCount</B>()
2173 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2175 <DD>Returns the number of BOS administrators assigned to this server.
2177 <P>If the total list of admins or admin names have already been
2178 collected (see <A HREF="../../../org/openafs/jafs/Server.html#getAdmins()"><CODE>getAdmins()</CODE></A>), then the returning value will
2179 be calculated based upon the current list. Otherwise, AFS will be
2180 explicitly queried for the information.
2182 <P> The product of this method is not saved, and is recalculated
2190 <DT><B>Returns:</B><DD>the number of admins on this server.
2192 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs
2193 in any of the associated native methods<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Server.html#getAdmins()"><CODE>getAdmins()</CODE></A>,
2194 <A HREF="../../../org/openafs/jafs/Server.html#getAdminNames()"><CODE>getAdminNames()</CODE></A></DL>
2199 <A NAME="getAdmins()"><!-- --></A><H3>
2202 public <A HREF="../../../org/openafs/jafs/User.html">User</A>[] <B>getAdmins</B>()
2203 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2205 <DD>Retrieves an array containing all of the admin <code>User</code> objects
2206 associated with this <code>Server</code>, each of which are an abstract
2207 representation of an actual bos administrator of the AFS server.
2208 After this method is called once, it saves the array of
2209 <code>User</code>s and returns that saved array on subsequent calls,
2210 until the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current list
2218 <DT><B>Returns:</B><DD>a <code>User</code> array of the admins of the server.
2220 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2225 <A NAME="getAdminNames()"><!-- --></A><H3>
2228 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[] <B>getAdminNames</B>()
2229 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2231 <DD>Retrieves an array containing all of the names of bos admins
2232 associated with this <code>Server</code>. After this method
2233 is called once, it saves the array of <code>String</code>s and returns
2234 that saved array on subsequent calls, until the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method
2235 is called and a more current list is obtained.
2242 <DT><B>Returns:</B><DD>a <code>String</code> array of the bos admin of the server.
2244 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2249 <A NAME="getPartitionCount()"><!-- --></A><H3>
2250 getPartitionCount</H3>
2252 public int <B>getPartitionCount</B>()
2253 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2255 <DD>Returns the number of partitions on this server.
2257 <P>If the total list of partitions or partition names have already been
2258 collected (see <A HREF="../../../org/openafs/jafs/Server.html#getPartitions()"><CODE>getPartitions()</CODE></A>), then the returning value will
2259 be calculated based upon the current list. Otherwise, AFS will be
2260 explicitly queried for the information.
2262 <P> The product of this method is not saved, and is recalculated
2270 <DT><B>Returns:</B><DD>the number of partitions on this server.
2272 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs
2273 in any of the associated native methods<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Server.html#getPartitions()"><CODE>getPartitions()</CODE></A>,
2274 <A HREF="../../../org/openafs/jafs/Server.html#getPartitionNames()"><CODE>getPartitionNames()</CODE></A></DL>
2279 <A NAME="getPartition(java.lang.String)"><!-- --></A><H3>
2282 public <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> <B>getPartition</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name)
2283 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2285 <DD>Retrieves the <CODE>Partition</CODE> object (which is an abstract
2286 representation of an actual AFS partition of this server) designated
2287 by <code>name</code> (i.e. "/vicepa", etc.). If a partition by
2288 that name does not actually exist in AFS on the server
2289 represented by this object, an <A HREF="../../../org/openafs/jafs/AFSException.html"><CODE>AFSException</CODE></A> will be
2296 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the partition to retrieve
2297 <DT><B>Returns:</B><DD><CODE>Partition</CODE> designated by <code>name</code>.
2299 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code
2300 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/NullPointerException.html">NullPointerException</A></CODE> - If <CODE>name</CODE> is
2301 <CODE>null</CODE>.</DL>
2306 <A NAME="getPartitions()"><!-- --></A><H3>
2309 public <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>[] <B>getPartitions</B>()
2310 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2312 <DD>Retrieves an array containing all of the <code>Partition</code> objects
2313 associated with this <code>Server</code>, each of which are an abstract
2314 representation of an actual AFS partition of the AFS server.
2315 After this method is called once, it saves the array of
2316 <code>Partition</code>s and returns that saved array on subsequent calls,
2317 until the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current list
2325 <DT><B>Returns:</B><DD>a <code>Partition</code> array of the <code>Partition</code>
2326 objects of the server.
2328 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2333 <A NAME="getPartitionNames()"><!-- --></A><H3>
2334 getPartitionNames</H3>
2336 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[] <B>getPartitionNames</B>()
2337 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2339 <DD>Retrieves an array containing all of the names of partitions
2340 associated with this <code>Server</code> (i.e. "vicepa", etc.).
2341 After this method is called once, it saves the array of
2342 <code>String</code>s and returns that saved array on subsequent calls,
2343 until the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current
2351 <DT><B>Returns:</B><DD>a <code>String</code> array of the partitions of the server.
2353 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2358 <A NAME="getKey(int)"><!-- --></A><H3>
2361 public <A HREF="../../../org/openafs/jafs/Key.html">Key</A> <B>getKey</B>(int keyVersion)
2362 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2364 <DD>Retrieves the <CODE>Key</CODE> object (which is an abstract
2365 representation of an actual AFS partition of this server) designated
2366 by <code>nkeyVersion</code>. If a key with
2367 that version does not actually exist in AFS on the server
2368 represented by this object, <code>null</code> is returned.
2374 <DT><B>Parameters:</B><DD><CODE>keyVersion</CODE> - the version of the key to retrieve
2375 <DT><B>Returns:</B><DD><CODE>Key</CODE> designated by <code>keyVersion</code>.
2377 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2382 <A NAME="getKeyCount()"><!-- --></A><H3>
2385 public int <B>getKeyCount</B>()
2386 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2388 <DD>Returns the number of keys on this server.
2390 <P>If the total list of keys has already been
2391 collected (see <A HREF="../../../org/openafs/jafs/Server.html#getKeys()"><CODE>getKeys()</CODE></A>), then the returning value will
2392 be calculated based upon the current list. Otherwise, AFS will be
2393 explicitly queried for the information.
2395 <P> The product of this method is not saved, and is recalculated
2403 <DT><B>Returns:</B><DD>the number of keys on this server.
2405 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs
2406 in any of the associated native methods<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Server.html#getKeys()"><CODE>getKeys()</CODE></A></DL>
2411 <A NAME="getKeys()"><!-- --></A><H3>
2414 public <A HREF="../../../org/openafs/jafs/Key.html">Key</A>[] <B>getKeys</B>()
2415 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2417 <DD>Retrieves an array containing all of the <code>Key</code> objects
2418 associated with this <code>Server</code>, each of which are an abstract
2419 representation of an actual AFS key of the AFS server.
2420 After this method is called once, it saves the array of
2421 <code>Key</code>s and returns that saved array on subsequent calls,
2422 until the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current list
2430 <DT><B>Returns:</B><DD>a <code>Key</code> array of the <code>Key</code> objects
2433 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2438 <A NAME="getProcess(java.lang.String)"><!-- --></A><H3>
2441 public <A HREF="../../../org/openafs/jafs/Process.html">Process</A> <B>getProcess</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name)
2442 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2444 <DD>Retrieves the <CODE>Process</CODE> object (which is an abstract
2445 representation of an actual AFS process of this server) designated
2446 by <code>name</code> (i.e. "kaserver", etc.). If a process by
2447 that name does not actually exist in AFS on the server
2448 represented by this object, an <A HREF="../../../org/openafs/jafs/AFSException.html"><CODE>AFSException</CODE></A> will be
2455 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the process to retrieve
2456 <DT><B>Returns:</B><DD><CODE>Process</CODE> designated by <code>name</code>.
2458 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code
2459 <DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/NullPointerException.html">NullPointerException</A></CODE> - If <CODE>name</CODE> is
2460 <CODE>null</CODE>.</DL>
2465 <A NAME="getProcessCount()"><!-- --></A><H3>
2466 getProcessCount</H3>
2468 public int <B>getProcessCount</B>()
2469 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2471 <DD>Returns the number of processes hosted by this server.
2473 <P>If the total list of processes or process names have already been
2474 collected (see <A HREF="../../../org/openafs/jafs/Server.html#getProcesses()"><CODE>getProcesses()</CODE></A>), then the returning value will
2475 be calculated based upon the current list. Otherwise, AFS will be
2476 explicitly queried for the information.
2478 <P> The product of this method is not saved, and is recalculated
2486 <DT><B>Returns:</B><DD>the number of processes on this server.
2488 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs
2489 in any of the associated native methods<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Server.html#getProcesses()"><CODE>getProcesses()</CODE></A>,
2490 <A HREF="../../../org/openafs/jafs/Server.html#getProcessNames()"><CODE>getProcessNames()</CODE></A></DL>
2495 <A NAME="getProcesses()"><!-- --></A><H3>
2498 public <A HREF="../../../org/openafs/jafs/Process.html">Process</A>[] <B>getProcesses</B>()
2499 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2501 <DD>Retrieves an array containing all of the <code>Process</code> objects
2502 associated with this <code>Server</code>, each of which are an abstract
2503 representation of an actual AFS process of the AFS server.
2504 After this method is called once, it saves the array of
2505 <code>Process</code>es and returns that saved array on subsequent calls,
2506 until the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current list
2514 <DT><B>Returns:</B><DD>a <code>Process</code> array of the <code>Process</code>
2515 objects of the server.
2517 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2522 <A NAME="getProcessNames()"><!-- --></A><H3>
2523 getProcessNames</H3>
2525 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[] <B>getProcessNames</B>()
2526 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2528 <DD>Retrieves an array containing all of the names of processes
2529 associated with this <code>Server</code> (i.e. "kaserver", etc.).
2530 After this method is called once, it saves the array of
2531 <code>String</code>s and returns that saved array on subsequent calls,
2532 until the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method is called and a more current
2540 <DT><B>Returns:</B><DD>a <code>String</code> array of the processes of the server.
2542 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2547 <A NAME="isDatabase()"><!-- --></A><H3>
2550 public boolean <B>isDatabase</B>()
2551 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2553 <DD>Returns whether or not this server is a database machine, meaning it runs
2554 processes such as the "kaserver" and "vlserver", and participates in
2562 <DT><B>Returns:</B><DD>whether or not this user this server is a database machine.
2564 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2569 <A NAME="isFileServer()"><!-- --></A><H3>
2572 public boolean <B>isFileServer</B>()
2573 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2575 <DD>Returns whether or not this server is a file server machine, meaning it
2576 runs the "fs" process and stores AFS volumes.
2583 <DT><B>Returns:</B><DD>whether or not this user this server is a file server machine.
2585 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2590 <A NAME="isBadDatabase()"><!-- --></A><H3>
2593 public boolean <B>isBadDatabase</B>()
2594 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2596 <DD>Returns whether or not this server is a database machine AND
2597 either it isn't in reality (e.g. it's incorrectly configured)
2598 or it's currently down.
2605 <DT><B>Returns:</B><DD>whether or not this server is a database machine
2606 AND either it isn't in reality or it's currently down
2608 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2613 <A NAME="isBadFileServer()"><!-- --></A><H3>
2614 isBadFileServer</H3>
2616 public boolean <B>isBadFileServer</B>()
2617 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2619 <DD>Returns whether this machine thinks it's a file server AND
2620 either it isn't in reality (e.g. it's incorrectly configured)
2621 or it's currently down.
2628 <DT><B>Returns:</B><DD>whether or not this server is a file server machine AND
2629 either it isn't in reality or it's currently down
2631 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2636 <A NAME="getIPAddresses()"><!-- --></A><H3>
2639 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[] <B>getIPAddresses</B>()
2640 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2642 <DD>Returns this server's IP address as a String. It returns it in
2643 dotted quad notation (i.e. 123.123.123.123).
2650 <DT><B>Returns:</B><DD>this server's IP address as a String
2652 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2657 <A NAME="getGeneralRestartTime()"><!-- --></A><H3>
2658 getGeneralRestartTime</H3>
2660 public <A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A> <B>getGeneralRestartTime</B>()
2661 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2663 <DD>Returns the BOS Server's general restart time in the form of an
2664 ExecutableTime object. This is the time at which the bos server
2665 restarts itself and all running processes. After this method
2666 is called once, it saves the time and returns
2667 that value on subsequent calls, until the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method
2668 is called and a more current value is obtained.
2675 <DT><B>Returns:</B><DD>the general restart time
2677 <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.ExecutableTime.html"><CODE>Server.ExecutableTime</CODE></A>,
2678 <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A></DL>
2683 <A NAME="getBinaryRestartTime()"><!-- --></A><H3>
2684 getBinaryRestartTime</H3>
2686 public <A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A> <B>getBinaryRestartTime</B>()
2687 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2689 <DD>Returns the BOS Server's binary restart time in the form of an
2690 ExecutableTime object. This is the time at which all new or newly
2691 modified AFS binaries are restarted. After this method
2692 is called once, it saves the time and returns
2693 that value on subsequent calls, until the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method
2694 is called and a more current value is obtained.
2701 <DT><B>Returns:</B><DD>the binary restart time
2703 <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.ExecutableTime.html"><CODE>Server.ExecutableTime</CODE></A>,
2704 <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A></DL>
2709 <A NAME="getTotalSpace()"><!-- --></A><H3>
2712 public int <B>getTotalSpace</B>()
2713 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2715 <DD>Returns the total space on this server (a sum of the space of all the
2716 partitions associated with this server). If this server is not a
2717 file server, zero will be returned. After this method
2718 is called once, it saves the total space and returns
2719 that value on subsequent calls, until the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method
2720 is called and a more current value is obtained.
2727 <DT><B>Returns:</B><DD>the total space on this server
2729 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2734 <A NAME="getTotalFreeSpace()"><!-- --></A><H3>
2735 getTotalFreeSpace</H3>
2737 public int <B>getTotalFreeSpace</B>()
2738 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2740 <DD>Returns the total free space on this server (a sum of the free space of
2741 all the partitions associated with this server). If this server is not a
2742 file server, zero will be returned. After this method
2743 is called once, it saves the total free space and returns
2744 that value on subsequent calls, until the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method
2745 is called and a more current value is obtained.
2752 <DT><B>Returns:</B><DD>the total free space on this server
2754 <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#refresh()"><CODE>refresh()</CODE></A></DL>
2759 <A NAME="getTotalUsedSpace()"><!-- --></A><H3>
2760 getTotalUsedSpace</H3>
2762 public int <B>getTotalUsedSpace</B>()
2763 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2765 <DD>Returns the total used space on this server (a sum of the used space of
2766 all the partitions associated with this server). If this server is not a
2767 file server, zero will be returned. After this method
2768 is called once, it saves the total used space and returns
2769 that value on subsequent calls, until the <A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A> method
2770 is called and a more current value is obtained.
2777 <DT><B>Returns:</B><DD>the total space on this partition
2779 <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#getTotalSpace()"><CODE>getTotalSpace()</CODE></A>,
2780 <A HREF="../../../org/openafs/jafs/Server.html#getTotalFreeSpace()"><CODE>getTotalFreeSpace()</CODE></A></DL>
2785 <A NAME="getVosHandle()"><!-- --></A><H3>
2788 protected int <B>getVosHandle</B>()
2789 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2791 <DD>Returns this server's vos handle.
2798 <DT><B>Returns:</B><DD>this server's vos handle
2800 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2805 <A NAME="getBosHandle()"><!-- --></A><H3>
2808 protected int <B>getBosHandle</B>()
2809 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2811 <DD>Returns this server's bos handle.
2818 <DT><B>Returns:</B><DD>this server's bos handle
2820 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2825 <A NAME="setGeneralRestartTime(org.openafs.jafs.Server.ExecutableTime)"><!-- --></A><H3>
2826 setGeneralRestartTime</H3>
2828 public void <B>setGeneralRestartTime</B>(<A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A> executableTime)
2829 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2831 <DD>Sets the BOS general restart time. This is the time at which the bos
2832 server restarts itself and all running processes.
2838 <DT><B>Parameters:</B><DD><CODE>executableTime</CODE> - Executable time object that represents what
2839 the BOS Server's general restart time should be.
2841 <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.ExecutableTime.html"><CODE>Server.ExecutableTime</CODE></A></DL>
2846 <A NAME="setBinaryRestartTime(org.openafs.jafs.Server.ExecutableTime)"><!-- --></A><H3>
2847 setBinaryRestartTime</H3>
2849 public void <B>setBinaryRestartTime</B>(<A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A> executableTime)
2850 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2852 <DD>Sets the BOS binary restart time. This is the time at which all new
2853 or newly modified AFS binaries are restarted.
2859 <DT><B>Parameters:</B><DD><CODE>executableTime</CODE> - Executable time object that represents what
2860 the BOS Server's binary restart time should be.
2862 <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.ExecutableTime.html"><CODE>Server.ExecutableTime</CODE></A></DL>
2867 <A NAME="getInfo()"><!-- --></A><H3>
2870 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getInfo</B>()</PRE>
2872 <DD>Returns a <code>String</code> representation of this <code>Server</code>.
2873 Contains the information fields and a list of partitions, admin, and
2881 <DT><B>Returns:</B><DD>a <code>String</code> representation of the <code>Server</code></DL>
2886 <A NAME="getInfoPartitions()"><!-- --></A><H3>
2887 getInfoPartitions</H3>
2889 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getInfoPartitions</B>()
2890 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2892 <DD>Returns a <code>String</code> containing the <code>String</code>
2893 representations of all the partitions of this <code>Server</code>.
2900 <DT><B>Returns:</B><DD>a <code>String</code> representation of the partitions
2901 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Partition.html#getInfo()"><CODE>Partition.getInfo()</CODE></A></DL>
2906 <A NAME="getInfoKeys()"><!-- --></A><H3>
2909 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getInfoKeys</B>()
2910 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2912 <DD>Returns a <code>String</code> containing the <code>String</code>
2913 representations of all the keys of this <code>Server</code>.
2920 <DT><B>Returns:</B><DD>a <code>String</code> representation of the keys
2921 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Key.html#getInfo()"><CODE>Key.getInfo()</CODE></A></DL>
2926 <A NAME="getInfoProcesses()"><!-- --></A><H3>
2927 getInfoProcesses</H3>
2929 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getInfoProcesses</B>()
2930 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2932 <DD>Returns a <code>String</code> containing the <code>String</code>
2933 representations of all the processes of this <code>Server</code>.
2940 <DT><B>Returns:</B><DD>a <code>String</code> representation of the processes
2941 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Process.html#getInfo()"><CODE>Process.getInfo()</CODE></A></DL>
2946 <A NAME="compareTo(org.openafs.jafs.Server)"><!-- --></A><H3>
2949 public int <B>compareTo</B>(<A HREF="../../../org/openafs/jafs/Server.html">Server</A> server)</PRE>
2951 <DD>Compares two Server objects respective to their names and does not
2952 factor any other attribute. Alphabetic case is significant in
2959 <DT><B>Parameters:</B><DD><CODE>server</CODE> - The Server object to be compared to this
2961 <DT><B>Returns:</B><DD>Zero if the argument is equal to this Server's name, a
2962 value less than zero if this Server's name is
2963 lexicographically less than the argument, or a value greater
2964 than zero if this Server's name is lexicographically
2965 greater than the argument</DL>
2970 <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
2973 public int <B>compareTo</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A> obj)</PRE>
2975 <DD>Comparable interface method.
2978 <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>
2981 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Server.html#compareTo(org.openafs.jafs.Server)"><CODE>compareTo(Server)</CODE></A></DL>
2986 <A NAME="equals(org.openafs.jafs.Server)"><!-- --></A><H3>
2989 public boolean <B>equals</B>(<A HREF="../../../org/openafs/jafs/Server.html">Server</A> otherServer)</PRE>
2991 <DD>Tests whether two <code>Server</code> objects are equal, based on their
2992 names and hosting Cell.
2998 <DT><B>Parameters:</B><DD><CODE>otherServer</CODE> - the Server to test
2999 <DT><B>Returns:</B><DD>whether the specifed Server is the same as this Server</DL>
3004 <A NAME="toString()"><!-- --></A><H3>
3007 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
3009 <DD>Returns the name of this <CODE>Server</CODE>
3012 <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>
3016 <DT><B>Returns:</B><DD>the name of this <CODE>Server</CODE></DL>
3021 <A NAME="getVosServerHandle(int, java.lang.String)"><!-- --></A><H3>
3022 getVosServerHandle</H3>
3024 protected static int <B>getVosServerHandle</B>(int cellHandle,
3025 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> serverName)
3026 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3028 <DD>Opens a server for administrative vos use, based on the cell handle
3029 provided. Returns a vos server handle to be used by other
3030 methods as a means of identification.
3036 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - a cell handle previously returned by
3037 a call to <A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A><DD><CODE>serverName</CODE> - the name of the server for which to retrieve
3039 <DT><B>Returns:</B><DD>a vos handle to the server
3041 <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>
3046 <A NAME="closeVosServerHandle(int)"><!-- --></A><H3>
3047 closeVosServerHandle</H3>
3049 protected static void <B>closeVosServerHandle</B>(int vosHandle)
3050 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3052 <DD>Closes the given currently open vos server handle.
3058 <DT><B>Parameters:</B><DD><CODE>vosHandle</CODE> - the vos server handle to close
3060 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
3065 <A NAME="getBosServerHandle(int, java.lang.String)"><!-- --></A><H3>
3066 getBosServerHandle</H3>
3068 protected static int <B>getBosServerHandle</B>(int cellHandle,
3069 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> serverName)
3070 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3072 <DD>Opens a server for administrative bos use, based on the cell handle
3073 provided. Returns a bos server handle to be used by other methods
3074 as a means of identification.
3080 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - a cell handle previously returned by a call
3081 to <A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A><DD><CODE>serverName</CODE> - the name of the server for which to retrieve
3083 <DT><B>Returns:</B><DD>a bos handle to the server
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="closeBosServerHandle(int)"><!-- --></A><H3>
3091 closeBosServerHandle</H3>
3093 protected static void <B>closeBosServerHandle</B>(int bosHandle)
3094 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3096 <DD>Closes the given currently open bos server handle.
3102 <DT><B>Parameters:</B><DD><CODE>bosHandle</CODE> - the bos server handle to close
3104 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
3109 <A NAME="getServerInfo(int, java.lang.String, org.openafs.jafs.Server)"><!-- --></A><H3>
3112 protected static void <B>getServerInfo</B>(int cellHandle,
3113 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> name,
3114 <A HREF="../../../org/openafs/jafs/Server.html">Server</A> server)
3115 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3117 <DD>Fills in the information fields of the provided <code>Server</code>.
3123 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the server belongs<DD><CODE>name</CODE> - the name of the server for which to get the information<DD><CODE>server</CODE> - the <code>Server</code> object in which to fill in
3126 <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>,
3127 <A HREF="../../../org/openafs/jafs/Server.html"><CODE>Server</CODE></A></DL>
3132 <A NAME="getPartitionCount(int, int)"><!-- --></A><H3>
3133 getPartitionCount</H3>
3135 protected static int <B>getPartitionCount</B>(int cellHandle,
3136 int serverHandle)
3137 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3139 <DD>Returns the total number of partitions hosted by the server denoted by
3140 <CODE>serverHandle</CODE>, if the server is a fileserver.
3146 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the server belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server to which the
3148 <DT><B>Returns:</B><DD>total number of partitions
3150 <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>,
3151 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>getVosServerHandle(int, java.lang.String)</CODE></A></DL>
3156 <A NAME="getPartitionsBegin(int, int)"><!-- --></A><H3>
3157 getPartitionsBegin</H3>
3159 protected static int <B>getPartitionsBegin</B>(int cellHandle,
3160 int serverHandle)
3161 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3163 <DD>Begin the process of getting the partitions on a server. Returns
3164 an iteration ID to be used by subsequent calls to
3165 <code>getPartitionsNext</code> and <code>getPartitionsDone</code>.
3171 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the server belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server to which the
3173 <DT><B>Returns:</B><DD>an iteration ID
3175 <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>,
3176 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>getVosServerHandle(int, java.lang.String)</CODE></A></DL>
3181 <A NAME="getPartitionsNextString(int)"><!-- --></A><H3>
3182 getPartitionsNextString</H3>
3184 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getPartitionsNextString</B>(int iterationId)
3185 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3187 <DD>Returns the next partition of the server. Returns <code>null</code>
3188 if there are no more partitions.
3194 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
3195 <DT><B>Returns:</B><DD>the name of the next partition of the server
3197 <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#getPartitionsBegin(int, int)"><CODE>getPartitionsBegin(int, int)</CODE></A></DL>
3202 <A NAME="getPartitionsNext(int, org.openafs.jafs.Partition)"><!-- --></A><H3>
3203 getPartitionsNext</H3>
3205 protected static int <B>getPartitionsNext</B>(int iterationId,
3206 <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A> thePartition)
3207 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3209 <DD>Fills the next partition object of the server. Returns 0 if there
3210 are no more partitions, != 0 otherwise
3216 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration<DD><CODE>thePartition</CODE> - the Partition object in which to fill the
3217 values of the next partition
3218 <DT><B>Returns:</B><DD>0 if there are no more servers, != 0 otherwise
3220 <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#getPartitionsBegin(int, int)"><CODE>getPartitionsBegin(int, int)</CODE></A></DL>
3225 <A NAME="getPartitionsDone(int)"><!-- --></A><H3>
3226 getPartitionsDone</H3>
3228 protected static void <B>getPartitionsDone</B>(int iterationId)
3229 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3231 <DD>Signals that the iteration is complete and will not be accessed anymore.
3237 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
3239 <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#getPartitionsBegin(int, int)"><CODE>getPartitionsBegin(int, int)</CODE></A></DL>
3244 <A NAME="getProcessCount(int)"><!-- --></A><H3>
3245 getProcessCount</H3>
3247 protected static int <B>getProcessCount</B>(int serverHandle)
3248 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3250 <DD>Returns the total number of processes hosted by the server denoted by
3251 <CODE>serverHandle</CODE>.
3257 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the vos handle of the server to which the
3259 <DT><B>Returns:</B><DD>total number of processes
3261 <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>getVosServerHandle(int, java.lang.String)</CODE></A></DL>
3266 <A NAME="getProcessesBegin(int)"><!-- --></A><H3>
3267 getProcessesBegin</H3>
3269 protected static int <B>getProcessesBegin</B>(int serverHandle)
3270 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3272 <DD>Begin the process of getting the processes on a server. Returns
3273 an iteration ID to be used by subsequent calls to
3274 <code>getProcessesNext</code> and <code>getProcessesDone</code>.
3280 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the bos handle of the server to which the
3282 <DT><B>Returns:</B><DD>an iteration ID
3284 <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#getBosServerHandle(int, java.lang.String)"><CODE>getBosServerHandle(int, java.lang.String)</CODE></A></DL>
3289 <A NAME="getProcessesNextString(int)"><!-- --></A><H3>
3290 getProcessesNextString</H3>
3292 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getProcessesNextString</B>(int iterationId)
3293 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3295 <DD>Returns the next process of the server. Returns <code>null</code>
3296 if there are no more processes.
3302 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
3303 <DT><B>Returns:</B><DD>the name of the next process of the cell
3305 <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#getProcessesBegin(int)"><CODE>getProcessesBegin(int)</CODE></A></DL>
3310 <A NAME="getProcessesNext(int, int, org.openafs.jafs.Process)"><!-- --></A><H3>
3311 getProcessesNext</H3>
3313 protected static int <B>getProcessesNext</B>(int serverHandle,
3314 int iterationId,
3315 <A HREF="../../../org/openafs/jafs/Process.html">Process</A> theProcess)
3316 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3318 <DD>Fills the next process object of the server. Returns 0 if there
3319 are no more processes, != 0 otherwise.
3325 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the handle of the BOS server that hosts the process<DD><CODE>iterationId</CODE> - the iteration ID of this iteration<DD><CODE>theProcess</CODE> - the Process object in which to fill the
3326 values of the next process
3327 <DT><B>Returns:</B><DD>0 if there are no more processes, != otherwise
3329 <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#getBosHandle()"><CODE>getBosHandle()</CODE></A>,
3330 <A HREF="../../../org/openafs/jafs/Server.html#getProcessesBegin(int)"><CODE>getProcessesBegin(int)</CODE></A></DL>
3335 <A NAME="getProcessesDone(int)"><!-- --></A><H3>
3336 getProcessesDone</H3>
3338 protected static void <B>getProcessesDone</B>(int iterationId)
3339 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3341 <DD>Signals that the iteration is complete and will not be accessed anymore.
3347 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
3349 <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#getProcessesBegin(int)"><CODE>getProcessesBegin(int)</CODE></A></DL>
3354 <A NAME="getKeyCount(int)"><!-- --></A><H3>
3357 protected static int <B>getKeyCount</B>(int serverHandle)
3358 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3360 <DD>Returns the total number of keys hosted by the server denoted by
3361 <CODE>serverHandle</CODE>.
3367 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the vos handle of the server to which the
3369 <DT><B>Returns:</B><DD>total number of keys
3371 <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>getVosServerHandle(int, java.lang.String)</CODE></A></DL>
3376 <A NAME="getKeysBegin(int)"><!-- --></A><H3>
3379 protected static int <B>getKeysBegin</B>(int serverHandle)
3380 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3382 <DD>Begin the process of getting the keys of a server. Returns
3383 an iteration ID to be used by subsequent calls to
3384 <code>getKeysNext</code> and <code>getKeysDone</code>.
3390 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the bos handle of the server to which the keys belong
3391 <DT><B>Returns:</B><DD>an iteration ID
3393 <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#getBosServerHandle(int, java.lang.String)"><CODE>getBosServerHandle(int, java.lang.String)</CODE></A></DL>
3398 <A NAME="getKeysNext(int, org.openafs.jafs.Key)"><!-- --></A><H3>
3401 protected static int <B>getKeysNext</B>(int iterationId,
3402 <A HREF="../../../org/openafs/jafs/Key.html">Key</A> theKey)
3403 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3405 <DD>Returns the next key of the server. Returns 0 if there
3406 are no more keys, != 0 otherwise.
3412 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration<DD><CODE>theKey</CODE> - a <A HREF="../../../org/openafs/jafs/Key.html"><CODE>Key</CODE></A> object, in which to fill in the
3413 properties of the next key.
3414 <DT><B>Returns:</B><DD>0 if there are no more keys, != 0 otherwise
3416 <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#getKeysBegin(int)"><CODE>getKeysBegin(int)</CODE></A></DL>
3421 <A NAME="getKeysDone(int)"><!-- --></A><H3>
3424 protected static void <B>getKeysDone</B>(int iterationId)
3425 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3427 <DD>Signals that the iteration is complete and will not be accessed anymore.
3433 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
3435 <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#getKeysBegin(int)"><CODE>getKeysBegin(int)</CODE></A></DL>
3440 <A NAME="getBosAdminCount(int)"><!-- --></A><H3>
3441 getBosAdminCount</H3>
3443 protected static int <B>getBosAdminCount</B>(int serverHandle)
3444 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3446 <DD>Returns the total number of BOS administrators associated with the server
3447 denoted by <CODE>serverHandle</CODE>.
3453 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the vos handle of the server to which the
3455 <DT><B>Returns:</B><DD>total number of BOS administrators
3457 <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>getVosServerHandle(int, java.lang.String)</CODE></A></DL>
3462 <A NAME="getBosAdminsBegin(int)"><!-- --></A><H3>
3463 getBosAdminsBegin</H3>
3465 protected static int <B>getBosAdminsBegin</B>(int serverHandle)
3466 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3468 <DD>Begin the process of getting the bos amdinistrators on a server. Returns
3469 an iteration ID to be used by subsequent calls to
3470 <code>getBosAdminsNext</code> and <code>getBosAdminsDone</code>.
3476 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the bos handle of the server to which the
3478 <DT><B>Returns:</B><DD>an iteration ID
3480 <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#getBosServerHandle(int, java.lang.String)"><CODE>getBosServerHandle(int, java.lang.String)</CODE></A></DL>
3485 <A NAME="getBosAdminsNextString(int)"><!-- --></A><H3>
3486 getBosAdminsNextString</H3>
3488 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getBosAdminsNextString</B>(int iterationId)
3489 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3491 <DD>Returns the next bos admin of the server. Returns <code>null</code>
3492 if there are no more admins.
3498 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
3499 <DT><B>Returns:</B><DD>the name of the next admin of the server
3501 <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#getBosAdminsBegin(int)"><CODE>getBosAdminsBegin(int)</CODE></A></DL>
3506 <A NAME="getBosAdminsNext(int, int, org.openafs.jafs.User)"><!-- --></A><H3>
3507 getBosAdminsNext</H3>
3509 protected static int <B>getBosAdminsNext</B>(int cellHandle,
3510 int iterationId,
3511 <A HREF="../../../org/openafs/jafs/User.html">User</A> theUser)
3512 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3514 <DD>Returns the next bos admin of the server. Returns 0 if there
3515 are no more admins, != 0 otherwise.
3521 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which these admins belong<DD><CODE>iterationId</CODE> - the iteration ID of this iteration<DD><CODE>theUser</CODE> - the user object in which to fill the values of this admin
3522 <DT><B>Returns:</B><DD>0 if no more admins, != 0 otherwise
3524 <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>,
3525 <A HREF="../../../org/openafs/jafs/Server.html#getBosAdminsBegin(int)"><CODE>getBosAdminsBegin(int)</CODE></A></DL>
3530 <A NAME="getBosAdminsDone(int)"><!-- --></A><H3>
3531 getBosAdminsDone</H3>
3533 protected static void <B>getBosAdminsDone</B>(int iterationId)
3534 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3536 <DD>Signals that the iteration is complete and will not be accessed anymore.
3542 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
3544 <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#getBosAdminsBegin(int)"><CODE>getBosAdminsBegin(int)</CODE></A></DL>
3549 <A NAME="addBosAdmin(int, java.lang.String)"><!-- --></A><H3>
3552 protected static void <B>addBosAdmin</B>(int serverHandle,
3553 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> adminName)
3554 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3556 <DD>Adds the given to name to the list of bos administrators on that server.
3562 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the bos handle of the server to which the
3563 partitions belong<DD><CODE>adminName</CODE> - the name of the admin to add to the list
3565 <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#getBosServerHandle(int, java.lang.String)"><CODE>getBosServerHandle(int, java.lang.String)</CODE></A></DL>
3570 <A NAME="removeBosAdmin(int, java.lang.String)"><!-- --></A><H3>
3573 protected static void <B>removeBosAdmin</B>(int serverHandle,
3574 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> adminName)
3575 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3577 <DD>Removes the given to name from the list of bos administrators on
3584 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the bos handle of the server to which the
3585 partitions belong<DD><CODE>adminName</CODE> - the name of the admin to remove from the list
3587 <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#getBosServerHandle(int, java.lang.String)"><CODE>getBosServerHandle(int, java.lang.String)</CODE></A></DL>
3592 <A NAME="salvage(int, int, java.lang.String, java.lang.String, int, java.lang.String, java.lang.String, boolean, boolean, boolean, boolean, boolean, boolean)"><!-- --></A><H3>
3595 protected static void <B>salvage</B>(int cellHandle,
3596 int serverHandle,
3597 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> partitionName,
3598 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> volName,
3599 int numSalvagers,
3600 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> tempDir,
3601 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> logFile,
3602 boolean inspectAllVolumes,
3603 boolean removeBadlyDamaged,
3604 boolean writeInodes,
3605 boolean writeRootInodes,
3606 boolean forceDirectory,
3607 boolean forceBlockReads)
3608 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3610 <DD>Salvages (restores consistency to) a volume, partition, or server
3616 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the volume belongs<DD><CODE>serverHandle</CODE> - the bos handle of the server on which the
3617 volume resides<DD><CODE>partitionName</CODE> - the name of the partition to salvage,
3618 can be <code>null</code> only if volName is
3619 <code>null</code><DD><CODE>volName</CODE> - the name of the volume to salvage,
3620 can be <code>null</code><DD><CODE>numSalvagers</CODE> - the number of salvager processes to run in parallel<DD><CODE>tempDir</CODE> - directory to place temporary files, can be
3621 <code>null</code><DD><CODE>logFile</CODE> - where salvager log will be written, can be
3622 <code>null</code><DD><CODE>inspectAllVolumes</CODE> - whether or not to inspect all volumes,
3623 not just those marked as active at crash<DD><CODE>removeBadlyDamaged</CODE> - whether or not to remove a volume if it's
3624 badly damaged<DD><CODE>writeInodes</CODE> - whether or not to record a list of inodes modified<DD><CODE>writeRootInodes</CODE> - whether or not to record a list of AFS
3625 inodes owned by root<DD><CODE>forceDirectory</CODE> - whether or not to salvage an entire directory
3626 structure<DD><CODE>forceBlockReads</CODE> - whether or not to force the salvager to read
3628 one block at a time and skip badly damaged
3629 blocks. Use if partition has disk errors
3630 <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>,
3631 <A HREF="../../../org/openafs/jafs/Server.html#getBosServerHandle(int, java.lang.String)"><CODE>getBosServerHandle(int, java.lang.String)</CODE></A></DL>
3636 <A NAME="syncServerWithVLDB(int, int, int)"><!-- --></A><H3>
3637 syncServerWithVLDB</H3>
3639 protected static void <B>syncServerWithVLDB</B>(int cellHandle,
3640 int serverHandle,
3642 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3644 <DD>Synchronizes a particular server with the volume location database.
3650 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the server belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server<DD><CODE>partition</CODE> - the id of the partition to sync, can be -1 to ignore
3652 <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>,
3653 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>getVosServerHandle(int, java.lang.String)</CODE></A></DL>
3658 <A NAME="syncVLDBWithServer(int, int, int, boolean)"><!-- --></A><H3>
3659 syncVLDBWithServer</H3>
3661 protected static void <B>syncVLDBWithServer</B>(int cellHandle,
3662 int serverHandle,
3664 boolean forceDeletion)
3665 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3667 <DD>Synchronizes the volume location database with a particular server.
3673 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the handle of the cell to which the server belongs<DD><CODE>serverHandle</CODE> - the vos handle of the server<DD><CODE>partition</CODE> - the id of the partition to sync, can be -1 to ignore<DD><CODE>forceDeletion</CODE> - whether or not to force the deletion of bad volumes
3675 <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>,
3676 <A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)"><CODE>getVosServerHandle(int, java.lang.String)</CODE></A></DL>
3681 <A NAME="getLog(int, java.lang.String)"><!-- --></A><H3>
3684 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getLog</B>(int serverHandle,
3685 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> logLocation)
3686 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3688 <DD>Retrieves a specified bos log from a server. Right now this
3689 method will simply return a huge String containing the log, but
3690 hopefully we can devise a better way to make this work more efficiently.
3696 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the bos handle of the server to which the key belongs<DD><CODE>logLocation</CODE> - the full path and name of the desired bos log
3698 <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#getBosServerHandle(int, java.lang.String)"><CODE>getBosServerHandle(int, java.lang.String)</CODE></A></DL>
3703 <A NAME="startAllProcesses(int)"><!-- --></A><H3>
3704 startAllProcesses</H3>
3706 protected static void <B>startAllProcesses</B>(int serverHandle)
3707 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3709 <DD>Start all server processes.
3715 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the bos handle of the server to which the
3718 <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#getBosServerHandle(int, java.lang.String)"><CODE>getBosServerHandle(int, java.lang.String)</CODE></A></DL>
3723 <A NAME="restartAllProcesses(int, boolean)"><!-- --></A><H3>
3724 restartAllProcesses</H3>
3726 protected static void <B>restartAllProcesses</B>(int serverHandle,
3727 boolean restartBosServer)
3728 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3730 <DD>Restart all server processes.
3736 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the bos handle of the server to which the
3737 processes belong<DD><CODE>restartBosServer</CODE> - whether or not to restart the bos server as well
3739 <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#getBosServerHandle(int, java.lang.String)"><CODE>getBosServerHandle(int, java.lang.String)</CODE></A></DL>
3744 <A NAME="stopAllProcesses(int)"><!-- --></A><H3>
3745 stopAllProcesses</H3>
3747 protected static void <B>stopAllProcesses</B>(int serverHandle)
3748 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3750 <DD>Stop all server processes.
3756 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the bos handle of the server to which the
3759 <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#getBosServerHandle(int, java.lang.String)"><CODE>getBosServerHandle(int, java.lang.String)</CODE></A></DL>
3764 <A NAME="reclaimServerMemory()"><!-- --></A><H3>
3765 reclaimServerMemory</H3>
3767 protected static void <B>reclaimServerMemory</B>()</PRE>
3769 <DD>Reclaims all memory being saved by the server portion of the native
3770 library. This method should be called when no more <code>Server</code>
3771 objects are expected to be used.
3780 <!-- ========= END OF CLASS DATA ========= -->
3783 <!-- ========== START OF NAVBAR ========== -->
3784 <A NAME="navbar_bottom"><!-- --></A>
3785 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
3787 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
3788 <A NAME="navbar_bottom_firstrow"><!-- --></A>
3789 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
3790 <TR ALIGN="center" VALIGN="top">
3791 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
3792 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
3793 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Server.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
3794 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
3795 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
3796 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
3797 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
3801 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
3802 <B>JAFS API v2</B></EM>
3807 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
3808 <A HREF="../../../org/openafs/jafs/Process.html"><B>PREV CLASS</B></A>
3809 <A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html"><B>NEXT CLASS</B></A></FONT></TD>
3810 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
3811 <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
3812 <A HREF="Server.html" TARGET="_top"><B>NO FRAMES</B></A>
3817 document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
3822 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
3827 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
3828 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
3829 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
3830 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
3833 <!-- =========== END OF NAVBAR =========== -->