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