(no commit message)
[openafs-wiki.git] / JavaAdminAPI / Server.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc on Mon Jun 09 15:53:38 PDT 2003 -->
6 <TITLE>
7 Server (Java AFS API)
8 </TITLE>
9 <META NAME="keywords" CONTENT="org.openafs.jafs.Server,Server class">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
11 </HEAD>
12 <SCRIPT>
13 function asd()
14 {
15 parent.document.title="Server (Java AFS API)";
16 }
17 </SCRIPT>
18 <BODY BGCOLOR="white" onload="asd();">
19
20 <!-- ========== START OF NAVBAR ========== -->
21 <A NAME="navbar_top"><!-- --></A>
22 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
23 <TR>
24 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
25 <A NAME="navbar_top_firstrow"><!-- --></A>
26 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
27   <TR ALIGN="center" VALIGN="top">
28   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
29   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
30   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Server.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
31   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
32   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
33   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
34   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
35   </TR>
36 </TABLE>
37 </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
40 </TD>
41 </TR>
42
43 <TR>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 &nbsp;<A HREF="../../../org/openafs/jafs/Process.html"><B>PREV CLASS</B></A>&nbsp;
46 &nbsp;<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>  &nbsp;
49 &nbsp;<A HREF="Server.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
50 &nbsp;
51 <SCRIPT>
52   <!--
53   if(window==top) {
54     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
55   }
56   //-->
57 </SCRIPT>
58 <NOSCRIPT>
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
60 </NOSCRIPT>
61 </FONT></TD>
62 </TR>
63 <TR>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65   SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
68 </TR>
69 </TABLE>
70 <!-- =========== END OF NAVBAR =========== -->
71
72 <HR>
73 <!-- ======== START OF CLASS DATA ======== -->
74 <H2>
75 <FONT SIZE="-1">
76 org.openafs.jafs</FONT>
77 <BR>
78 Class Server</H2>
79 <PRE>
80 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">java.lang.Object</A>
81   |
82   +--<B>org.openafs.jafs.Server</B>
83 </PRE>
84 <DL>
85 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Serializable.html">Serializable</A></DD>
86 </DL>
87 <HR>
88 <DL>
89 <DT>public class <B>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>
90
91 <P>
92 An abstract representation of an AFS server.  It holds information about 
93  the server, such as what its processes are.
94  <BR><BR>
95
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>
102
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
105  purposes.<BR><BR>
106
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.
110  <BR><BR>
111     
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.
117  <BR><BR>
118
119  <PRE>
120  import org.openafs.jafs.Cell;
121  import org.openafs.jafs.AFSException;
122  import org.openafs.jafs.Partition;
123  import org.openafs.jafs.Server;
124  ...
125  public class ...
126  {
127    ...
128    private Cell cell;
129    private Server server;
130    ...
131    public static void main(String[] args) throws Exception
132    {
133      String username   = arg[0];
134      String password   = arg[1];
135      String cellName   = arg[2];
136      String serverName = arg[3];
137  
138      token = new Token(username, password, cellName);
139      cell   = new Cell(token);
140      server = new Server(serverName, cell);
141  
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]);
147        }
148      }
149    }
150    ...
151  }
152  </PRE>
153 <P>
154
155 <P>
156 <DL>
157 <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html" TARGET="org.openafs.jafs.Server">Serialized Form</A></DL>
158 <HR>
159
160 <P>
161 <!-- ======== NESTED CLASS SUMMARY ======== -->
162
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>
168 </TR>
169 <TR BGCOLOR="white" CLASS="TableRowColor">
170 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171 <CODE>static&nbsp;class</CODE></FONT></TD>
172 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A></B></CODE>
173
174 <BR>
175 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
176 </TR>
177 </TABLE>
178 &nbsp;
179 <!-- =========== FIELD SUMMARY =========== -->
180
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>
186 </TR>
187 <TR BGCOLOR="white" CLASS="TableRowColor">
188 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189 <CODE>protected &nbsp;<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>
191
192 <BR>
193 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
194 </TR>
195 <TR BGCOLOR="white" CLASS="TableRowColor">
196 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
197 <CODE>protected &nbsp;<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>
199
200 <BR>
201 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
202 </TR>
203 <TR BGCOLOR="white" CLASS="TableRowColor">
204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
205 <CODE>protected &nbsp;boolean</CODE></FONT></TD>
206 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#badDatabase">badDatabase</A></B></CODE>
207
208 <BR>
209 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
210 </TR>
211 <TR BGCOLOR="white" CLASS="TableRowColor">
212 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213 <CODE>protected &nbsp;boolean</CODE></FONT></TD>
214 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#badFileServer">badFileServer</A></B></CODE>
215
216 <BR>
217 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
218 </TR>
219 <TR BGCOLOR="white" CLASS="TableRowColor">
220 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221 <CODE>protected &nbsp;<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>
223
224 <BR>
225 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
226 </TR>
227 <TR BGCOLOR="white" CLASS="TableRowColor">
228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229 <CODE>protected &nbsp;int</CODE></FONT></TD>
230 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#bosHandle">bosHandle</A></B></CODE>
231
232 <BR>
233 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
234 </TR>
235 <TR BGCOLOR="white" CLASS="TableRowColor">
236 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237 <CODE>protected &nbsp;boolean</CODE></FONT></TD>
238 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#cachedInfo">cachedInfo</A></B></CODE>
239
240 <BR>
241 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
242 </TR>
243 <TR BGCOLOR="white" CLASS="TableRowColor">
244 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
245 <CODE>protected &nbsp;<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>
247
248 <BR>
249 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
250 </TR>
251 <TR BGCOLOR="white" CLASS="TableRowColor">
252 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253 <CODE>protected &nbsp;boolean</CODE></FONT></TD>
254 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#database">database</A></B></CODE>
255
256 <BR>
257 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
258 </TR>
259 <TR BGCOLOR="white" CLASS="TableRowColor">
260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261 <CODE>protected &nbsp;boolean</CODE></FONT></TD>
262 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#fileServer">fileServer</A></B></CODE>
263
264 <BR>
265 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
266 </TR>
267 <TR BGCOLOR="white" CLASS="TableRowColor">
268 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269 <CODE>protected &nbsp;<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>
271
272 <BR>
273 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
274 </TR>
275 <TR BGCOLOR="white" CLASS="TableRowColor">
276 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
277 <CODE>protected &nbsp;<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>
279
280 <BR>
281 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
282 </TR>
283 <TR BGCOLOR="white" CLASS="TableRowColor">
284 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285 <CODE>protected &nbsp;<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>
287
288 <BR>
289 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
290 </TR>
291 <TR BGCOLOR="white" CLASS="TableRowColor">
292 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293 <CODE>protected &nbsp;<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>
295
296 <BR>
297 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
298 </TR>
299 <TR BGCOLOR="white" CLASS="TableRowColor">
300 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301 <CODE>protected &nbsp;<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>
303
304 <BR>
305 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
306 </TR>
307 <TR BGCOLOR="white" CLASS="TableRowColor">
308 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
309 <CODE>protected &nbsp;<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>
311
312 <BR>
313 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
314 </TR>
315 <TR BGCOLOR="white" CLASS="TableRowColor">
316 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
317 <CODE>protected &nbsp;<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>
319
320 <BR>
321 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
322 </TR>
323 <TR BGCOLOR="white" CLASS="TableRowColor">
324 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
325 <CODE>protected &nbsp;<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>
327
328 <BR>
329 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
330 </TR>
331 <TR BGCOLOR="white" CLASS="TableRowColor">
332 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
333 <CODE>protected &nbsp;int</CODE></FONT></TD>
334 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#totalFreeSpace">totalFreeSpace</A></B></CODE>
335
336 <BR>
337 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
338 </TR>
339 <TR BGCOLOR="white" CLASS="TableRowColor">
340 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
341 <CODE>protected &nbsp;int</CODE></FONT></TD>
342 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#totalQuota">totalQuota</A></B></CODE>
343
344 <BR>
345 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
346 </TR>
347 <TR BGCOLOR="white" CLASS="TableRowColor">
348 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
349 <CODE>protected &nbsp;int</CODE></FONT></TD>
350 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#totalSpace">totalSpace</A></B></CODE>
351
352 <BR>
353 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
354 </TR>
355 <TR BGCOLOR="white" CLASS="TableRowColor">
356 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
357 <CODE>protected &nbsp;int</CODE></FONT></TD>
358 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#totalUsedSpace">totalUsedSpace</A></B></CODE>
359
360 <BR>
361 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
362 </TR>
363 <TR BGCOLOR="white" CLASS="TableRowColor">
364 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
365 <CODE>protected &nbsp;int</CODE></FONT></TD>
366 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#vosHandle">vosHandle</A></B></CODE>
367
368 <BR>
369 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
370 </TR>
371 </TABLE>
372 &nbsp;
373 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
374
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>
380 </TR>
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>&nbsp;cell)</CODE>
385
386 <BR>
387 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a blank <code>Server</code> object instance given the cell to 
388  which the server belongs.  </TD>
389 </TR>
390 <TR BGCOLOR="white" CLASS="TableRowColor">
391 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
392 <CODE>&nbsp;</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>&nbsp;name,
394        <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A>&nbsp;cell)</CODE>
395
396 <BR>
397 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>
400 </TR>
401 <TR BGCOLOR="white" CLASS="TableRowColor">
402 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
403 <CODE>&nbsp;</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>&nbsp;name,
405        <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A>&nbsp;cell,
406        boolean&nbsp;preloadAllMembers)</CODE>
407
408 <BR>
409 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>
412 </TR>
413 </TABLE>
414 &nbsp;
415 <!-- ========== METHOD SUMMARY =========== -->
416
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>
422 </TR>
423 <TR BGCOLOR="white" CLASS="TableRowColor">
424 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
425 <CODE>&nbsp;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>&nbsp;admin)</CODE>
427
428 <BR>
429 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>
432 </TR>
433 <TR BGCOLOR="white" CLASS="TableRowColor">
434 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
435 <CODE>protected static&nbsp;void</CODE></FONT></TD>
436 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#addBosAdmin(int, java.lang.String)">addBosAdmin</A></B>(int&nbsp;serverHandle,
437             <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;adminName)</CODE>
438
439 <BR>
440 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the given to name to the list of bos administrators on that server.</TD>
441 </TR>
442 <TR BGCOLOR="white" CLASS="TableRowColor">
443 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
444 <CODE>&nbsp;void</CODE></FONT></TD>
445 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#close()">close</A></B>()</CODE>
446
447 <BR>
448 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unauthenticates all server-related tokens that have been obtained by 
449  this <code>Server</code> object, and shuts this server object down.
450  </TD>
451 </TR>
452 <TR BGCOLOR="white" CLASS="TableRowColor">
453 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
454 <CODE>protected static&nbsp;void</CODE></FONT></TD>
455 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#closeBosServerHandle(int)">closeBosServerHandle</A></B>(int&nbsp;bosHandle)</CODE>
456
457 <BR>
458 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes the given currently open bos server handle.</TD>
459 </TR>
460 <TR BGCOLOR="white" CLASS="TableRowColor">
461 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
462 <CODE>protected static&nbsp;void</CODE></FONT></TD>
463 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#closeVosServerHandle(int)">closeVosServerHandle</A></B>(int&nbsp;vosHandle)</CODE>
464
465 <BR>
466 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes the given currently open vos server handle.</TD>
467 </TR>
468 <TR BGCOLOR="white" CLASS="TableRowColor">
469 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
470 <CODE>&nbsp;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>&nbsp;obj)</CODE>
472
473 <BR>
474 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Comparable interface method.</TD>
475 </TR>
476 <TR BGCOLOR="white" CLASS="TableRowColor">
477 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
478 <CODE>&nbsp;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>&nbsp;server)</CODE>
480
481 <BR>
482 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares two Server objects respective to their names and does not
483  factor any other attribute.  </TD>
484 </TR>
485 <TR BGCOLOR="white" CLASS="TableRowColor">
486 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
487 <CODE>&nbsp;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>&nbsp;otherServer)</CODE>
489
490 <BR>
491 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests whether two <code>Server</code> objects are equal, based on their 
492  names and hosting Cell.</TD>
493 </TR>
494 <TR BGCOLOR="white" CLASS="TableRowColor">
495 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
496 <CODE>&nbsp;int</CODE></FONT></TD>
497 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getAdminCount()">getAdminCount</A></B>()</CODE>
498
499 <BR>
500 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of BOS administrators assigned to this server.
501
502  </TD>
503 </TR>
504 <TR BGCOLOR="white" CLASS="TableRowColor">
505 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
506 <CODE>&nbsp;<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>
508
509 <BR>
510 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves an array containing all of the names of bos admins 
511  associated with this <code>Server</code>. </TD>
512 </TR>
513 <TR BGCOLOR="white" CLASS="TableRowColor">
514 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
515 <CODE>&nbsp;<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>
517
518 <BR>
519 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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.  
522  </TD>
523 </TR>
524 <TR BGCOLOR="white" CLASS="TableRowColor">
525 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
526 <CODE>&nbsp;<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>
528
529 <BR>
530 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the BOS Server's binary restart time in the form of an
531  ExecutableTime object.  </TD>
532 </TR>
533 <TR BGCOLOR="white" CLASS="TableRowColor">
534 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
535 <CODE>protected static&nbsp;int</CODE></FONT></TD>
536 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBosAdminCount(int)">getBosAdminCount</A></B>(int&nbsp;serverHandle)</CODE>
537
538 <BR>
539 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total number of BOS administrators associated with the server 
540  denoted by <CODE>serverHandle</CODE>.</TD>
541 </TR>
542 <TR BGCOLOR="white" CLASS="TableRowColor">
543 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
544 <CODE>protected static&nbsp;int</CODE></FONT></TD>
545 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBosAdminsBegin(int)">getBosAdminsBegin</A></B>(int&nbsp;serverHandle)</CODE>
546
547 <BR>
548 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Begin the process of getting the bos amdinistrators on a server.  </TD>
549 </TR>
550 <TR BGCOLOR="white" CLASS="TableRowColor">
551 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
552 <CODE>protected static&nbsp;void</CODE></FONT></TD>
553 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBosAdminsDone(int)">getBosAdminsDone</A></B>(int&nbsp;iterationId)</CODE>
554
555 <BR>
556 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals that the iteration is complete and will not be accessed anymore.</TD>
557 </TR>
558 <TR BGCOLOR="white" CLASS="TableRowColor">
559 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
560 <CODE>protected static&nbsp;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&nbsp;cellHandle,
562                  int&nbsp;iterationId,
563                  <A HREF="../../../org/openafs/jafs/User.html">User</A>&nbsp;theUser)</CODE>
564
565 <BR>
566 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the next bos admin of the server.  </TD>
567 </TR>
568 <TR BGCOLOR="white" CLASS="TableRowColor">
569 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
570 <CODE>protected static&nbsp;<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&nbsp;iterationId)</CODE>
572
573 <BR>
574 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the next bos admin of the server.  </TD>
575 </TR>
576 <TR BGCOLOR="white" CLASS="TableRowColor">
577 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
578 <CODE>protected &nbsp;int</CODE></FONT></TD>
579 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBosHandle()">getBosHandle</A></B>()</CODE>
580
581 <BR>
582 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns this server's bos handle.</TD>
583 </TR>
584 <TR BGCOLOR="white" CLASS="TableRowColor">
585 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
586 <CODE>protected static&nbsp;int</CODE></FONT></TD>
587 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getBosServerHandle(int, java.lang.String)">getBosServerHandle</A></B>(int&nbsp;cellHandle,
588                    <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;serverName)</CODE>
589
590 <BR>
591 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Opens a server for administrative bos use, based on the cell handle 
592  provided.  </TD>
593 </TR>
594 <TR BGCOLOR="white" CLASS="TableRowColor">
595 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
596 <CODE>&nbsp;<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>
598
599 <BR>
600 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the <code>Cell</code> object with which this <code>Server</code>
601  was constructed.  </TD>
602 </TR>
603 <TR BGCOLOR="white" CLASS="TableRowColor">
604 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
605 <CODE>&nbsp;<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>
607
608 <BR>
609 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the BOS Server's general restart time in the form of an
610  ExecutableTime object.  </TD>
611 </TR>
612 <TR BGCOLOR="white" CLASS="TableRowColor">
613 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
614 <CODE>protected &nbsp;<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>
616
617 <BR>
618 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <code>String</code> representation of this <code>Server</code>.
619  </TD>
620 </TR>
621 <TR BGCOLOR="white" CLASS="TableRowColor">
622 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
623 <CODE>protected &nbsp;<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>
625
626 <BR>
627 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <code>String</code> containing the <code>String</code> 
628  representations of all the keys of this <code>Server</code>.</TD>
629 </TR>
630 <TR BGCOLOR="white" CLASS="TableRowColor">
631 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
632 <CODE>protected &nbsp;<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>
634
635 <BR>
636 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <code>String</code> containing the <code>String</code> 
637  representations of all the partitions of this <code>Server</code>.</TD>
638 </TR>
639 <TR BGCOLOR="white" CLASS="TableRowColor">
640 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
641 <CODE>protected &nbsp;<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>
643
644 <BR>
645 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <code>String</code> containing the <code>String</code> 
646  representations of all the processes of this <code>Server</code>.</TD>
647 </TR>
648 <TR BGCOLOR="white" CLASS="TableRowColor">
649 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
650 <CODE>&nbsp;<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>
652
653 <BR>
654 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns this server's IP address as a String.  </TD>
655 </TR>
656 <TR BGCOLOR="white" CLASS="TableRowColor">
657 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
658 <CODE>&nbsp;<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&nbsp;keyVersion)</CODE>
660
661 <BR>
662 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>
665 </TR>
666 <TR BGCOLOR="white" CLASS="TableRowColor">
667 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
668 <CODE>&nbsp;int</CODE></FONT></TD>
669 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getKeyCount()">getKeyCount</A></B>()</CODE>
670
671 <BR>
672 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of keys on this server.
673
674  </TD>
675 </TR>
676 <TR BGCOLOR="white" CLASS="TableRowColor">
677 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
678 <CODE>protected static&nbsp;int</CODE></FONT></TD>
679 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getKeyCount(int)">getKeyCount</A></B>(int&nbsp;serverHandle)</CODE>
680
681 <BR>
682 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total number of keys hosted by the server denoted by
683  <CODE>serverHandle</CODE>.</TD>
684 </TR>
685 <TR BGCOLOR="white" CLASS="TableRowColor">
686 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
687 <CODE>&nbsp;<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>
689
690 <BR>
691 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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.  
694  </TD>
695 </TR>
696 <TR BGCOLOR="white" CLASS="TableRowColor">
697 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
698 <CODE>protected static&nbsp;int</CODE></FONT></TD>
699 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getKeysBegin(int)">getKeysBegin</A></B>(int&nbsp;serverHandle)</CODE>
700
701 <BR>
702 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Begin the process of getting the keys of a server.  </TD>
703 </TR>
704 <TR BGCOLOR="white" CLASS="TableRowColor">
705 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
706 <CODE>protected static&nbsp;void</CODE></FONT></TD>
707 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getKeysDone(int)">getKeysDone</A></B>(int&nbsp;iterationId)</CODE>
708
709 <BR>
710 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals that the iteration is complete and will not be accessed anymore.</TD>
711 </TR>
712 <TR BGCOLOR="white" CLASS="TableRowColor">
713 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
714 <CODE>protected static&nbsp;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&nbsp;iterationId,
716             <A HREF="../../../org/openafs/jafs/Key.html">Key</A>&nbsp;theKey)</CODE>
717
718 <BR>
719 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the next key of the server.  </TD>
720 </TR>
721 <TR BGCOLOR="white" CLASS="TableRowColor">
722 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
723 <CODE>protected static&nbsp;<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&nbsp;serverHandle,
725        <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;logLocation)</CODE>
726
727 <BR>
728 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves a specified bos log from a server.  </TD>
729 </TR>
730 <TR BGCOLOR="white" CLASS="TableRowColor">
731 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
732 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/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>&nbsp;logLocation)</CODE>
734
735 <BR>
736 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the contents of a log file, in one large <code>String</code>.  
737  </TD>
738 </TR>
739 <TR BGCOLOR="white" CLASS="TableRowColor">
740 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
741 <CODE>&nbsp;<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>
743
744 <BR>
745 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this server.</TD>
746 </TR>
747 <TR BGCOLOR="white" CLASS="TableRowColor">
748 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
749 <CODE>&nbsp;<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>&nbsp;name)</CODE>
751
752 <BR>
753 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>
756 </TR>
757 <TR BGCOLOR="white" CLASS="TableRowColor">
758 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
759 <CODE>&nbsp;int</CODE></FONT></TD>
760 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartitionCount()">getPartitionCount</A></B>()</CODE>
761
762 <BR>
763 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of partitions on this server.
764
765  </TD>
766 </TR>
767 <TR BGCOLOR="white" CLASS="TableRowColor">
768 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
769 <CODE>protected static&nbsp;int</CODE></FONT></TD>
770 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartitionCount(int, int)">getPartitionCount</A></B>(int&nbsp;cellHandle,
771                   int&nbsp;serverHandle)</CODE>
772
773 <BR>
774 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total number of partitions hosted by the server denoted by
775  <CODE>serverHandle</CODE>, if the server is a fileserver.</TD>
776 </TR>
777 <TR BGCOLOR="white" CLASS="TableRowColor">
778 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
779 <CODE>&nbsp;<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>
781
782 <BR>
783 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves an array containing all of the names of partitions
784  associated with this <code>Server</code> (i.e. </TD>
785 </TR>
786 <TR BGCOLOR="white" CLASS="TableRowColor">
787 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
788 <CODE>&nbsp;<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>
790
791 <BR>
792 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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.  
795  </TD>
796 </TR>
797 <TR BGCOLOR="white" CLASS="TableRowColor">
798 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
799 <CODE>protected static&nbsp;int</CODE></FONT></TD>
800 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartitionsBegin(int, int)">getPartitionsBegin</A></B>(int&nbsp;cellHandle,
801                    int&nbsp;serverHandle)</CODE>
802
803 <BR>
804 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Begin the process of getting the partitions on a server.  </TD>
805 </TR>
806 <TR BGCOLOR="white" CLASS="TableRowColor">
807 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
808 <CODE>protected static&nbsp;void</CODE></FONT></TD>
809 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getPartitionsDone(int)">getPartitionsDone</A></B>(int&nbsp;iterationId)</CODE>
810
811 <BR>
812 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals that the iteration is complete and will not be accessed anymore.</TD>
813 </TR>
814 <TR BGCOLOR="white" CLASS="TableRowColor">
815 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
816 <CODE>protected static&nbsp;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&nbsp;iterationId,
818                   <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;thePartition)</CODE>
819
820 <BR>
821 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fills the next partition object of the server.  </TD>
822 </TR>
823 <TR BGCOLOR="white" CLASS="TableRowColor">
824 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
825 <CODE>protected static&nbsp;<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&nbsp;iterationId)</CODE>
827
828 <BR>
829 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the next partition of the server.  </TD>
830 </TR>
831 <TR BGCOLOR="white" CLASS="TableRowColor">
832 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
833 <CODE>&nbsp;<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>&nbsp;name)</CODE>
835
836 <BR>
837 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>
840 </TR>
841 <TR BGCOLOR="white" CLASS="TableRowColor">
842 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
843 <CODE>&nbsp;int</CODE></FONT></TD>
844 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcessCount()">getProcessCount</A></B>()</CODE>
845
846 <BR>
847 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of processes hosted by this server.
848
849  </TD>
850 </TR>
851 <TR BGCOLOR="white" CLASS="TableRowColor">
852 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
853 <CODE>protected static&nbsp;int</CODE></FONT></TD>
854 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcessCount(int)">getProcessCount</A></B>(int&nbsp;serverHandle)</CODE>
855
856 <BR>
857 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total number of processes hosted by the server denoted by
858  <CODE>serverHandle</CODE>.</TD>
859 </TR>
860 <TR BGCOLOR="white" CLASS="TableRowColor">
861 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
862 <CODE>&nbsp;<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>
864
865 <BR>
866 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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.  
869  </TD>
870 </TR>
871 <TR BGCOLOR="white" CLASS="TableRowColor">
872 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
873 <CODE>protected static&nbsp;int</CODE></FONT></TD>
874 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcessesBegin(int)">getProcessesBegin</A></B>(int&nbsp;serverHandle)</CODE>
875
876 <BR>
877 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Begin the process of getting the processes on a server.  </TD>
878 </TR>
879 <TR BGCOLOR="white" CLASS="TableRowColor">
880 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
881 <CODE>protected static&nbsp;void</CODE></FONT></TD>
882 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getProcessesDone(int)">getProcessesDone</A></B>(int&nbsp;iterationId)</CODE>
883
884 <BR>
885 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals that the iteration is complete and will not be accessed anymore.</TD>
886 </TR>
887 <TR BGCOLOR="white" CLASS="TableRowColor">
888 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
889 <CODE>protected static&nbsp;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&nbsp;serverHandle,
891                  int&nbsp;iterationId,
892                  <A HREF="../../../org/openafs/jafs/Process.html">Process</A>&nbsp;theProcess)</CODE>
893
894 <BR>
895 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fills the next process object of the server.  </TD>
896 </TR>
897 <TR BGCOLOR="white" CLASS="TableRowColor">
898 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
899 <CODE>protected static&nbsp;<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&nbsp;iterationId)</CODE>
901
902 <BR>
903 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the next process of the server.  </TD>
904 </TR>
905 <TR BGCOLOR="white" CLASS="TableRowColor">
906 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
907 <CODE>&nbsp;<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>
909
910 <BR>
911 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves an array containing all of the names of processes
912  associated with this <code>Server</code> (i.e. </TD>
913 </TR>
914 <TR BGCOLOR="white" CLASS="TableRowColor">
915 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
916 <CODE>protected static&nbsp;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&nbsp;cellHandle,
918               <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
919               <A HREF="../../../org/openafs/jafs/Server.html">Server</A>&nbsp;server)</CODE>
920
921 <BR>
922 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fills in the information fields of the provided <code>Server</code>.</TD>
923 </TR>
924 <TR BGCOLOR="white" CLASS="TableRowColor">
925 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
926 <CODE>&nbsp;int</CODE></FONT></TD>
927 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getTotalFreeSpace()">getTotalFreeSpace</A></B>()</CODE>
928
929 <BR>
930 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total free space on this server (a sum of the free space of 
931  all the partitions associated with this server).  </TD>
932 </TR>
933 <TR BGCOLOR="white" CLASS="TableRowColor">
934 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
935 <CODE>&nbsp;int</CODE></FONT></TD>
936 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getTotalSpace()">getTotalSpace</A></B>()</CODE>
937
938 <BR>
939 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total space on this server (a sum of the space of all the 
940  partitions associated with this server).  </TD>
941 </TR>
942 <TR BGCOLOR="white" CLASS="TableRowColor">
943 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
944 <CODE>&nbsp;int</CODE></FONT></TD>
945 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getTotalUsedSpace()">getTotalUsedSpace</A></B>()</CODE>
946
947 <BR>
948 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total used space on this server (a sum of the used space of 
949  all the partitions associated with this server).  </TD>
950 </TR>
951 <TR BGCOLOR="white" CLASS="TableRowColor">
952 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
953 <CODE>protected &nbsp;int</CODE></FONT></TD>
954 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getVosHandle()">getVosHandle</A></B>()</CODE>
955
956 <BR>
957 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns this server's vos handle.</TD>
958 </TR>
959 <TR BGCOLOR="white" CLASS="TableRowColor">
960 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
961 <CODE>protected static&nbsp;int</CODE></FONT></TD>
962 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#getVosServerHandle(int, java.lang.String)">getVosServerHandle</A></B>(int&nbsp;cellHandle,
963                    <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;serverName)</CODE>
964
965 <BR>
966 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Opens a server for administrative vos use, based on the cell handle 
967  provided.  </TD>
968 </TR>
969 <TR BGCOLOR="white" CLASS="TableRowColor">
970 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
971 <CODE>&nbsp;boolean</CODE></FONT></TD>
972 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#isBadDatabase()">isBadDatabase</A></B>()</CODE>
973
974 <BR>
975 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>
978 </TR>
979 <TR BGCOLOR="white" CLASS="TableRowColor">
980 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
981 <CODE>&nbsp;boolean</CODE></FONT></TD>
982 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#isBadFileServer()">isBadFileServer</A></B>()</CODE>
983
984 <BR>
985 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>
988 </TR>
989 <TR BGCOLOR="white" CLASS="TableRowColor">
990 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
991 <CODE>&nbsp;boolean</CODE></FONT></TD>
992 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#isDatabase()">isDatabase</A></B>()</CODE>
993
994 <BR>
995 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether or not this server is a database machine, meaning it runs
996  processes such as the "kaserver" and "vlserver", and participates in 
997  elections.</TD>
998 </TR>
999 <TR BGCOLOR="white" CLASS="TableRowColor">
1000 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1001 <CODE>&nbsp;boolean</CODE></FONT></TD>
1002 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#isFileServer()">isFileServer</A></B>()</CODE>
1003
1004 <BR>
1005 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether or not this server is a file server machine, meaning it
1006  runs the "fs" process and stores AFS volumes.</TD>
1007 </TR>
1008 <TR BGCOLOR="white" CLASS="TableRowColor">
1009 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1010 <CODE>protected static&nbsp;void</CODE></FONT></TD>
1011 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#reclaimServerMemory()">reclaimServerMemory</A></B>()</CODE>
1012
1013 <BR>
1014 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reclaims all memory being saved by the server portion of the native 
1015  library. </TD>
1016 </TR>
1017 <TR BGCOLOR="white" CLASS="TableRowColor">
1018 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1019 <CODE>&nbsp;void</CODE></FONT></TD>
1020 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refresh()">refresh</A></B>()</CODE>
1021
1022 <BR>
1023 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Refreshes the properties of this Server object instance with values 
1024  from the AFS server it represents.  </TD>
1025 </TR>
1026 <TR BGCOLOR="white" CLASS="TableRowColor">
1027 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1028 <CODE>protected &nbsp;void</CODE></FONT></TD>
1029 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refresh(boolean)">refresh</A></B>(boolean&nbsp;all)</CODE>
1030
1031 <BR>
1032 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Refreshes the properties of this Server object instance with values 
1033  from the AFS server it represents.  </TD>
1034 </TR>
1035 <TR BGCOLOR="white" CLASS="TableRowColor">
1036 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1037 <CODE>protected &nbsp;void</CODE></FONT></TD>
1038 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshAdminNames()">refreshAdminNames</A></B>()</CODE>
1039
1040 <BR>
1041 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtains the most current list of bos admin names of this server.</TD>
1042 </TR>
1043 <TR BGCOLOR="white" CLASS="TableRowColor">
1044 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1045 <CODE>protected &nbsp;void</CODE></FONT></TD>
1046 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshAdmins()">refreshAdmins</A></B>()</CODE>
1047
1048 <BR>
1049 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtains the most current list of admin <code>User</code> objects of 
1050  this server.</TD>
1051 </TR>
1052 <TR BGCOLOR="white" CLASS="TableRowColor">
1053 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1054 <CODE>protected &nbsp;void</CODE></FONT></TD>
1055 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshBinaryRestart()">refreshBinaryRestart</A></B>()</CODE>
1056
1057 <BR>
1058 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Refreshes the binary restart time fields of this <code>Server</code> 
1059  to reflect the current state of the AFS server.</TD>
1060 </TR>
1061 <TR BGCOLOR="white" CLASS="TableRowColor">
1062 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1063 <CODE>protected &nbsp;void</CODE></FONT></TD>
1064 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshGeneralRestart()">refreshGeneralRestart</A></B>()</CODE>
1065
1066 <BR>
1067 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Refreshes the general restart time fields of this <code>Server</code> 
1068  to reflect the current state of the AFS server.</TD>
1069 </TR>
1070 <TR BGCOLOR="white" CLASS="TableRowColor">
1071 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1072 <CODE>protected &nbsp;void</CODE></FONT></TD>
1073 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshInfo()">refreshInfo</A></B>()</CODE>
1074
1075 <BR>
1076 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Refreshes the information fields of this <code>Server</code> to 
1077  reflect the current state of the AFS server.  </TD>
1078 </TR>
1079 <TR BGCOLOR="white" CLASS="TableRowColor">
1080 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1081 <CODE>protected &nbsp;void</CODE></FONT></TD>
1082 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshKeys()">refreshKeys</A></B>()</CODE>
1083
1084 <BR>
1085 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtains the most current list of <code>Key</code> objects of this server.</TD>
1086 </TR>
1087 <TR BGCOLOR="white" CLASS="TableRowColor">
1088 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1089 <CODE>protected &nbsp;void</CODE></FONT></TD>
1090 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshPartitionNames()">refreshPartitionNames</A></B>()</CODE>
1091
1092 <BR>
1093 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtains the most current list of partition names of this server.</TD>
1094 </TR>
1095 <TR BGCOLOR="white" CLASS="TableRowColor">
1096 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1097 <CODE>protected &nbsp;void</CODE></FONT></TD>
1098 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshPartitions()">refreshPartitions</A></B>()</CODE>
1099
1100 <BR>
1101 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtains the most current list of <code>Partition</code> objects 
1102  of this server.</TD>
1103 </TR>
1104 <TR BGCOLOR="white" CLASS="TableRowColor">
1105 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1106 <CODE>protected &nbsp;void</CODE></FONT></TD>
1107 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshPartitions(boolean)">refreshPartitions</A></B>(boolean&nbsp;refreshVolumes)</CODE>
1108
1109 <BR>
1110 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtains the most current list of <code>Partition</code> objects of 
1111  this server.</TD>
1112 </TR>
1113 <TR BGCOLOR="white" CLASS="TableRowColor">
1114 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1115 <CODE>protected &nbsp;void</CODE></FONT></TD>
1116 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshProcesses()">refreshProcesses</A></B>()</CODE>
1117
1118 <BR>
1119 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtains the most current list of <code>Process</code> objects of 
1120  this server.</TD>
1121 </TR>
1122 <TR BGCOLOR="white" CLASS="TableRowColor">
1123 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1124 <CODE>protected &nbsp;void</CODE></FONT></TD>
1125 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#refreshProcessNames()">refreshProcessNames</A></B>()</CODE>
1126
1127 <BR>
1128 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtains the most current list of process names of this server.</TD>
1129 </TR>
1130 <TR BGCOLOR="white" CLASS="TableRowColor">
1131 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1132 <CODE>&nbsp;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>&nbsp;admin)</CODE>
1134
1135 <BR>
1136 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>
1139 </TR>
1140 <TR BGCOLOR="white" CLASS="TableRowColor">
1141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1142 <CODE>protected static&nbsp;void</CODE></FONT></TD>
1143 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#removeBosAdmin(int, java.lang.String)">removeBosAdmin</A></B>(int&nbsp;serverHandle,
1144                <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;adminName)</CODE>
1145
1146 <BR>
1147 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the given to name from the list of bos administrators on 
1148  that server.</TD>
1149 </TR>
1150 <TR BGCOLOR="white" CLASS="TableRowColor">
1151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1152 <CODE>&nbsp;void</CODE></FONT></TD>
1153 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#restartAllProcesses()">restartAllProcesses</A></B>()</CODE>
1154
1155 <BR>
1156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restarts all bos processes on this server.</TD>
1157 </TR>
1158 <TR BGCOLOR="white" CLASS="TableRowColor">
1159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1160 <CODE>protected static&nbsp;void</CODE></FONT></TD>
1161 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#restartAllProcesses(int, boolean)">restartAllProcesses</A></B>(int&nbsp;serverHandle,
1162                     boolean&nbsp;restartBosServer)</CODE>
1163
1164 <BR>
1165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restart all server processes.</TD>
1166 </TR>
1167 <TR BGCOLOR="white" CLASS="TableRowColor">
1168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1169 <CODE>&nbsp;void</CODE></FONT></TD>
1170 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#restartBosServer()">restartBosServer</A></B>()</CODE>
1171
1172 <BR>
1173 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restarts bos server and all bos processes on this server.</TD>
1174 </TR>
1175 <TR BGCOLOR="white" CLASS="TableRowColor">
1176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1177 <CODE>&nbsp;void</CODE></FONT></TD>
1178 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#salvage()">salvage</A></B>()</CODE>
1179
1180 <BR>
1181 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Salvages (restores consistency to) this server. </TD>
1182 </TR>
1183 <TR BGCOLOR="white" CLASS="TableRowColor">
1184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1185 <CODE>protected static&nbsp;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&nbsp;cellHandle,
1187         int&nbsp;serverHandle,
1188         <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;partitionName,
1189         <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;volName,
1190         int&nbsp;numSalvagers,
1191         <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;tempDir,
1192         <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;logFile,
1193         boolean&nbsp;inspectAllVolumes,
1194         boolean&nbsp;removeBadlyDamaged,
1195         boolean&nbsp;writeInodes,
1196         boolean&nbsp;writeRootInodes,
1197         boolean&nbsp;forceDirectory,
1198         boolean&nbsp;forceBlockReads)</CODE>
1199
1200 <BR>
1201 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Salvages (restores consistency to) a volume, partition, or server</TD>
1202 </TR>
1203 <TR BGCOLOR="white" CLASS="TableRowColor">
1204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1205 <CODE>&nbsp;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>&nbsp;executableTime)</CODE>
1207
1208 <BR>
1209 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the BOS binary restart time.   </TD>
1210 </TR>
1211 <TR BGCOLOR="white" CLASS="TableRowColor">
1212 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1213 <CODE>&nbsp;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>&nbsp;executableTime)</CODE>
1215
1216 <BR>
1217 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the BOS general restart time.   </TD>
1218 </TR>
1219 <TR BGCOLOR="white" CLASS="TableRowColor">
1220 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1221 <CODE>&nbsp;void</CODE></FONT></TD>
1222 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#startAllProcesses()">startAllProcesses</A></B>()</CODE>
1223
1224 <BR>
1225 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Starts up all bos processes on this server.</TD>
1226 </TR>
1227 <TR BGCOLOR="white" CLASS="TableRowColor">
1228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1229 <CODE>protected static&nbsp;void</CODE></FONT></TD>
1230 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#startAllProcesses(int)">startAllProcesses</A></B>(int&nbsp;serverHandle)</CODE>
1231
1232 <BR>
1233 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Start all server processes.</TD>
1234 </TR>
1235 <TR BGCOLOR="white" CLASS="TableRowColor">
1236 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1237 <CODE>&nbsp;void</CODE></FONT></TD>
1238 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#stopAllProcesses()">stopAllProcesses</A></B>()</CODE>
1239
1240 <BR>
1241 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stops all bos processes on this server.</TD>
1242 </TR>
1243 <TR BGCOLOR="white" CLASS="TableRowColor">
1244 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1245 <CODE>protected static&nbsp;void</CODE></FONT></TD>
1246 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#stopAllProcesses(int)">stopAllProcesses</A></B>(int&nbsp;serverHandle)</CODE>
1247
1248 <BR>
1249 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stop all server processes.</TD>
1250 </TR>
1251 <TR BGCOLOR="white" CLASS="TableRowColor">
1252 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1253 <CODE>&nbsp;void</CODE></FONT></TD>
1254 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#syncServer()">syncServer</A></B>()</CODE>
1255
1256 <BR>
1257 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Syncs this server to the VLDB.</TD>
1258 </TR>
1259 <TR BGCOLOR="white" CLASS="TableRowColor">
1260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1261 <CODE>protected static&nbsp;void</CODE></FONT></TD>
1262 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#syncServerWithVLDB(int, int, int)">syncServerWithVLDB</A></B>(int&nbsp;cellHandle,
1263                    int&nbsp;serverHandle,
1264                    int&nbsp;partition)</CODE>
1265
1266 <BR>
1267 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Synchronizes a particular server with the volume location database.</TD>
1268 </TR>
1269 <TR BGCOLOR="white" CLASS="TableRowColor">
1270 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1271 <CODE>&nbsp;void</CODE></FONT></TD>
1272 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#syncVLDB()">syncVLDB</A></B>()</CODE>
1273
1274 <BR>
1275 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Syncs the VLDB to this server.</TD>
1276 </TR>
1277 <TR BGCOLOR="white" CLASS="TableRowColor">
1278 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1279 <CODE>protected static&nbsp;void</CODE></FONT></TD>
1280 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Server.html#syncVLDBWithServer(int, int, int, boolean)">syncVLDBWithServer</A></B>(int&nbsp;cellHandle,
1281                    int&nbsp;serverHandle,
1282                    int&nbsp;partition,
1283                    boolean&nbsp;forceDeletion)</CODE>
1284
1285 <BR>
1286 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Synchronizes the volume location database with a particular server.</TD>
1287 </TR>
1288 <TR BGCOLOR="white" CLASS="TableRowColor">
1289 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1290 <CODE>&nbsp;<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>
1292
1293 <BR>
1294 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this <CODE>Server</CODE></TD>
1295 </TR>
1296 </TABLE>
1297 &nbsp;<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>
1301 </TR>
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>
1304 </TR>
1305 </TABLE>
1306 &nbsp;
1307 <P>
1308
1309 <!-- ============ FIELD DETAIL =========== -->
1310
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>
1316 </TR>
1317 </TABLE>
1318
1319 <A NAME="name"><!-- --></A><H3>
1320 name</H3>
1321 <PRE>
1322 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>name</B></PRE>
1323 <DL>
1324 <DL>
1325 </DL>
1326 </DL>
1327 <HR>
1328
1329 <A NAME="cell"><!-- --></A><H3>
1330 cell</H3>
1331 <PRE>
1332 protected <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> <B>cell</B></PRE>
1333 <DL>
1334 <DL>
1335 </DL>
1336 </DL>
1337 <HR>
1338
1339 <A NAME="vosHandle"><!-- --></A><H3>
1340 vosHandle</H3>
1341 <PRE>
1342 protected int <B>vosHandle</B></PRE>
1343 <DL>
1344 <DL>
1345 </DL>
1346 </DL>
1347 <HR>
1348
1349 <A NAME="bosHandle"><!-- --></A><H3>
1350 bosHandle</H3>
1351 <PRE>
1352 protected int <B>bosHandle</B></PRE>
1353 <DL>
1354 <DL>
1355 </DL>
1356 </DL>
1357 <HR>
1358
1359 <A NAME="database"><!-- --></A><H3>
1360 database</H3>
1361 <PRE>
1362 protected boolean <B>database</B></PRE>
1363 <DL>
1364 <DL>
1365 </DL>
1366 </DL>
1367 <HR>
1368
1369 <A NAME="fileServer"><!-- --></A><H3>
1370 fileServer</H3>
1371 <PRE>
1372 protected boolean <B>fileServer</B></PRE>
1373 <DL>
1374 <DL>
1375 </DL>
1376 </DL>
1377 <HR>
1378
1379 <A NAME="badFileServer"><!-- --></A><H3>
1380 badFileServer</H3>
1381 <PRE>
1382 protected boolean <B>badFileServer</B></PRE>
1383 <DL>
1384 <DL>
1385 </DL>
1386 </DL>
1387 <HR>
1388
1389 <A NAME="badDatabase"><!-- --></A><H3>
1390 badDatabase</H3>
1391 <PRE>
1392 protected boolean <B>badDatabase</B></PRE>
1393 <DL>
1394 <DL>
1395 </DL>
1396 </DL>
1397 <HR>
1398
1399 <A NAME="ipAddresses"><!-- --></A><H3>
1400 ipAddresses</H3>
1401 <PRE>
1402 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[] <B>ipAddresses</B></PRE>
1403 <DL>
1404 <DL>
1405 </DL>
1406 </DL>
1407 <HR>
1408
1409 <A NAME="partitionNames"><!-- --></A><H3>
1410 partitionNames</H3>
1411 <PRE>
1412 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>partitionNames</B></PRE>
1413 <DL>
1414 <DL>
1415 </DL>
1416 </DL>
1417 <HR>
1418
1419 <A NAME="partitions"><!-- --></A><H3>
1420 partitions</H3>
1421 <PRE>
1422 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>partitions</B></PRE>
1423 <DL>
1424 <DL>
1425 </DL>
1426 </DL>
1427 <HR>
1428
1429 <A NAME="adminNames"><!-- --></A><H3>
1430 adminNames</H3>
1431 <PRE>
1432 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>adminNames</B></PRE>
1433 <DL>
1434 <DL>
1435 </DL>
1436 </DL>
1437 <HR>
1438
1439 <A NAME="admins"><!-- --></A><H3>
1440 admins</H3>
1441 <PRE>
1442 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>admins</B></PRE>
1443 <DL>
1444 <DL>
1445 </DL>
1446 </DL>
1447 <HR>
1448
1449 <A NAME="keys"><!-- --></A><H3>
1450 keys</H3>
1451 <PRE>
1452 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>keys</B></PRE>
1453 <DL>
1454 <DL>
1455 </DL>
1456 </DL>
1457 <HR>
1458
1459 <A NAME="processNames"><!-- --></A><H3>
1460 processNames</H3>
1461 <PRE>
1462 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>processNames</B></PRE>
1463 <DL>
1464 <DL>
1465 </DL>
1466 </DL>
1467 <HR>
1468
1469 <A NAME="processes"><!-- --></A><H3>
1470 processes</H3>
1471 <PRE>
1472 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>processes</B></PRE>
1473 <DL>
1474 <DL>
1475 </DL>
1476 </DL>
1477 <HR>
1478
1479 <A NAME="totalSpace"><!-- --></A><H3>
1480 totalSpace</H3>
1481 <PRE>
1482 protected int <B>totalSpace</B></PRE>
1483 <DL>
1484 <DL>
1485 </DL>
1486 </DL>
1487 <HR>
1488
1489 <A NAME="totalQuota"><!-- --></A><H3>
1490 totalQuota</H3>
1491 <PRE>
1492 protected int <B>totalQuota</B></PRE>
1493 <DL>
1494 <DL>
1495 </DL>
1496 </DL>
1497 <HR>
1498
1499 <A NAME="totalFreeSpace"><!-- --></A><H3>
1500 totalFreeSpace</H3>
1501 <PRE>
1502 protected int <B>totalFreeSpace</B></PRE>
1503 <DL>
1504 <DL>
1505 </DL>
1506 </DL>
1507 <HR>
1508
1509 <A NAME="totalUsedSpace"><!-- --></A><H3>
1510 totalUsedSpace</H3>
1511 <PRE>
1512 protected int <B>totalUsedSpace</B></PRE>
1513 <DL>
1514 <DL>
1515 </DL>
1516 </DL>
1517 <HR>
1518
1519 <A NAME="genRestartTime"><!-- --></A><H3>
1520 genRestartTime</H3>
1521 <PRE>
1522 protected <A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A> <B>genRestartTime</B></PRE>
1523 <DL>
1524 <DL>
1525 </DL>
1526 </DL>
1527 <HR>
1528
1529 <A NAME="binRestartTime"><!-- --></A><H3>
1530 binRestartTime</H3>
1531 <PRE>
1532 protected <A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A> <B>binRestartTime</B></PRE>
1533 <DL>
1534 <DL>
1535 </DL>
1536 </DL>
1537 <HR>
1538
1539 <A NAME="cachedInfo"><!-- --></A><H3>
1540 cachedInfo</H3>
1541 <PRE>
1542 protected boolean <B>cachedInfo</B></PRE>
1543 <DL>
1544 <DL>
1545 </DL>
1546 </DL>
1547
1548 <!-- ========= CONSTRUCTOR DETAIL ======== -->
1549
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>
1555 </TR>
1556 </TABLE>
1557
1558 <A NAME="Server(java.lang.String, org.openafs.jafs.Cell)"><!-- --></A><H3>
1559 Server</H3>
1560 <PRE>
1561 public <B>Server</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
1562               <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A>&nbsp;cell)
1563        throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1564 <DL>
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 
1571  object.
1572 <P>
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.
1574 <DT><B>Throws:</B>
1575 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1576 <HR>
1577
1578 <A NAME="Server(java.lang.String, org.openafs.jafs.Cell, boolean)"><!-- --></A><H3>
1579 Server</H3>
1580 <PRE>
1581 public <B>Server</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
1582               <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A>&nbsp;cell,
1583               boolean&nbsp;preloadAllMembers)
1584        throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1585 <DL>
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 
1592  object.
1593
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 
1598  coherency concerns.
1599 <P>
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.
1604 <DT><B>Throws:</B>
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>
1606 <HR>
1607
1608 <A NAME="Server(org.openafs.jafs.Cell)"><!-- --></A><H3>
1609 Server</H3>
1610 <PRE>
1611 <B>Server</B>(<A HREF="../../../org/openafs/jafs/Cell.html">Cell</A>&nbsp;cell)
1612  throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1613 <DL>
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.
1617 <P>
1618 <DT><B>Parameters:</B><DD><CODE>cell</CODE> - the cell to which the server belongs.
1619 <DT><B>Throws:</B>
1620 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1621
1622 <!-- ============ METHOD DETAIL ========== -->
1623
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>
1629 </TR>
1630 </TABLE>
1631
1632 <A NAME="refresh()"><!-- --></A><H3>
1633 refresh</H3>
1634 <PRE>
1635 public void <B>refresh</B>()
1636              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1637 <DL>
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.
1642
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 
1652  unnecessary.
1653 <P>
1654 <DD><DL>
1655 </DL>
1656 </DD>
1657 <DD><DL>
1658
1659 <DT><B>Throws:</B>
1660 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1661 </DD>
1662 </DL>
1663 <HR>
1664
1665 <A NAME="refresh(boolean)"><!-- --></A><H3>
1666 refresh</H3>
1667 <PRE>
1668 protected void <B>refresh</B>(boolean&nbsp;all)
1669                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1670 <DL>
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.
1676
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.
1681 <P>
1682 <DD><DL>
1683 </DL>
1684 </DD>
1685 <DD><DL>
1686 <DT><B>Parameters:</B><DD><CODE>all</CODE> - if true set or renew all object properties; 
1687               otherwise renew all set properties
1688 <DT><B>Throws:</B>
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>
1690 </DD>
1691 </DL>
1692 <HR>
1693
1694 <A NAME="refreshInfo()"><!-- --></A><H3>
1695 refreshInfo</H3>
1696 <PRE>
1697 protected void <B>refreshInfo</B>()
1698                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1699 <DL>
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.
1703 <P>
1704 <DD><DL>
1705 </DL>
1706 </DD>
1707 <DD><DL>
1708
1709 <DT><B>Throws:</B>
1710 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1711 </DD>
1712 </DL>
1713 <HR>
1714
1715 <A NAME="refreshGeneralRestart()"><!-- --></A><H3>
1716 refreshGeneralRestart</H3>
1717 <PRE>
1718 protected void <B>refreshGeneralRestart</B>()
1719                               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1720 <DL>
1721 <DD>Refreshes the general restart time fields of this <code>Server</code> 
1722  to reflect the current state of the AFS server.
1723 <P>
1724 <DD><DL>
1725 </DL>
1726 </DD>
1727 <DD><DL>
1728
1729 <DT><B>Throws:</B>
1730 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1731 </DD>
1732 </DL>
1733 <HR>
1734
1735 <A NAME="refreshBinaryRestart()"><!-- --></A><H3>
1736 refreshBinaryRestart</H3>
1737 <PRE>
1738 protected void <B>refreshBinaryRestart</B>()
1739                              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1740 <DL>
1741 <DD>Refreshes the binary restart time fields of this <code>Server</code> 
1742  to reflect the current state of the AFS server.
1743 <P>
1744 <DD><DL>
1745 </DL>
1746 </DD>
1747 <DD><DL>
1748
1749 <DT><B>Throws:</B>
1750 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1751 </DD>
1752 </DL>
1753 <HR>
1754
1755 <A NAME="refreshPartitions()"><!-- --></A><H3>
1756 refreshPartitions</H3>
1757 <PRE>
1758 protected void <B>refreshPartitions</B>()
1759                           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1760 <DL>
1761 <DD>Obtains the most current list of <code>Partition</code> objects 
1762  of this server.
1763 <P>
1764 <DD><DL>
1765 </DL>
1766 </DD>
1767 <DD><DL>
1768
1769 <DT><B>Throws:</B>
1770 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1771 </DD>
1772 </DL>
1773 <HR>
1774
1775 <A NAME="refreshPartitions(boolean)"><!-- --></A><H3>
1776 refreshPartitions</H3>
1777 <PRE>
1778 protected void <B>refreshPartitions</B>(boolean&nbsp;refreshVolumes)
1779                           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1780 <DL>
1781 <DD>Obtains the most current list of <code>Partition</code> objects of 
1782  this server.
1783 <P>
1784 <DD><DL>
1785 </DL>
1786 </DD>
1787 <DD><DL>
1788 <DT><B>Parameters:</B><DD><CODE>refreshVolumes</CODE> - force all volumes contained in each 
1789                        partition to be refreshed.
1790 <DT><B>Throws:</B>
1791 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1792 </DD>
1793 </DL>
1794 <HR>
1795
1796 <A NAME="refreshPartitionNames()"><!-- --></A><H3>
1797 refreshPartitionNames</H3>
1798 <PRE>
1799 protected void <B>refreshPartitionNames</B>()
1800                               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1801 <DL>
1802 <DD>Obtains the most current list of partition names of this server.
1803 <P>
1804 <DD><DL>
1805 </DL>
1806 </DD>
1807 <DD><DL>
1808
1809 <DT><B>Throws:</B>
1810 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1811 </DD>
1812 </DL>
1813 <HR>
1814
1815 <A NAME="refreshAdminNames()"><!-- --></A><H3>
1816 refreshAdminNames</H3>
1817 <PRE>
1818 protected void <B>refreshAdminNames</B>()
1819                           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1820 <DL>
1821 <DD>Obtains the most current list of bos admin names of this server.
1822 <P>
1823 <DD><DL>
1824 </DL>
1825 </DD>
1826 <DD><DL>
1827
1828 <DT><B>Throws:</B>
1829 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1830 </DD>
1831 </DL>
1832 <HR>
1833
1834 <A NAME="refreshAdmins()"><!-- --></A><H3>
1835 refreshAdmins</H3>
1836 <PRE>
1837 protected void <B>refreshAdmins</B>()
1838                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1839 <DL>
1840 <DD>Obtains the most current list of admin <code>User</code> objects of 
1841  this server.
1842 <P>
1843 <DD><DL>
1844 </DL>
1845 </DD>
1846 <DD><DL>
1847
1848 <DT><B>Throws:</B>
1849 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1850 </DD>
1851 </DL>
1852 <HR>
1853
1854 <A NAME="refreshKeys()"><!-- --></A><H3>
1855 refreshKeys</H3>
1856 <PRE>
1857 protected void <B>refreshKeys</B>()
1858                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1859 <DL>
1860 <DD>Obtains the most current list of <code>Key</code> objects of this server.
1861 <P>
1862 <DD><DL>
1863 </DL>
1864 </DD>
1865 <DD><DL>
1866
1867 <DT><B>Throws:</B>
1868 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1869 </DD>
1870 </DL>
1871 <HR>
1872
1873 <A NAME="refreshProcessNames()"><!-- --></A><H3>
1874 refreshProcessNames</H3>
1875 <PRE>
1876 protected void <B>refreshProcessNames</B>()
1877                             throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1878 <DL>
1879 <DD>Obtains the most current list of process names of this server.
1880 <P>
1881 <DD><DL>
1882 </DL>
1883 </DD>
1884 <DD><DL>
1885
1886 <DT><B>Throws:</B>
1887 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1888 </DD>
1889 </DL>
1890 <HR>
1891
1892 <A NAME="refreshProcesses()"><!-- --></A><H3>
1893 refreshProcesses</H3>
1894 <PRE>
1895 protected void <B>refreshProcesses</B>()
1896                          throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1897 <DL>
1898 <DD>Obtains the most current list of <code>Process</code> objects of 
1899  this server.
1900 <P>
1901 <DD><DL>
1902 </DL>
1903 </DD>
1904 <DD><DL>
1905
1906 <DT><B>Throws:</B>
1907 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1908 </DD>
1909 </DL>
1910 <HR>
1911
1912 <A NAME="addAdmin(org.openafs.jafs.User)"><!-- --></A><H3>
1913 addAdmin</H3>
1914 <PRE>
1915 public void <B>addAdmin</B>(<A HREF="../../../org/openafs/jafs/User.html">User</A>&nbsp;admin)
1916               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1917 <DL>
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.
1921 <P>
1922 <DD><DL>
1923 </DL>
1924 </DD>
1925 <DD><DL>
1926 <DT><B>Parameters:</B><DD><CODE>admin</CODE> - the admin to add
1927 <DT><B>Throws:</B>
1928 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1929 </DD>
1930 </DL>
1931 <HR>
1932
1933 <A NAME="removeAdmin(org.openafs.jafs.User)"><!-- --></A><H3>
1934 removeAdmin</H3>
1935 <PRE>
1936 public void <B>removeAdmin</B>(<A HREF="../../../org/openafs/jafs/User.html">User</A>&nbsp;admin)
1937                  throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1938 <DL>
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.
1942 <P>
1943 <DD><DL>
1944 </DL>
1945 </DD>
1946 <DD><DL>
1947 <DT><B>Parameters:</B><DD><CODE>admin</CODE> - the admin to remove
1948 <DT><B>Throws:</B>
1949 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1950 </DD>
1951 </DL>
1952 <HR>
1953
1954 <A NAME="syncServer()"><!-- --></A><H3>
1955 syncServer</H3>
1956 <PRE>
1957 public void <B>syncServer</B>()
1958                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1959 <DL>
1960 <DD>Syncs this server to the VLDB.
1961 <P>
1962 <DD><DL>
1963 </DL>
1964 </DD>
1965 <DD><DL>
1966
1967 <DT><B>Throws:</B>
1968 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1969 </DD>
1970 </DL>
1971 <HR>
1972
1973 <A NAME="syncVLDB()"><!-- --></A><H3>
1974 syncVLDB</H3>
1975 <PRE>
1976 public void <B>syncVLDB</B>()
1977               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1978 <DL>
1979 <DD>Syncs the VLDB to this server.
1980 <P>
1981 <DD><DL>
1982 </DL>
1983 </DD>
1984 <DD><DL>
1985
1986 <DT><B>Throws:</B>
1987 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1988 </DD>
1989 </DL>
1990 <HR>
1991
1992 <A NAME="salvage()"><!-- --></A><H3>
1993 salvage</H3>
1994 <PRE>
1995 public void <B>salvage</B>()
1996              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1997 <DL>
1998 <DD>Salvages (restores consistency to) this server. Uses default values for
1999  most salvager options in order to simplify the API.
2000 <P>
2001 <DD><DL>
2002 </DL>
2003 </DD>
2004 <DD><DL>
2005
2006 <DT><B>Throws:</B>
2007 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2008 </DD>
2009 </DL>
2010 <HR>
2011
2012 <A NAME="startAllProcesses()"><!-- --></A><H3>
2013 startAllProcesses</H3>
2014 <PRE>
2015 public void <B>startAllProcesses</B>()
2016                        throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2017 <DL>
2018 <DD>Starts up all bos processes on this server.
2019 <P>
2020 <DD><DL>
2021 </DL>
2022 </DD>
2023 <DD><DL>
2024
2025 <DT><B>Throws:</B>
2026 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2027 </DD>
2028 </DL>
2029 <HR>
2030
2031 <A NAME="stopAllProcesses()"><!-- --></A><H3>
2032 stopAllProcesses</H3>
2033 <PRE>
2034 public void <B>stopAllProcesses</B>()
2035                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2036 <DL>
2037 <DD>Stops all bos processes on this server.
2038 <P>
2039 <DD><DL>
2040 </DL>
2041 </DD>
2042 <DD><DL>
2043
2044 <DT><B>Throws:</B>
2045 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2046 </DD>
2047 </DL>
2048 <HR>
2049
2050 <A NAME="restartAllProcesses()"><!-- --></A><H3>
2051 restartAllProcesses</H3>
2052 <PRE>
2053 public void <B>restartAllProcesses</B>()
2054                          throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2055 <DL>
2056 <DD>Restarts all bos processes on this server.
2057 <P>
2058 <DD><DL>
2059 </DL>
2060 </DD>
2061 <DD><DL>
2062
2063 <DT><B>Throws:</B>
2064 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2065 </DD>
2066 </DL>
2067 <HR>
2068
2069 <A NAME="restartBosServer()"><!-- --></A><H3>
2070 restartBosServer</H3>
2071 <PRE>
2072 public void <B>restartBosServer</B>()
2073                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2074 <DL>
2075 <DD>Restarts bos server and all bos processes on this server.
2076 <P>
2077 <DD><DL>
2078 </DL>
2079 </DD>
2080 <DD><DL>
2081
2082 <DT><B>Throws:</B>
2083 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2084 </DD>
2085 </DL>
2086 <HR>
2087
2088 <A NAME="getLog(java.lang.String)"><!-- --></A><H3>
2089 getLog</H3>
2090 <PRE>
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>&nbsp;logLocation)
2092               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2093 <DL>
2094 <DD>Gets the contents of a log file, in one large <code>String</code>.  
2095  The log cannot be in AFS file space.
2096 <P>
2097 <DD><DL>
2098 </DL>
2099 </DD>
2100 <DD><DL>
2101
2102 <DT><B>Returns:</B><DD>a <code>String</code> containing the contents of the log file
2103 <DT><B>Throws:</B>
2104 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2105 </DD>
2106 </DL>
2107 <HR>
2108
2109 <A NAME="close()"><!-- --></A><H3>
2110 close</H3>
2111 <PRE>
2112 public void <B>close</B>()
2113            throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2114 <DL>
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.
2121 <P>
2122 <DD><DL>
2123 </DL>
2124 </DD>
2125 <DD><DL>
2126
2127 <DT><B>Throws:</B>
2128 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2129 </DD>
2130 </DL>
2131 <HR>
2132
2133 <A NAME="getName()"><!-- --></A><H3>
2134 getName</H3>
2135 <PRE>
2136 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>
2137 <DL>
2138 <DD>Returns the name of this server.
2139 <P>
2140 <DD><DL>
2141 </DL>
2142 </DD>
2143 <DD><DL>
2144
2145 <DT><B>Returns:</B><DD>the name of this server</DL>
2146 </DD>
2147 </DL>
2148 <HR>
2149
2150 <A NAME="getCell()"><!-- --></A><H3>
2151 getCell</H3>
2152 <PRE>
2153 public <A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> <B>getCell</B>()</PRE>
2154 <DL>
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
2157  server belongs.
2158 <P>
2159 <DD><DL>
2160 </DL>
2161 </DD>
2162 <DD><DL>
2163
2164 <DT><B>Returns:</B><DD>this server's cell</DL>
2165 </DD>
2166 </DL>
2167 <HR>
2168
2169 <A NAME="getAdminCount()"><!-- --></A><H3>
2170 getAdminCount</H3>
2171 <PRE>
2172 public int <B>getAdminCount</B>()
2173                   throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2174 <DL>
2175 <DD>Returns the number of BOS administrators assigned to this server.
2176
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.
2181
2182  <P> The product of this method is not saved, and is recalculated
2183  with every call.
2184 <P>
2185 <DD><DL>
2186 </DL>
2187 </DD>
2188 <DD><DL>
2189
2190 <DT><B>Returns:</B><DD>the number of admins on this server.
2191 <DT><B>Throws:</B>
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>
2195 </DD>
2196 </DL>
2197 <HR>
2198
2199 <A NAME="getAdmins()"><!-- --></A><H3>
2200 getAdmins</H3>
2201 <PRE>
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>
2204 <DL>
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 
2211  is obtained.
2212 <P>
2213 <DD><DL>
2214 </DL>
2215 </DD>
2216 <DD><DL>
2217
2218 <DT><B>Returns:</B><DD>a <code>User</code> array of the admins of the server.
2219 <DT><B>Throws:</B>
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>
2221 </DD>
2222 </DL>
2223 <HR>
2224
2225 <A NAME="getAdminNames()"><!-- --></A><H3>
2226 getAdminNames</H3>
2227 <PRE>
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>
2230 <DL>
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.
2236 <P>
2237 <DD><DL>
2238 </DL>
2239 </DD>
2240 <DD><DL>
2241
2242 <DT><B>Returns:</B><DD>a <code>String</code> array of the bos admin of the server.
2243 <DT><B>Throws:</B>
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>
2245 </DD>
2246 </DL>
2247 <HR>
2248
2249 <A NAME="getPartitionCount()"><!-- --></A><H3>
2250 getPartitionCount</H3>
2251 <PRE>
2252 public int <B>getPartitionCount</B>()
2253                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2254 <DL>
2255 <DD>Returns the number of partitions on this server.
2256
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.
2261
2262  <P> The product of this method is not saved, and is recalculated
2263  with every call.
2264 <P>
2265 <DD><DL>
2266 </DL>
2267 </DD>
2268 <DD><DL>
2269
2270 <DT><B>Returns:</B><DD>the number of partitions on this server.
2271 <DT><B>Throws:</B>
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>
2275 </DD>
2276 </DL>
2277 <HR>
2278
2279 <A NAME="getPartition(java.lang.String)"><!-- --></A><H3>
2280 getPartition</H3>
2281 <PRE>
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>&nbsp;name)
2283                        throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2284 <DL>
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
2290  thrown.
2291 <P>
2292 <DD><DL>
2293 </DL>
2294 </DD>
2295 <DD><DL>
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>.
2298 <DT><B>Throws:</B>
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>
2302 </DD>
2303 </DL>
2304 <HR>
2305
2306 <A NAME="getPartitions()"><!-- --></A><H3>
2307 getPartitions</H3>
2308 <PRE>
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>
2311 <DL>
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 
2318  is obtained.
2319 <P>
2320 <DD><DL>
2321 </DL>
2322 </DD>
2323 <DD><DL>
2324
2325 <DT><B>Returns:</B><DD>a <code>Partition</code> array of the <code>Partition</code> 
2326          objects of the server.
2327 <DT><B>Throws:</B>
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>
2329 </DD>
2330 </DL>
2331 <HR>
2332
2333 <A NAME="getPartitionNames()"><!-- --></A><H3>
2334 getPartitionNames</H3>
2335 <PRE>
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>
2338 <DL>
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 
2344  list is obtained.
2345 <P>
2346 <DD><DL>
2347 </DL>
2348 </DD>
2349 <DD><DL>
2350
2351 <DT><B>Returns:</B><DD>a <code>String</code> array of the partitions of the server.
2352 <DT><B>Throws:</B>
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>
2354 </DD>
2355 </DL>
2356 <HR>
2357
2358 <A NAME="getKey(int)"><!-- --></A><H3>
2359 getKey</H3>
2360 <PRE>
2361 public <A HREF="../../../org/openafs/jafs/Key.html">Key</A> <B>getKey</B>(int&nbsp;keyVersion)
2362            throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2363 <DL>
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.
2369 <P>
2370 <DD><DL>
2371 </DL>
2372 </DD>
2373 <DD><DL>
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>.
2376 <DT><B>Throws:</B>
2377 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2378 </DD>
2379 </DL>
2380 <HR>
2381
2382 <A NAME="getKeyCount()"><!-- --></A><H3>
2383 getKeyCount</H3>
2384 <PRE>
2385 public int <B>getKeyCount</B>()
2386                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2387 <DL>
2388 <DD>Returns the number of keys on this server.
2389
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.
2394
2395  <P> The product of this method is not saved, and is recalculated
2396  with every call.
2397 <P>
2398 <DD><DL>
2399 </DL>
2400 </DD>
2401 <DD><DL>
2402
2403 <DT><B>Returns:</B><DD>the number of keys on this server.
2404 <DT><B>Throws:</B>
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>
2407 </DD>
2408 </DL>
2409 <HR>
2410
2411 <A NAME="getKeys()"><!-- --></A><H3>
2412 getKeys</H3>
2413 <PRE>
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>
2416 <DL>
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 
2423  is obtained.
2424 <P>
2425 <DD><DL>
2426 </DL>
2427 </DD>
2428 <DD><DL>
2429
2430 <DT><B>Returns:</B><DD>a <code>Key</code> array of the <code>Key</code> objects 
2431          of the server.
2432 <DT><B>Throws:</B>
2433 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Server.html#refresh()"><CODE>refresh()</CODE></A></DL>
2434 </DD>
2435 </DL>
2436 <HR>
2437
2438 <A NAME="getProcess(java.lang.String)"><!-- --></A><H3>
2439 getProcess</H3>
2440 <PRE>
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>&nbsp;name)
2442                    throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2443 <DL>
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
2449  thrown.
2450 <P>
2451 <DD><DL>
2452 </DL>
2453 </DD>
2454 <DD><DL>
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>.
2457 <DT><B>Throws:</B>
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>
2461 </DD>
2462 </DL>
2463 <HR>
2464
2465 <A NAME="getProcessCount()"><!-- --></A><H3>
2466 getProcessCount</H3>
2467 <PRE>
2468 public int <B>getProcessCount</B>()
2469                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2470 <DL>
2471 <DD>Returns the number of processes hosted by this server.
2472
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.
2477
2478  <P> The product of this method is not saved, and is recalculated
2479  with every call.
2480 <P>
2481 <DD><DL>
2482 </DL>
2483 </DD>
2484 <DD><DL>
2485
2486 <DT><B>Returns:</B><DD>the number of processes on this server.
2487 <DT><B>Throws:</B>
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>
2491 </DD>
2492 </DL>
2493 <HR>
2494
2495 <A NAME="getProcesses()"><!-- --></A><H3>
2496 getProcesses</H3>
2497 <PRE>
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>
2500 <DL>
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 
2507  is obtained.
2508 <P>
2509 <DD><DL>
2510 </DL>
2511 </DD>
2512 <DD><DL>
2513
2514 <DT><B>Returns:</B><DD>a <code>Process</code> array of the <code>Process</code> 
2515          objects of the server.
2516 <DT><B>Throws:</B>
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>
2518 </DD>
2519 </DL>
2520 <HR>
2521
2522 <A NAME="getProcessNames()"><!-- --></A><H3>
2523 getProcessNames</H3>
2524 <PRE>
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>
2527 <DL>
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 
2533  list is obtained.
2534 <P>
2535 <DD><DL>
2536 </DL>
2537 </DD>
2538 <DD><DL>
2539
2540 <DT><B>Returns:</B><DD>a <code>String</code> array of the processes of the server.
2541 <DT><B>Throws:</B>
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>
2543 </DD>
2544 </DL>
2545 <HR>
2546
2547 <A NAME="isDatabase()"><!-- --></A><H3>
2548 isDatabase</H3>
2549 <PRE>
2550 public boolean <B>isDatabase</B>()
2551                    throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2552 <DL>
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 
2555  elections.
2556 <P>
2557 <DD><DL>
2558 </DL>
2559 </DD>
2560 <DD><DL>
2561
2562 <DT><B>Returns:</B><DD>whether or not this user this server is a database machine.
2563 <DT><B>Throws:</B>
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>
2565 </DD>
2566 </DL>
2567 <HR>
2568
2569 <A NAME="isFileServer()"><!-- --></A><H3>
2570 isFileServer</H3>
2571 <PRE>
2572 public boolean <B>isFileServer</B>()
2573                      throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2574 <DL>
2575 <DD>Returns whether or not this server is a file server machine, meaning it
2576  runs the "fs" process and stores AFS volumes.
2577 <P>
2578 <DD><DL>
2579 </DL>
2580 </DD>
2581 <DD><DL>
2582
2583 <DT><B>Returns:</B><DD>whether or not this user this server is a file server machine.
2584 <DT><B>Throws:</B>
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>
2586 </DD>
2587 </DL>
2588 <HR>
2589
2590 <A NAME="isBadDatabase()"><!-- --></A><H3>
2591 isBadDatabase</H3>
2592 <PRE>
2593 public boolean <B>isBadDatabase</B>()
2594                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2595 <DL>
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.
2599 <P>
2600 <DD><DL>
2601 </DL>
2602 </DD>
2603 <DD><DL>
2604
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
2607 <DT><B>Throws:</B>
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>
2609 </DD>
2610 </DL>
2611 <HR>
2612
2613 <A NAME="isBadFileServer()"><!-- --></A><H3>
2614 isBadFileServer</H3>
2615 <PRE>
2616 public boolean <B>isBadFileServer</B>()
2617                         throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2618 <DL>
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.
2622 <P>
2623 <DD><DL>
2624 </DL>
2625 </DD>
2626 <DD><DL>
2627
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
2630 <DT><B>Throws:</B>
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>
2632 </DD>
2633 </DL>
2634 <HR>
2635
2636 <A NAME="getIPAddresses()"><!-- --></A><H3>
2637 getIPAddresses</H3>
2638 <PRE>
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>
2641 <DL>
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).
2644 <P>
2645 <DD><DL>
2646 </DL>
2647 </DD>
2648 <DD><DL>
2649
2650 <DT><B>Returns:</B><DD>this server's IP address as a String
2651 <DT><B>Throws:</B>
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>
2653 </DD>
2654 </DL>
2655 <HR>
2656
2657 <A NAME="getGeneralRestartTime()"><!-- --></A><H3>
2658 getGeneralRestartTime</H3>
2659 <PRE>
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>
2662 <DL>
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.
2669 <P>
2670 <DD><DL>
2671 </DL>
2672 </DD>
2673 <DD><DL>
2674
2675 <DT><B>Returns:</B><DD>the general restart time
2676 <DT><B>Throws:</B>
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>
2679 </DD>
2680 </DL>
2681 <HR>
2682
2683 <A NAME="getBinaryRestartTime()"><!-- --></A><H3>
2684 getBinaryRestartTime</H3>
2685 <PRE>
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>
2688 <DL>
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.
2695 <P>
2696 <DD><DL>
2697 </DL>
2698 </DD>
2699 <DD><DL>
2700
2701 <DT><B>Returns:</B><DD>the binary restart time
2702 <DT><B>Throws:</B>
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>
2705 </DD>
2706 </DL>
2707 <HR>
2708
2709 <A NAME="getTotalSpace()"><!-- --></A><H3>
2710 getTotalSpace</H3>
2711 <PRE>
2712 public int <B>getTotalSpace</B>()
2713                   throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2714 <DL>
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.
2721 <P>
2722 <DD><DL>
2723 </DL>
2724 </DD>
2725 <DD><DL>
2726
2727 <DT><B>Returns:</B><DD>the total space on this server
2728 <DT><B>Throws:</B>
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>
2730 </DD>
2731 </DL>
2732 <HR>
2733
2734 <A NAME="getTotalFreeSpace()"><!-- --></A><H3>
2735 getTotalFreeSpace</H3>
2736 <PRE>
2737 public int <B>getTotalFreeSpace</B>()
2738                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2739 <DL>
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.
2746 <P>
2747 <DD><DL>
2748 </DL>
2749 </DD>
2750 <DD><DL>
2751
2752 <DT><B>Returns:</B><DD>the total free space on this server
2753 <DT><B>Throws:</B>
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>
2755 </DD>
2756 </DL>
2757 <HR>
2758
2759 <A NAME="getTotalUsedSpace()"><!-- --></A><H3>
2760 getTotalUsedSpace</H3>
2761 <PRE>
2762 public int <B>getTotalUsedSpace</B>()
2763                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2764 <DL>
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.
2771 <P>
2772 <DD><DL>
2773 </DL>
2774 </DD>
2775 <DD><DL>
2776
2777 <DT><B>Returns:</B><DD>the total space on this partition
2778 <DT><B>Throws:</B>
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>
2781 </DD>
2782 </DL>
2783 <HR>
2784
2785 <A NAME="getVosHandle()"><!-- --></A><H3>
2786 getVosHandle</H3>
2787 <PRE>
2788 protected int <B>getVosHandle</B>()
2789                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2790 <DL>
2791 <DD>Returns this server's vos handle.
2792 <P>
2793 <DD><DL>
2794 </DL>
2795 </DD>
2796 <DD><DL>
2797
2798 <DT><B>Returns:</B><DD>this server's vos handle
2799 <DT><B>Throws:</B>
2800 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2801 </DD>
2802 </DL>
2803 <HR>
2804
2805 <A NAME="getBosHandle()"><!-- --></A><H3>
2806 getBosHandle</H3>
2807 <PRE>
2808 protected int <B>getBosHandle</B>()
2809                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2810 <DL>
2811 <DD>Returns this server's bos handle.
2812 <P>
2813 <DD><DL>
2814 </DL>
2815 </DD>
2816 <DD><DL>
2817
2818 <DT><B>Returns:</B><DD>this server's bos handle
2819 <DT><B>Throws:</B>
2820 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2821 </DD>
2822 </DL>
2823 <HR>
2824
2825 <A NAME="setGeneralRestartTime(org.openafs.jafs.Server.ExecutableTime)"><!-- --></A><H3>
2826 setGeneralRestartTime</H3>
2827 <PRE>
2828 public void <B>setGeneralRestartTime</B>(<A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A>&nbsp;executableTime)
2829                            throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2830 <DL>
2831 <DD>Sets the BOS general restart time.   This is the time at which the bos 
2832  server restarts itself and all running processes.
2833 <P>
2834 <DD><DL>
2835 </DL>
2836 </DD>
2837 <DD><DL>
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.
2840 <DT><B>Throws:</B>
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>
2842 </DD>
2843 </DL>
2844 <HR>
2845
2846 <A NAME="setBinaryRestartTime(org.openafs.jafs.Server.ExecutableTime)"><!-- --></A><H3>
2847 setBinaryRestartTime</H3>
2848 <PRE>
2849 public void <B>setBinaryRestartTime</B>(<A HREF="../../../org/openafs/jafs/Server.ExecutableTime.html">Server.ExecutableTime</A>&nbsp;executableTime)
2850                           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2851 <DL>
2852 <DD>Sets the BOS binary restart time.   This is the time at which all new 
2853  or newly modified AFS binaries are restarted.
2854 <P>
2855 <DD><DL>
2856 </DL>
2857 </DD>
2858 <DD><DL>
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.
2861 <DT><B>Throws:</B>
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>
2863 </DD>
2864 </DL>
2865 <HR>
2866
2867 <A NAME="getInfo()"><!-- --></A><H3>
2868 getInfo</H3>
2869 <PRE>
2870 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getInfo</B>()</PRE>
2871 <DL>
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 
2874  processes.
2875 <P>
2876 <DD><DL>
2877 </DL>
2878 </DD>
2879 <DD><DL>
2880
2881 <DT><B>Returns:</B><DD>a <code>String</code> representation of the <code>Server</code></DL>
2882 </DD>
2883 </DL>
2884 <HR>
2885
2886 <A NAME="getInfoPartitions()"><!-- --></A><H3>
2887 getInfoPartitions</H3>
2888 <PRE>
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>
2891 <DL>
2892 <DD>Returns a <code>String</code> containing the <code>String</code> 
2893  representations of all the partitions of this <code>Server</code>.
2894 <P>
2895 <DD><DL>
2896 </DL>
2897 </DD>
2898 <DD><DL>
2899
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>
2902 </DD>
2903 </DL>
2904 <HR>
2905
2906 <A NAME="getInfoKeys()"><!-- --></A><H3>
2907 getInfoKeys</H3>
2908 <PRE>
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>
2911 <DL>
2912 <DD>Returns a <code>String</code> containing the <code>String</code> 
2913  representations of all the keys of this <code>Server</code>.
2914 <P>
2915 <DD><DL>
2916 </DL>
2917 </DD>
2918 <DD><DL>
2919
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>
2922 </DD>
2923 </DL>
2924 <HR>
2925
2926 <A NAME="getInfoProcesses()"><!-- --></A><H3>
2927 getInfoProcesses</H3>
2928 <PRE>
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>
2931 <DL>
2932 <DD>Returns a <code>String</code> containing the <code>String</code> 
2933  representations of all the processes of this <code>Server</code>.
2934 <P>
2935 <DD><DL>
2936 </DL>
2937 </DD>
2938 <DD><DL>
2939
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>
2942 </DD>
2943 </DL>
2944 <HR>
2945
2946 <A NAME="compareTo(org.openafs.jafs.Server)"><!-- --></A><H3>
2947 compareTo</H3>
2948 <PRE>
2949 public int <B>compareTo</B>(<A HREF="../../../org/openafs/jafs/Server.html">Server</A>&nbsp;server)</PRE>
2950 <DL>
2951 <DD>Compares two Server objects respective to their names and does not
2952  factor any other attribute.  Alphabetic case is significant in 
2953  comparing names.
2954 <P>
2955 <DD><DL>
2956 </DL>
2957 </DD>
2958 <DD><DL>
2959 <DT><B>Parameters:</B><DD><CODE>server</CODE> - The Server object to be compared to this 
2960                       Server instance
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>
2966 </DD>
2967 </DL>
2968 <HR>
2969
2970 <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
2971 compareTo</H3>
2972 <PRE>
2973 public int <B>compareTo</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A>&nbsp;obj)</PRE>
2974 <DL>
2975 <DD>Comparable interface method.
2976 <P>
2977 <DD><DL>
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>
2979 </DD>
2980 <DD><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>
2982 </DD>
2983 </DL>
2984 <HR>
2985
2986 <A NAME="equals(org.openafs.jafs.Server)"><!-- --></A><H3>
2987 equals</H3>
2988 <PRE>
2989 public boolean <B>equals</B>(<A HREF="../../../org/openafs/jafs/Server.html">Server</A>&nbsp;otherServer)</PRE>
2990 <DL>
2991 <DD>Tests whether two <code>Server</code> objects are equal, based on their 
2992  names and hosting Cell.
2993 <P>
2994 <DD><DL>
2995 </DL>
2996 </DD>
2997 <DD><DL>
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>
3000 </DD>
3001 </DL>
3002 <HR>
3003
3004 <A NAME="toString()"><!-- --></A><H3>
3005 toString</H3>
3006 <PRE>
3007 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
3008 <DL>
3009 <DD>Returns the name of this <CODE>Server</CODE>
3010 <P>
3011 <DD><DL>
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>
3013 </DD>
3014 <DD><DL>
3015
3016 <DT><B>Returns:</B><DD>the name of this <CODE>Server</CODE></DL>
3017 </DD>
3018 </DL>
3019 <HR>
3020
3021 <A NAME="getVosServerHandle(int, java.lang.String)"><!-- --></A><H3>
3022 getVosServerHandle</H3>
3023 <PRE>
3024 protected static int <B>getVosServerHandle</B>(int&nbsp;cellHandle,
3025                                         <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;serverName)
3026                                  throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3027 <DL>
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.
3031 <P>
3032 <DD><DL>
3033 </DL>
3034 </DD>
3035 <DD><DL>
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 
3038                       a vos handle
3039 <DT><B>Returns:</B><DD>a vos handle to the server
3040 <DT><B>Throws:</B>
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>
3042 </DD>
3043 </DL>
3044 <HR>
3045
3046 <A NAME="closeVosServerHandle(int)"><!-- --></A><H3>
3047 closeVosServerHandle</H3>
3048 <PRE>
3049 protected static void <B>closeVosServerHandle</B>(int&nbsp;vosHandle)
3050                                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3051 <DL>
3052 <DD>Closes the given currently open vos server handle.
3053 <P>
3054 <DD><DL>
3055 </DL>
3056 </DD>
3057 <DD><DL>
3058 <DT><B>Parameters:</B><DD><CODE>vosHandle</CODE> - the vos server handle to close
3059 <DT><B>Throws:</B>
3060 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
3061 </DD>
3062 </DL>
3063 <HR>
3064
3065 <A NAME="getBosServerHandle(int, java.lang.String)"><!-- --></A><H3>
3066 getBosServerHandle</H3>
3067 <PRE>
3068 protected static int <B>getBosServerHandle</B>(int&nbsp;cellHandle,
3069                                         <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;serverName)
3070                                  throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3071 <DL>
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.
3075 <P>
3076 <DD><DL>
3077 </DL>
3078 </DD>
3079 <DD><DL>
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 
3082                       a bos handle
3083 <DT><B>Returns:</B><DD>a bos handle to the server
3084 <DT><B>Throws:</B>
3085 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()"><CODE>Cell.getCellHandle()</CODE></A></DL>
3086 </DD>
3087 </DL>
3088 <HR>
3089
3090 <A NAME="closeBosServerHandle(int)"><!-- --></A><H3>
3091 closeBosServerHandle</H3>
3092 <PRE>
3093 protected static void <B>closeBosServerHandle</B>(int&nbsp;bosHandle)
3094                                     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3095 <DL>
3096 <DD>Closes the given currently open bos server handle.
3097 <P>
3098 <DD><DL>
3099 </DL>
3100 </DD>
3101 <DD><DL>
3102 <DT><B>Parameters:</B><DD><CODE>bosHandle</CODE> - the bos server handle to close
3103 <DT><B>Throws:</B>
3104 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
3105 </DD>
3106 </DL>
3107 <HR>
3108
3109 <A NAME="getServerInfo(int, java.lang.String, org.openafs.jafs.Server)"><!-- --></A><H3>
3110 getServerInfo</H3>
3111 <PRE>
3112 protected static void <B>getServerInfo</B>(int&nbsp;cellHandle,
3113                                     <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name,
3114                                     <A HREF="../../../org/openafs/jafs/Server.html">Server</A>&nbsp;server)
3115                              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3116 <DL>
3117 <DD>Fills in the information fields of the provided <code>Server</code>.
3118 <P>
3119 <DD><DL>
3120 </DL>
3121 </DD>
3122 <DD><DL>
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 
3124                    the information
3125 <DT><B>Throws:</B>
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>
3128 </DD>
3129 </DL>
3130 <HR>
3131
3132 <A NAME="getPartitionCount(int, int)"><!-- --></A><H3>
3133 getPartitionCount</H3>
3134 <PRE>
3135 protected static int <B>getPartitionCount</B>(int&nbsp;cellHandle,
3136                                        int&nbsp;serverHandle)
3137                                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3138 <DL>
3139 <DD>Returns the total number of partitions hosted by the server denoted by
3140  <CODE>serverHandle</CODE>, if the server is a fileserver.
3141 <P>
3142 <DD><DL>
3143 </DL>
3144 </DD>
3145 <DD><DL>
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 
3147                       partitions belong
3148 <DT><B>Returns:</B><DD>total number of partitions
3149 <DT><B>Throws:</B>
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>
3152 </DD>
3153 </DL>
3154 <HR>
3155
3156 <A NAME="getPartitionsBegin(int, int)"><!-- --></A><H3>
3157 getPartitionsBegin</H3>
3158 <PRE>
3159 protected static int <B>getPartitionsBegin</B>(int&nbsp;cellHandle,
3160                                         int&nbsp;serverHandle)
3161                                  throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3162 <DL>
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>.
3166 <P>
3167 <DD><DL>
3168 </DL>
3169 </DD>
3170 <DD><DL>
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 
3172                       partitions belong
3173 <DT><B>Returns:</B><DD>an iteration ID
3174 <DT><B>Throws:</B>
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>
3177 </DD>
3178 </DL>
3179 <HR>
3180
3181 <A NAME="getPartitionsNextString(int)"><!-- --></A><H3>
3182 getPartitionsNextString</H3>
3183 <PRE>
3184 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getPartitionsNextString</B>(int&nbsp;iterationId)
3185                                          throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3186 <DL>
3187 <DD>Returns the next partition of the server.  Returns <code>null</code> 
3188  if there are no more partitions.
3189 <P>
3190 <DD><DL>
3191 </DL>
3192 </DD>
3193 <DD><DL>
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
3196 <DT><B>Throws:</B>
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>
3198 </DD>
3199 </DL>
3200 <HR>
3201
3202 <A NAME="getPartitionsNext(int, org.openafs.jafs.Partition)"><!-- --></A><H3>
3203 getPartitionsNext</H3>
3204 <PRE>
3205 protected static int <B>getPartitionsNext</B>(int&nbsp;iterationId,
3206                                        <A HREF="../../../org/openafs/jafs/Partition.html">Partition</A>&nbsp;thePartition)
3207                                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3208 <DL>
3209 <DD>Fills the next partition object of the server.  Returns 0 if there
3210  are no more partitions, != 0 otherwise
3211 <P>
3212 <DD><DL>
3213 </DL>
3214 </DD>
3215 <DD><DL>
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
3219 <DT><B>Throws:</B>
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>
3221 </DD>
3222 </DL>
3223 <HR>
3224
3225 <A NAME="getPartitionsDone(int)"><!-- --></A><H3>
3226 getPartitionsDone</H3>
3227 <PRE>
3228 protected static void <B>getPartitionsDone</B>(int&nbsp;iterationId)
3229                                  throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3230 <DL>
3231 <DD>Signals that the iteration is complete and will not be accessed anymore.
3232 <P>
3233 <DD><DL>
3234 </DL>
3235 </DD>
3236 <DD><DL>
3237 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
3238 <DT><B>Throws:</B>
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>
3240 </DD>
3241 </DL>
3242 <HR>
3243
3244 <A NAME="getProcessCount(int)"><!-- --></A><H3>
3245 getProcessCount</H3>
3246 <PRE>
3247 protected static int <B>getProcessCount</B>(int&nbsp;serverHandle)
3248                               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3249 <DL>
3250 <DD>Returns the total number of processes hosted by the server denoted by
3251  <CODE>serverHandle</CODE>.
3252 <P>
3253 <DD><DL>
3254 </DL>
3255 </DD>
3256 <DD><DL>
3257 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the vos handle of the server to which the 
3258                       processes belong
3259 <DT><B>Returns:</B><DD>total number of processes
3260 <DT><B>Throws:</B>
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>
3262 </DD>
3263 </DL>
3264 <HR>
3265
3266 <A NAME="getProcessesBegin(int)"><!-- --></A><H3>
3267 getProcessesBegin</H3>
3268 <PRE>
3269 protected static int <B>getProcessesBegin</B>(int&nbsp;serverHandle)
3270                                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3271 <DL>
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>.
3275 <P>
3276 <DD><DL>
3277 </DL>
3278 </DD>
3279 <DD><DL>
3280 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the bos handle of the server to which the 
3281                       processes belong
3282 <DT><B>Returns:</B><DD>an iteration ID
3283 <DT><B>Throws:</B>
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>
3285 </DD>
3286 </DL>
3287 <HR>
3288
3289 <A NAME="getProcessesNextString(int)"><!-- --></A><H3>
3290 getProcessesNextString</H3>
3291 <PRE>
3292 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getProcessesNextString</B>(int&nbsp;iterationId)
3293                                         throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3294 <DL>
3295 <DD>Returns the next process of the server.  Returns <code>null</code> 
3296  if there are no more processes.
3297 <P>
3298 <DD><DL>
3299 </DL>
3300 </DD>
3301 <DD><DL>
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
3304 <DT><B>Throws:</B>
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>
3306 </DD>
3307 </DL>
3308 <HR>
3309
3310 <A NAME="getProcessesNext(int, int, org.openafs.jafs.Process)"><!-- --></A><H3>
3311 getProcessesNext</H3>
3312 <PRE>
3313 protected static int <B>getProcessesNext</B>(int&nbsp;serverHandle,
3314                                       int&nbsp;iterationId,
3315                                       <A HREF="../../../org/openafs/jafs/Process.html">Process</A>&nbsp;theProcess)
3316                                throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3317 <DL>
3318 <DD>Fills the next process object of the server.  Returns 0 if there
3319  are no more processes, != 0 otherwise.
3320 <P>
3321 <DD><DL>
3322 </DL>
3323 </DD>
3324 <DD><DL>
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
3328 <DT><B>Throws:</B>
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>
3331 </DD>
3332 </DL>
3333 <HR>
3334
3335 <A NAME="getProcessesDone(int)"><!-- --></A><H3>
3336 getProcessesDone</H3>
3337 <PRE>
3338 protected static void <B>getProcessesDone</B>(int&nbsp;iterationId)
3339                                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3340 <DL>
3341 <DD>Signals that the iteration is complete and will not be accessed anymore.
3342 <P>
3343 <DD><DL>
3344 </DL>
3345 </DD>
3346 <DD><DL>
3347 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
3348 <DT><B>Throws:</B>
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>
3350 </DD>
3351 </DL>
3352 <HR>
3353
3354 <A NAME="getKeyCount(int)"><!-- --></A><H3>
3355 getKeyCount</H3>
3356 <PRE>
3357 protected static int <B>getKeyCount</B>(int&nbsp;serverHandle)
3358                           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3359 <DL>
3360 <DD>Returns the total number of keys hosted by the server denoted by
3361  <CODE>serverHandle</CODE>.
3362 <P>
3363 <DD><DL>
3364 </DL>
3365 </DD>
3366 <DD><DL>
3367 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the vos handle of the server to which the 
3368                       keys belong
3369 <DT><B>Returns:</B><DD>total number of keys
3370 <DT><B>Throws:</B>
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>
3372 </DD>
3373 </DL>
3374 <HR>
3375
3376 <A NAME="getKeysBegin(int)"><!-- --></A><H3>
3377 getKeysBegin</H3>
3378 <PRE>
3379 protected static int <B>getKeysBegin</B>(int&nbsp;serverHandle)
3380                            throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3381 <DL>
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>.
3385 <P>
3386 <DD><DL>
3387 </DL>
3388 </DD>
3389 <DD><DL>
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
3392 <DT><B>Throws:</B>
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>
3394 </DD>
3395 </DL>
3396 <HR>
3397
3398 <A NAME="getKeysNext(int, org.openafs.jafs.Key)"><!-- --></A><H3>
3399 getKeysNext</H3>
3400 <PRE>
3401 protected static int <B>getKeysNext</B>(int&nbsp;iterationId,
3402                                  <A HREF="../../../org/openafs/jafs/Key.html">Key</A>&nbsp;theKey)
3403                           throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3404 <DL>
3405 <DD>Returns the next key of the server.  Returns 0 if there
3406  are no more keys, != 0 otherwise.
3407 <P>
3408 <DD><DL>
3409 </DL>
3410 </DD>
3411 <DD><DL>
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
3415 <DT><B>Throws:</B>
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>
3417 </DD>
3418 </DL>
3419 <HR>
3420
3421 <A NAME="getKeysDone(int)"><!-- --></A><H3>
3422 getKeysDone</H3>
3423 <PRE>
3424 protected static void <B>getKeysDone</B>(int&nbsp;iterationId)
3425                            throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3426 <DL>
3427 <DD>Signals that the iteration is complete and will not be accessed anymore.
3428 <P>
3429 <DD><DL>
3430 </DL>
3431 </DD>
3432 <DD><DL>
3433 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
3434 <DT><B>Throws:</B>
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>
3436 </DD>
3437 </DL>
3438 <HR>
3439
3440 <A NAME="getBosAdminCount(int)"><!-- --></A><H3>
3441 getBosAdminCount</H3>
3442 <PRE>
3443 protected static int <B>getBosAdminCount</B>(int&nbsp;serverHandle)
3444                                throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3445 <DL>
3446 <DD>Returns the total number of BOS administrators associated with the server 
3447  denoted by <CODE>serverHandle</CODE>.
3448 <P>
3449 <DD><DL>
3450 </DL>
3451 </DD>
3452 <DD><DL>
3453 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the vos handle of the server to which the 
3454                       BOS admins belong
3455 <DT><B>Returns:</B><DD>total number of BOS administrators
3456 <DT><B>Throws:</B>
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>
3458 </DD>
3459 </DL>
3460 <HR>
3461
3462 <A NAME="getBosAdminsBegin(int)"><!-- --></A><H3>
3463 getBosAdminsBegin</H3>
3464 <PRE>
3465 protected static int <B>getBosAdminsBegin</B>(int&nbsp;serverHandle)
3466                                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3467 <DL>
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>.
3471 <P>
3472 <DD><DL>
3473 </DL>
3474 </DD>
3475 <DD><DL>
3476 <DT><B>Parameters:</B><DD><CODE>serverHandle</CODE> - the bos handle of the server to which the 
3477                       partitions belong
3478 <DT><B>Returns:</B><DD>an iteration ID
3479 <DT><B>Throws:</B>
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>
3481 </DD>
3482 </DL>
3483 <HR>
3484
3485 <A NAME="getBosAdminsNextString(int)"><!-- --></A><H3>
3486 getBosAdminsNextString</H3>
3487 <PRE>
3488 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getBosAdminsNextString</B>(int&nbsp;iterationId)
3489                                         throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3490 <DL>
3491 <DD>Returns the next bos admin of the server.  Returns <code>null</code> 
3492  if there are no more admins.
3493 <P>
3494 <DD><DL>
3495 </DL>
3496 </DD>
3497 <DD><DL>
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
3500 <DT><B>Throws:</B>
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>
3502 </DD>
3503 </DL>
3504 <HR>
3505
3506 <A NAME="getBosAdminsNext(int, int, org.openafs.jafs.User)"><!-- --></A><H3>
3507 getBosAdminsNext</H3>
3508 <PRE>
3509 protected static int <B>getBosAdminsNext</B>(int&nbsp;cellHandle,
3510                                       int&nbsp;iterationId,
3511                                       <A HREF="../../../org/openafs/jafs/User.html">User</A>&nbsp;theUser)
3512                                throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3513 <DL>
3514 <DD>Returns the next bos admin of the server.  Returns 0 if there
3515  are no more admins, != 0 otherwise.
3516 <P>
3517 <DD><DL>
3518 </DL>
3519 </DD>
3520 <DD><DL>
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
3523 <DT><B>Throws:</B>
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>
3526 </DD>
3527 </DL>
3528 <HR>
3529
3530 <A NAME="getBosAdminsDone(int)"><!-- --></A><H3>
3531 getBosAdminsDone</H3>
3532 <PRE>
3533 protected static void <B>getBosAdminsDone</B>(int&nbsp;iterationId)
3534                                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3535 <DL>
3536 <DD>Signals that the iteration is complete and will not be accessed anymore.
3537 <P>
3538 <DD><DL>
3539 </DL>
3540 </DD>
3541 <DD><DL>
3542 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
3543 <DT><B>Throws:</B>
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>
3545 </DD>
3546 </DL>
3547 <HR>
3548
3549 <A NAME="addBosAdmin(int, java.lang.String)"><!-- --></A><H3>
3550 addBosAdmin</H3>
3551 <PRE>
3552 protected static void <B>addBosAdmin</B>(int&nbsp;serverHandle,
3553                                   <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;adminName)
3554                            throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3555 <DL>
3556 <DD>Adds the given to name to the list of bos administrators on that server.
3557 <P>
3558 <DD><DL>
3559 </DL>
3560 </DD>
3561 <DD><DL>
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
3564 <DT><B>Throws:</B>
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>
3566 </DD>
3567 </DL>