1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
5 <!-- Generated by javadoc on Mon Jun 09 15:53:36 PDT 2003 -->
9 <META NAME="keywords" CONTENT="org.openafs.jafs.Cell,Cell class">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
15 parent.document.title="Cell (Java AFS API)";
18 <BODY BGCOLOR="white" onload="asd();">
20 <!-- ========== START OF NAVBAR ========== -->
21 <A NAME="navbar_top"><!-- --></A>
22 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
24 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
25 <A NAME="navbar_top_firstrow"><!-- --></A>
26 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
27 <TR ALIGN="center" VALIGN="top">
28 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
29 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
30 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Cell.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
31 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
32 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
33 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
34 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 <A HREF="../../../org/openafs/jafs/AFSShutdownHandler.html"><B>PREV CLASS</B></A>
46 <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>
49 <A HREF="Cell.html" TARGET="_top"><B>NO FRAMES</B></A>
54 document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
70 <!-- =========== END OF NAVBAR =========== -->
73 <!-- ======== START OF CLASS DATA ======== -->
76 org.openafs.jafs</FONT>
80 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">java.lang.Object</A>
82 +--<B>org.openafs.jafs.Cell</B>
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>
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>
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.
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>
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>
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>
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.
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>
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>
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;
147 private Server server;
150 public static void main(String[] args) throws Exception
152 String username = arg[0];
153 String password = arg[1];
154 String cellName = arg[2];
155 String serverName = arg[3];
157 token = new Token(username, password, cellName);
158 cell = new Cell(token);
159 server = cell.getServer(serverName);
161 User[] users = cell.getUsers();
171 <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html" TARGET="org.openafs.jafs.Cell">Serialized Form</A></DL>
175 <!-- ======== NESTED CLASS SUMMARY ======== -->
178 <!-- =========== FIELD SUMMARY =========== -->
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>
186 <TR BGCOLOR="white" CLASS="TableRowColor">
187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188 <CODE>protected boolean</CODE></FONT></TD>
189 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#cachedInfo">cachedInfo</A></B></CODE>
192 </TD>
194 <TR BGCOLOR="white" CLASS="TableRowColor">
195 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196 <CODE>protected int</CODE></FONT></TD>
197 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#cellHandle">cellHandle</A></B></CODE>
200 </TD>
202 <TR BGCOLOR="white" CLASS="TableRowColor">
203 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204 <CODE>protected <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>
208 </TD>
210 <TR BGCOLOR="white" CLASS="TableRowColor">
211 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212 <CODE>protected <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>
216 </TD>
218 <TR BGCOLOR="white" CLASS="TableRowColor">
219 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220 <CODE>protected int</CODE></FONT></TD>
221 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#maxGroupID">maxGroupID</A></B></CODE>
224 </TD>
226 <TR BGCOLOR="white" CLASS="TableRowColor">
227 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228 <CODE>protected int</CODE></FONT></TD>
229 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#maxUserID">maxUserID</A></B></CODE>
232 </TD>
234 <TR BGCOLOR="white" CLASS="TableRowColor">
235 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236 <CODE>protected <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>
240 </TD>
242 <TR BGCOLOR="white" CLASS="TableRowColor">
243 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244 <CODE>protected <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>
248 </TD>
250 <TR BGCOLOR="white" CLASS="TableRowColor">
251 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252 <CODE>protected <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>
256 </TD>
258 <TR BGCOLOR="white" CLASS="TableRowColor">
259 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260 <CODE>protected <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>
264 </TD>
266 <TR BGCOLOR="white" CLASS="TableRowColor">
267 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
268 <CODE>protected <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>
272 </TD>
274 <TR BGCOLOR="white" CLASS="TableRowColor">
275 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
276 <CODE>protected <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>
280 </TD>
282 <TR BGCOLOR="white" CLASS="TableRowColor">
283 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
284 <CODE>protected <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>
288 </TD>
292 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
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>
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> token)</CODE>
304 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>
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> token,
310 boolean preloadAllMembers)</CODE>
313 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>
319 <!-- ========== METHOD SUMMARY =========== -->
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>
327 <TR BGCOLOR="white" CLASS="TableRowColor">
328 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329 <CODE> void</CODE></FONT></TD>
330 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#close()">close</A></B>()</CODE>
333 Unauthenticates this </code>Token</code> object associated with this
334 <code>Cell</code> and deletes all of its stored information. </TD>
336 <TR BGCOLOR="white" CLASS="TableRowColor">
337 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
338 <CODE>protected static void</CODE></FONT></TD>
339 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#closeCell(int)">closeCell</A></B>(int cellHandle)</CODE>
342 Closes the given currently open cell handle.</TD>
344 <TR BGCOLOR="white" CLASS="TableRowColor">
345 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
346 <CODE>protected static 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 cellHandle,
348 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> directory,
349 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> volumeName,
350 boolean readWrite,
351 boolean forceCheck)</CODE>
354 Creates a mount point for a volume within the file system.</TD>
356 <TR BGCOLOR="white" CLASS="TableRowColor">
357 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
358 <CODE> 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> otherCell)</CODE>
362 Tests whether two <code>Cell</code> objects are equal, based on their
365 <TR BGCOLOR="white" CLASS="TableRowColor">
366 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
367 <CODE> int</CODE></FONT></TD>
368 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getCellHandle()">getCellHandle</A></B>()</CODE>
371 Returns the cell handle of this cell.</TD>
373 <TR BGCOLOR="white" CLASS="TableRowColor">
374 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
375 <CODE>protected static 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> cellName,
377 int tokenHandle)</CODE>
380 Opens a cell for administrative use, based on the token provided.
383 <TR BGCOLOR="white" CLASS="TableRowColor">
384 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
385 <CODE>protected static <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 cellHandle)</CODE>
389 Returns the name of the cell.</TD>
391 <TR BGCOLOR="white" CLASS="TableRowColor">
392 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
393 <CODE> <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> name)</CODE>
397 Retrieves the <CODE>Group</CODE> object (which is an abstract
398 representation of an actual AFS group) designated by <code>name</code>.
401 <TR BGCOLOR="white" CLASS="TableRowColor">
402 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
403 <CODE> int</CODE></FONT></TD>
404 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getGroupCount()">getGroupCount</A></B>()</CODE>
407 Returns the total number of groups associated with this Cell.
411 <TR BGCOLOR="white" CLASS="TableRowColor">
412 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
413 <CODE>protected static int</CODE></FONT></TD>
414 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getGroupCount(int)">getGroupCount</A></B>(int cellHandle)</CODE>
417 Returns the total number of groups belonging to the cell denoted
418 by <CODE>cellHandle</CODE>.</TD>
420 <TR BGCOLOR="white" CLASS="TableRowColor">
421 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
422 <CODE> <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>
426 Retrieves an array containing all of the names of groups
427 associated with this <code>Cell</code>. </TD>
429 <TR BGCOLOR="white" CLASS="TableRowColor">
430 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
431 <CODE> <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 startIndex,
433 int length)</CODE>
436 Returns an array containing a subset of the names of groups
437 associated with this <code>Cell</code>. </TD>
439 <TR BGCOLOR="white" CLASS="TableRowColor">
440 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
441 <CODE> <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>
445 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>
449 <TR BGCOLOR="white" CLASS="TableRowColor">
450 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
451 <CODE> <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 startIndex,
453 int length)</CODE>
456 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>
460 <TR BGCOLOR="white" CLASS="TableRowColor">
461 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
462 <CODE>protected static int</CODE></FONT></TD>
463 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getGroupsBegin(int)">getGroupsBegin</A></B>(int cellHandle)</CODE>
466 Begin the process of getting the groups that belong to the cell. </TD>
468 <TR BGCOLOR="white" CLASS="TableRowColor">
469 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
470 <CODE>protected static int</CODE></FONT></TD>
471 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getGroupsBeginAt(int, int)">getGroupsBeginAt</A></B>(int cellHandle,
472 int startIndex)</CODE>
475 Begin the process of getting the groups that belong to the cell, starting
476 with element index <code>startIndex</code>. </TD>
478 <TR BGCOLOR="white" CLASS="TableRowColor">
479 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
480 <CODE>protected static void</CODE></FONT></TD>
481 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getGroupsDone(int)">getGroupsDone</A></B>(int iterationId)</CODE>
484 Signals that the iteration is complete and will not be accessed anymore.</TD>
486 <TR BGCOLOR="white" CLASS="TableRowColor">
487 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
488 <CODE>protected static 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 cellHandle,
490 int iterationId,
491 <A HREF="../../../org/openafs/jafs/Group.html">Group</A> theGroup)</CODE>
494 Fills the next group object of the cell. </TD>
496 <TR BGCOLOR="white" CLASS="TableRowColor">
497 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
498 <CODE>protected static <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 iterationId)</CODE>
502 Returns the next group of the cell. </TD>
504 <TR BGCOLOR="white" CLASS="TableRowColor">
505 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
506 <CODE>protected <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>
510 Returns a <code>String</code> representation of this <code>Cell</code>.
513 <TR BGCOLOR="white" CLASS="TableRowColor">
514 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
515 <CODE>protected <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>
519 Returns a <code>String</code> containing the <code>String</code>
520 representations of all the groups of this <code>Cell</code>.</TD>
522 <TR BGCOLOR="white" CLASS="TableRowColor">
523 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
524 <CODE>protected <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>
528 Returns a <code>String</code> containing the <code>String</code>
529 representations of all the servers of this <code>Cell</code>.</TD>
531 <TR BGCOLOR="white" CLASS="TableRowColor">
532 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
533 <CODE>protected <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>
537 Returns a <code>String</code> containing the <code>String</code>
538 representations of all the users of this <code>Cell</code>.</TD>
540 <TR BGCOLOR="white" CLASS="TableRowColor">
541 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
542 <CODE>protected static int</CODE></FONT></TD>
543 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getKasUserCount(int)">getKasUserCount</A></B>(int cellHandle)</CODE>
546 Returns the total number of KAS users belonging to the cell denoted
547 by <CODE>cellHandle</CODE>.</TD>
549 <TR BGCOLOR="white" CLASS="TableRowColor">
550 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
551 <CODE>protected static int</CODE></FONT></TD>
552 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getKasUsersBegin(int)">getKasUsersBegin</A></B>(int cellHandle)</CODE>
555 Begin the process of getting the kas users that belong to the cell.
558 <TR BGCOLOR="white" CLASS="TableRowColor">
559 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
560 <CODE>protected static int</CODE></FONT></TD>
561 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getKasUsersBeginAt(int, int)">getKasUsersBeginAt</A></B>(int cellHandle,
562 int startIndex)</CODE>
565 Begin the process of getting the KAS users, starting at
566 <code>startIndex</code>, that belong to the cell.
569 <TR BGCOLOR="white" CLASS="TableRowColor">
570 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
571 <CODE>protected static void</CODE></FONT></TD>
572 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getKasUsersDone(int)">getKasUsersDone</A></B>(int iterationId)</CODE>
575 Signals that the iteration is complete and will not be accessed anymore.</TD>
577 <TR BGCOLOR="white" CLASS="TableRowColor">
578 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
579 <CODE>protected static 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 cellHandle,
581 int iterationId,
582 <A HREF="../../../org/openafs/jafs/User.html">User</A> theUser)</CODE>
585 Fills the next kas user object of the cell. </TD>
587 <TR BGCOLOR="white" CLASS="TableRowColor">
588 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
589 <CODE>protected static <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 iterationId)</CODE>
593 Returns the next kas user of the cell. </TD>
595 <TR BGCOLOR="white" CLASS="TableRowColor">
596 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
597 <CODE> int</CODE></FONT></TD>
598 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getMaxGroupID()">getMaxGroupID</A></B>()</CODE>
601 Returns the maximum group ID that's been used within the cell.
604 <TR BGCOLOR="white" CLASS="TableRowColor">
605 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
606 <CODE>protected static int</CODE></FONT></TD>
607 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getMaxGroupID(int)">getMaxGroupID</A></B>(int cellHandle)</CODE>
610 Gets the maximum group pts ID that's been used within a cell.
613 <TR BGCOLOR="white" CLASS="TableRowColor">
614 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
615 <CODE> int</CODE></FONT></TD>
616 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getMaxUserID()">getMaxUserID</A></B>()</CODE>
619 Returns the maximum user ID that's been used within the cell.
622 <TR BGCOLOR="white" CLASS="TableRowColor">
623 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
624 <CODE>protected static int</CODE></FONT></TD>
625 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getMaxUserID(int)">getMaxUserID</A></B>(int cellHandle)</CODE>
628 Gets the maximum user pts ID that's been used within a cell.
631 <TR BGCOLOR="white" CLASS="TableRowColor">
632 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
633 <CODE> <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>
637 Returns the name of this cell.</TD>
639 <TR BGCOLOR="white" CLASS="TableRowColor">
640 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
641 <CODE>protected static int</CODE></FONT></TD>
642 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getPtsOnlyUserCount(int)">getPtsOnlyUserCount</A></B>(int cellHandle)</CODE>
645 Returns the total number of PTS users, belonging to the cell denoted
646 by <CODE>cellHandle</CODE>, that are not in KAS.</TD>
648 <TR BGCOLOR="white" CLASS="TableRowColor">
649 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
650 <CODE>protected static 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 cellHandle,
652 int iterationId,
653 <A HREF="../../../org/openafs/jafs/User.html">User</A> theUser)</CODE>
656 Fills the next pts user (who does not have a kas entry) object of
659 <TR BGCOLOR="white" CLASS="TableRowColor">
660 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
661 <CODE>protected static <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 iterationId,
663 int cellHandle)</CODE>
666 Returns the next pts user (who is not a kas user) of the cell.
669 <TR BGCOLOR="white" CLASS="TableRowColor">
670 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
671 <CODE>protected static int</CODE></FONT></TD>
672 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getPtsUserCount(int)">getPtsUserCount</A></B>(int cellHandle)</CODE>
675 Returns the total number of PTS users belonging to the cell denoted
676 by <CODE>cellHandle</CODE>.</TD>
678 <TR BGCOLOR="white" CLASS="TableRowColor">
679 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
680 <CODE>protected static int</CODE></FONT></TD>
681 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getPtsUsersBegin(int)">getPtsUsersBegin</A></B>(int cellHandle)</CODE>
684 Begin the process of getting the pts users that belong to the cell.
687 <TR BGCOLOR="white" CLASS="TableRowColor">
688 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
689 <CODE>protected static void</CODE></FONT></TD>
690 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getPtsUsersDone(int)">getPtsUsersDone</A></B>(int iterationId)</CODE>
693 Signals that the iteration is complete and will not be accessed anymore.</TD>
695 <TR BGCOLOR="white" CLASS="TableRowColor">
696 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
697 <CODE>protected static 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 cellHandle,
699 int iterationId,
700 <A HREF="../../../org/openafs/jafs/User.html">User</A> theUser)</CODE>
703 Fills the next pts user object of the cell. </TD>
705 <TR BGCOLOR="white" CLASS="TableRowColor">
706 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
707 <CODE>protected static <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 iterationId)</CODE>
711 Returns the next pts user of the cell. </TD>
713 <TR BGCOLOR="white" CLASS="TableRowColor">
714 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
715 <CODE> <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> name)</CODE>
719 Retrieves the <CODE>Server</CODE> object (which is an abstract
720 representation of an actual AFS server) designated by <code>name</code>.
723 <TR BGCOLOR="white" CLASS="TableRowColor">
724 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
725 <CODE> int</CODE></FONT></TD>
726 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getServerCount()">getServerCount</A></B>()</CODE>
729 Returns the total number of servers associated with this Cell.
733 <TR BGCOLOR="white" CLASS="TableRowColor">
734 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
735 <CODE>protected static int</CODE></FONT></TD>
736 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getServerCount(int)">getServerCount</A></B>(int cellHandle)</CODE>
739 Returns the total number of servers belonging to the cell denoted
740 by <CODE>cellHandle</CODE>.</TD>
742 <TR BGCOLOR="white" CLASS="TableRowColor">
743 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
744 <CODE> <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>
748 Retrieves an array containing all of the names of servers
749 associated with this <code>Cell</code>. </TD>
751 <TR BGCOLOR="white" CLASS="TableRowColor">
752 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
753 <CODE> <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>
757 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>
761 <TR BGCOLOR="white" CLASS="TableRowColor">
762 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
763 <CODE>protected static int</CODE></FONT></TD>
764 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getServersBegin(int)">getServersBegin</A></B>(int cellHandle)</CODE>
767 Begin the process of getting the servers in the cell. </TD>
769 <TR BGCOLOR="white" CLASS="TableRowColor">
770 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
771 <CODE>protected static void</CODE></FONT></TD>
772 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getServersDone(int)">getServersDone</A></B>(int iterationId)</CODE>
775 Signals that the iteration is complete and will not be accessed anymore.</TD>
777 <TR BGCOLOR="white" CLASS="TableRowColor">
778 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
779 <CODE>protected static 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 cellHandle,
781 int iterationId,
782 <A HREF="../../../org/openafs/jafs/Server.html">Server</A> theServer)</CODE>
785 Fills the next server object of the cell. </TD>
787 <TR BGCOLOR="white" CLASS="TableRowColor">
788 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
789 <CODE>protected static <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 iterationId)</CODE>
793 Returns the next server of the cell. </TD>
795 <TR BGCOLOR="white" CLASS="TableRowColor">
796 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
797 <CODE> <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>
801 Returns the expiration time of the authentication token being used
802 by this <code>Cell</code> object. </TD>
804 <TR BGCOLOR="white" CLASS="TableRowColor">
805 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
806 <CODE> <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> name)</CODE>
810 Retrieves the <CODE>User</CODE> object (which is an abstract
811 representation of an actual AFS user) designated by <code>name</code>.
814 <TR BGCOLOR="white" CLASS="TableRowColor">
815 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
816 <CODE> int</CODE></FONT></TD>
817 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#getUserCount()">getUserCount</A></B>()</CODE>
820 Returns the total number of users who are registered with KAS and PTS,
821 without duplicates. </TD>
823 <TR BGCOLOR="white" CLASS="TableRowColor">
824 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
825 <CODE> <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>
829 Retrieves an array containing all of the names of users
830 associated with this <code>Cell</code>. </TD>
832 <TR BGCOLOR="white" CLASS="TableRowColor">
833 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
834 <CODE> <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 startIndex,
836 int length)</CODE>
839 Returns an array containing a subset of the names of users
840 associated with this <code>Cell</code>. </TD>
842 <TR BGCOLOR="white" CLASS="TableRowColor">
843 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
844 <CODE> <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>
848 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>
852 <TR BGCOLOR="white" CLASS="TableRowColor">
853 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
854 <CODE> <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 startIndex,
856 int length)</CODE>
859 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>
863 <TR BGCOLOR="white" CLASS="TableRowColor">
864 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
865 <CODE>protected static void</CODE></FONT></TD>
866 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#reclaimCellMemory()">reclaimCellMemory</A></B>()</CODE>
869 Reclaims all memory being saved by the cell portion of the native library.
872 <TR BGCOLOR="white" CLASS="TableRowColor">
873 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
874 <CODE> void</CODE></FONT></TD>
875 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#refresh()">refresh</A></B>()</CODE>
878 Refreshes the properties of this Cell object instance with values
879 from the AFS cell it represents. </TD>
881 <TR BGCOLOR="white" CLASS="TableRowColor">
882 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
883 <CODE>protected void</CODE></FONT></TD>
884 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#refresh(boolean)">refresh</A></B>(boolean all)</CODE>
887 Refreshes the properties of this Cell object instance with values
888 from the AFS cell it represents. </TD>
890 <TR BGCOLOR="white" CLASS="TableRowColor">
891 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
892 <CODE>protected void</CODE></FONT></TD>
893 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#refreshGroupNames()">refreshGroupNames</A></B>()</CODE>
896 Obtains the most current list of group names of this cell.</TD>
898 <TR BGCOLOR="white" CLASS="TableRowColor">
899 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
900 <CODE>protected void</CODE></FONT></TD>
901 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#refreshGroups()">refreshGroups</A></B>()</CODE>
904 Obtains the most current list of <code>Group</code> objects of this cell.</TD>
906 <TR BGCOLOR="white" CLASS="TableRowColor">
907 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
908 <CODE>protected void</CODE></FONT></TD>
909 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#refreshInfo()">refreshInfo</A></B>()</CODE>
912 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>
915 <TR BGCOLOR="white" CLASS="TableRowColor">
916 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
917 <CODE>protected void</CODE></FONT></TD>
918 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#refreshServerNames()">refreshServerNames</A></B>()</CODE>
921 Obtains the most current list of server names of this cell.</TD>
923 <TR BGCOLOR="white" CLASS="TableRowColor">
924 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
925 <CODE>protected void</CODE></FONT></TD>
926 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#refreshServers()">refreshServers</A></B>()</CODE>
929 Obtains the most current list of <code>Server</code> objects of this cell.</TD>
931 <TR BGCOLOR="white" CLASS="TableRowColor">
932 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
933 <CODE>protected void</CODE></FONT></TD>
934 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#refreshUserNames()">refreshUserNames</A></B>()</CODE>
937 Obtains the most current list of user names of this cell. </TD>
939 <TR BGCOLOR="white" CLASS="TableRowColor">
940 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
941 <CODE>protected void</CODE></FONT></TD>
942 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#refreshUsers()">refreshUsers</A></B>()</CODE>
945 Obtains the most current list of <code>User</code> objects of this cell.
948 <TR BGCOLOR="white" CLASS="TableRowColor">
949 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
950 <CODE>static 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> directory,
952 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> username,
959 boolean admin)</CODE>
962 </TD>
964 <TR BGCOLOR="white" CLASS="TableRowColor">
965 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
966 <CODE> void</CODE></FONT></TD>
967 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#setMaxGroupID(int)">setMaxGroupID</A></B>(int maxID)</CODE>
970 Sets the maximum group ID that's been used within the cell. </TD>
972 <TR BGCOLOR="white" CLASS="TableRowColor">
973 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
974 <CODE>protected static void</CODE></FONT></TD>
975 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#setMaxGroupID(int, int)">setMaxGroupID</A></B>(int cellHandle,
976 int maxID)</CODE>
979 Sets the maximum group pts ID that's been used within a cell. </TD>
981 <TR BGCOLOR="white" CLASS="TableRowColor">
982 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
983 <CODE> void</CODE></FONT></TD>
984 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#setMaxUserID(int)">setMaxUserID</A></B>(int maxID)</CODE>
987 Sets the maximum user ID that's been used within the cell. </TD>
989 <TR BGCOLOR="white" CLASS="TableRowColor">
990 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
991 <CODE>protected static void</CODE></FONT></TD>
992 <TD><CODE><B><A HREF="../../../org/openafs/jafs/Cell.html#setMaxUserID(int, int)">setMaxUserID</A></B>(int cellHandle,
993 int maxID)</CODE>
996 Sets the maximum user pts ID that's been used within a cell. </TD>
998 <TR BGCOLOR="white" CLASS="TableRowColor">
999 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1000 <CODE> <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>
1004 Returns the name of this <CODE>Cell</CODE></TD>
1007 <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>
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>
1019 <!-- ============ FIELD DETAIL =========== -->
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>
1029 <A NAME="users"><!-- --></A><H3>
1032 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>users</B></PRE>
1039 <A NAME="userNames"><!-- --></A><H3>
1042 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>userNames</B></PRE>
1049 <A NAME="groups"><!-- --></A><H3>
1052 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>groups</B></PRE>
1059 <A NAME="groupNames"><!-- --></A><H3>
1062 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>groupNames</B></PRE>
1069 <A NAME="servers"><!-- --></A><H3>
1072 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>servers</B></PRE>
1079 <A NAME="serverNames"><!-- --></A><H3>
1082 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html">ArrayList</A> <B>serverNames</B></PRE>
1089 <A NAME="name"><!-- --></A><H3>
1092 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>name</B></PRE>
1099 <A NAME="cellHandle"><!-- --></A><H3>
1102 protected int <B>cellHandle</B></PRE>
1109 <A NAME="token"><!-- --></A><H3>
1112 protected <A HREF="../../../org/openafs/jafs/Token.html">Token</A> <B>token</B></PRE>
1119 <A NAME="maxGroupID"><!-- --></A><H3>
1122 protected int <B>maxGroupID</B></PRE>
1129 <A NAME="maxUserID"><!-- --></A><H3>
1132 protected int <B>maxUserID</B></PRE>
1139 <A NAME="tokenExpiration"><!-- --></A><H3>
1140 tokenExpiration</H3>
1142 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>tokenExpiration</B></PRE>
1149 <A NAME="cachedInfo"><!-- --></A><H3>
1152 protected boolean <B>cachedInfo</B></PRE>
1158 <!-- ========= CONSTRUCTOR DETAIL ======== -->
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>
1168 <A NAME="Cell(org.openafs.jafs.Token)"><!-- --></A><H3>
1171 public <B>Cell</B>(<A HREF="../../../org/openafs/jafs/Token.html">Token</A> token)
1172 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
1180 <DT><B>Parameters:</B><DD><CODE>token</CODE> - the user's authenticated token
1182 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1185 <A NAME="Cell(org.openafs.jafs.Token, boolean)"><!-- --></A><H3>
1188 public <B>Cell</B>(<A HREF="../../../org/openafs/jafs/Token.html">Token</A> token,
1189 boolean preloadAllMembers)
1190 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
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
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
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>
1211 <!-- ============ METHOD DETAIL ========== -->
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>
1221 <A NAME="refresh()"><!-- --></A><H3>
1224 public void <B>refresh</B>()
1225 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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
1249 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1254 <A NAME="refresh(boolean)"><!-- --></A><H3>
1257 protected void <B>refresh</B>(boolean all)
1258 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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.
1274 <DT><B>Parameters:</B><DD><CODE>all</CODE> - if true set or renew all object properties; otherwise
1275 renew all set properties
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>
1282 <A NAME="refreshInfo()"><!-- --></A><H3>
1285 protected void <B>refreshInfo</B>()
1286 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
1297 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1302 <A NAME="refreshUsers()"><!-- --></A><H3>
1305 protected void <B>refreshUsers</B>()
1306 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
1317 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1322 <A NAME="refreshUserNames()"><!-- --></A><H3>
1323 refreshUserNames</H3>
1325 protected void <B>refreshUserNames</B>()
1326 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
1337 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1342 <A NAME="refreshGroups()"><!-- --></A><H3>
1345 protected void <B>refreshGroups</B>()
1346 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1348 <DD>Obtains the most current list of <code>Group</code> objects of this cell.
1356 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1361 <A NAME="refreshGroupNames()"><!-- --></A><H3>
1362 refreshGroupNames</H3>
1364 protected void <B>refreshGroupNames</B>()
1365 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1367 <DD>Obtains the most current list of group names of this cell.
1375 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1380 <A NAME="refreshServers()"><!-- --></A><H3>
1383 protected void <B>refreshServers</B>()
1384 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1386 <DD>Obtains the most current list of <code>Server</code> objects of this cell.
1394 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1399 <A NAME="refreshServerNames()"><!-- --></A><H3>
1400 refreshServerNames</H3>
1402 protected void <B>refreshServerNames</B>()
1403 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1405 <DD>Obtains the most current list of server names of this cell.
1413 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1418 <A NAME="close()"><!-- --></A><H3>
1421 public void <B>close</B>()
1422 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
1438 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1443 <A NAME="getUser(java.lang.String)"><!-- --></A><H3>
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> name)
1447 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
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>.
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>
1469 <A NAME="getUserCount()"><!-- --></A><H3>
1472 public int <B>getUserCount</B>()
1473 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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.
1491 <DT><B>Returns:</B><DD>a <code>User</code> array of the users of the cell.
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>
1499 <A NAME="getUsers()"><!-- --></A><H3>
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>
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.
1517 <DT><B>Returns:</B><DD>a <code>User</code> array of the users of the cell.
1519 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1524 <A NAME="getUsers(int, int)"><!-- --></A><H3>
1527 public <A HREF="../../../org/openafs/jafs/User.html">User</A>[] <B>getUsers</B>(int startIndex,
1529 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>
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.
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.
1549 <P>This method does not save the resulting data and therefore
1550 queries AFS for each call.
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.
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.
1564 if (cell.getUserCount() > 50000) {
1567 while (index < cell.getUserCount()) {
1568 users = cell.<B>getUsers</B>(index, length);
1569 for (int i = 0; i < users.length; i++) {
1576 users = cell.getUsers();
1577 for (int i = 0; i < users.length; i++) {
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
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>
1600 <A NAME="getUserNames()"><!-- --></A><H3>
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>
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.
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.
1627 <DT><B>Returns:</B><DD>an <code>String</code> array of the user names of the cell.
1629 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1634 <A NAME="getUserNames(int, int)"><!-- --></A><H3>
1637 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[] <B>getUserNames</B>(int startIndex,
1639 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>
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.
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.
1658 <P>This method does not save the resulting data and therefore
1659 queries AFS for each call.
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.
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.
1673 if (cell.getUserCount() > 50000) {
1676 while (index < cell.getUserCount()) {
1677 users = cell.<B>getUserNames</B>(index, length);
1678 for (int i = 0; i < users.length; i++) {
1685 users = cell.getUserNames();
1686 for (int i = 0; i < users.length; i++) {
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
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>
1709 <A NAME="getGroup(java.lang.String)"><!-- --></A><H3>
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> name)
1713 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
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>.
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>
1735 <A NAME="getGroupCount()"><!-- --></A><H3>
1738 public int <B>getGroupCount</B>()
1739 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1741 <DD>Returns the total number of groups associated with this Cell.
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.
1753 <DT><B>Returns:</B><DD>a <code>User</code> array of the users of the cell.
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>
1761 <A NAME="getGroups()"><!-- --></A><H3>
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>
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.
1779 <DT><B>Returns:</B><DD>a <code>Group</code> array of the groups of the cell.
1781 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1786 <A NAME="getGroups(int, int)"><!-- --></A><H3>
1789 public <A HREF="../../../org/openafs/jafs/Group.html">Group</A>[] <B>getGroups</B>(int startIndex,
1791 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>
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.
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.
1811 <P>This method does not save the resulting data and therefore
1812 queries AFS for each call.
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.
1819 if (cell.getGroupCount() > 50000) {
1822 while (index < cell.getGroupCount()) {
1823 groups = cell.<B>getGroups</B>(index, length);
1824 for (int i = 0; i < groups.length; i++) {
1831 groups = cell.getGroups();
1832 for (int i = 0; i < groups.length; i++) {
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
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>
1855 <A NAME="getGroupNames()"><!-- --></A><H3>
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>
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.
1872 <DT><B>Returns:</B><DD>a <code>String</code> array of the group names of the cell.
1874 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
1879 <A NAME="getGroupNames(int, int)"><!-- --></A><H3>
1882 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>[] <B>getGroupNames</B>(int startIndex,
1884 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>
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.
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.
1903 <P>This method does not save the resulting data and therefore
1904 queries AFS for each call.
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.
1911 if (cell.getGroupCount() > 50000) {
1914 while (index < cell.getGroupCount()) {
1915 groups = cell.<B>getGroupNames</B>(index, length);
1916 for (int i = 0; i < groups.length; i++) {
1923 groups = cell.getGroupNames();
1924 for (int i = 0; i < groups.length; i++) {
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
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>
1947 <A NAME="getServer(java.lang.String)"><!-- --></A><H3>
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> name)
1951 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
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>.
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>
1973 <A NAME="getServerCount()"><!-- --></A><H3>
1976 public int <B>getServerCount</B>()
1977 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
1979 <DD>Returns the total number of servers associated with this Cell.
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.
1991 <DT><B>Returns:</B><DD>a <code>User</code> array of the users of the cell.
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>
1999 <A NAME="getServers()"><!-- --></A><H3>
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>
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.
2017 <DT><B>Returns:</B><DD>an <code>Server</code> array of the servers of the cell.
2019 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2024 <A NAME="getServerNames()"><!-- --></A><H3>
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>
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.
2041 <DT><B>Returns:</B><DD>a <code>String</code> array of the servers of the cell.
2043 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2048 <A NAME="getMaxGroupID()"><!-- --></A><H3>
2051 public int <B>getMaxGroupID</B>()
2052 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
2065 <DT><B>Returns:</B><DD>an integer representing the maximum group ID
2067 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2072 <A NAME="getMaxUserID()"><!-- --></A><H3>
2075 public int <B>getMaxUserID</B>()
2076 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
2089 <DT><B>Returns:</B><DD>an integer representing the maximum user ID
2091 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2096 <A NAME="getTokenExpiration()"><!-- --></A><H3>
2097 getTokenExpiration</H3>
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>
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.
2112 <DT><B>Returns:</B><DD>expiration time of the token
2114 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2119 <A NAME="getCellHandle()"><!-- --></A><H3>
2122 public int <B>getCellHandle</B>()
2123 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2125 <DD>Returns the cell handle of this cell.
2132 <DT><B>Returns:</B><DD>the cell handle
2134 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2139 <A NAME="getName()"><!-- --></A><H3>
2142 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>
2144 <DD>Returns the name of this cell.
2151 <DT><B>Returns:</B><DD>the cell name</DL>
2156 <A NAME="setMaxGroupID(int)"><!-- --></A><H3>
2159 public void <B>setMaxGroupID</B>(int maxID)
2160 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
2169 <DT><B>Parameters:</B><DD><CODE>maxID</CODE> - an integer representing the maximum group ID
2171 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2176 <A NAME="setMaxUserID(int)"><!-- --></A><H3>
2179 public void <B>setMaxUserID</B>(int maxID)
2180 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
2190 <DT><B>Parameters:</B><DD><CODE>maxID</CODE> - an integer representing the maximum user ID
2192 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
2197 <A NAME="getInfo()"><!-- --></A><H3>
2200 protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getInfo</B>()</PRE>
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.
2210 <DT><B>Returns:</B><DD>a <code>String</code> representation of this <code>Cell</code></DL>
2215 <A NAME="getInfoUsers()"><!-- --></A><H3>
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>
2221 <DD>Returns a <code>String</code> containing the <code>String</code>
2222 representations of all the users of this <code>Cell</code>.
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>
2235 <A NAME="getInfoGroups()"><!-- --></A><H3>
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>
2241 <DD>Returns a <code>String</code> containing the <code>String</code>
2242 representations of all the groups of this <code>Cell</code>.
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>
2255 <A NAME="getInfoServers()"><!-- --></A><H3>
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>
2261 <DD>Returns a <code>String</code> containing the <code>String</code>
2262 representations of all the servers of this <code>Cell</code>.
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>
2275 <A NAME="equals(org.openafs.jafs.Cell)"><!-- --></A><H3>
2278 public boolean <B>equals</B>(<A HREF="../../../org/openafs/jafs/Cell.html">Cell</A> otherCell)</PRE>
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.
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>
2294 <A NAME="toString()"><!-- --></A><H3>
2297 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
2299 <DD>Returns the name of this <CODE>Cell</CODE>
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>
2306 <DT><B>Returns:</B><DD>the name of this <CODE>Cell</CODE></DL>
2311 <A NAME="getKasUserCount(int)"><!-- --></A><H3>
2312 getKasUserCount</H3>
2314 protected static int <B>getKasUserCount</B>(int cellHandle)
2315 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2317 <DD>Returns the total number of KAS users belonging to the cell denoted
2318 by <CODE>cellHandle</CODE>.
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
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>
2332 <A NAME="getKasUsersBegin(int)"><!-- --></A><H3>
2333 getKasUsersBegin</H3>
2335 protected static int <B>getKasUsersBegin</B>(int cellHandle)
2336 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>.
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
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>
2355 <A NAME="getKasUsersBeginAt(int, int)"><!-- --></A><H3>
2356 getKasUsersBeginAt</H3>
2358 protected static int <B>getKasUsersBeginAt</B>(int cellHandle,
2359 int startIndex)
2360 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>.
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
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>
2380 <A NAME="getKasUsersNextString(int)"><!-- --></A><H3>
2381 getKasUsersNextString</H3>
2383 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getKasUsersNextString</B>(int iterationId)
2384 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>
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
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>
2402 <A NAME="getKasUsersNext(int, int, org.openafs.jafs.User)"><!-- --></A><H3>
2403 getKasUsersNext</H3>
2405 protected static int <B>getKasUsersNext</B>(int cellHandle,
2406 int iterationId,
2407 <A HREF="../../../org/openafs/jafs/User.html">User</A> theUser)
2408 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2410 <DD>Fills the next kas user object of the cell. Returns 0 if there
2411 are no more users, != 0 otherwise.
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
2419 <DT><B>Returns:</B><DD>0 if there are no more users, != 0 otherwise
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>
2427 <A NAME="getKasUsersDone(int)"><!-- --></A><H3>
2428 getKasUsersDone</H3>
2430 protected static void <B>getKasUsersDone</B>(int iterationId)
2431 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2433 <DD>Signals that the iteration is complete and will not be accessed anymore.
2439 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
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>
2446 <A NAME="getPtsUserCount(int)"><!-- --></A><H3>
2447 getPtsUserCount</H3>
2449 protected static int <B>getPtsUserCount</B>(int cellHandle)
2450 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2452 <DD>Returns the total number of PTS users belonging to the cell denoted
2453 by <CODE>cellHandle</CODE>.
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
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>
2467 <A NAME="getPtsOnlyUserCount(int)"><!-- --></A><H3>
2468 getPtsOnlyUserCount</H3>
2470 protected static int <B>getPtsOnlyUserCount</B>(int cellHandle)
2471 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2473 <DD>Returns the total number of PTS users, belonging to the cell denoted
2474 by <CODE>cellHandle</CODE>, that are not in KAS.
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
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>
2488 <A NAME="getPtsUsersBegin(int)"><!-- --></A><H3>
2489 getPtsUsersBegin</H3>
2491 protected static int <B>getPtsUsersBegin</B>(int cellHandle)
2492 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>.
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
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>
2511 <A NAME="getPtsUsersNextString(int)"><!-- --></A><H3>
2512 getPtsUsersNextString</H3>
2514 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getPtsUsersNextString</B>(int iterationId)
2515 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2517 <DD>Returns the next pts user of the cell. Returns <code>null</code> if
2518 there are no more users.
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
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>
2532 <A NAME="getPtsOnlyUsersNextString(int, int)"><!-- --></A><H3>
2533 getPtsOnlyUsersNextString</H3>
2535 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getPtsOnlyUsersNextString</B>(int iterationId,
2536 int cellHandle)
2537 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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
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>
2554 <A NAME="getPtsUsersNext(int, int, org.openafs.jafs.User)"><!-- --></A><H3>
2555 getPtsUsersNext</H3>
2557 protected static int <B>getPtsUsersNext</B>(int cellHandle,
2558 int iterationId,
2559 <A HREF="../../../org/openafs/jafs/User.html">User</A> theUser)
2560 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2562 <DD>Fills the next pts user object of the cell. Returns 0 if there
2563 are no more users, != 0 otherwise.
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
2571 <DT><B>Returns:</B><DD>0 if there are no more users, != 0 otherwise
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>
2579 <A NAME="getPtsOnlyUsersNext(int, int, org.openafs.jafs.User)"><!-- --></A><H3>
2580 getPtsOnlyUsersNext</H3>
2582 protected static int <B>getPtsOnlyUsersNext</B>(int cellHandle,
2583 int iterationId,
2584 <A HREF="../../../org/openafs/jafs/User.html">User</A> theUser)
2585 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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
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>
2604 <A NAME="getPtsUsersDone(int)"><!-- --></A><H3>
2605 getPtsUsersDone</H3>
2607 protected static void <B>getPtsUsersDone</B>(int iterationId)
2608 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2610 <DD>Signals that the iteration is complete and will not be accessed anymore.
2616 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
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>
2623 <A NAME="getGroupCount(int)"><!-- --></A><H3>
2626 protected static int <B>getGroupCount</B>(int cellHandle)
2627 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2629 <DD>Returns the total number of groups belonging to the cell denoted
2630 by <CODE>cellHandle</CODE>.
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
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>
2644 <A NAME="getGroupsBegin(int)"><!-- --></A><H3>
2647 protected static int <B>getGroupsBegin</B>(int cellHandle)
2648 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>.
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
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>
2667 <A NAME="getGroupsBeginAt(int, int)"><!-- --></A><H3>
2668 getGroupsBeginAt</H3>
2670 protected static int <B>getGroupsBeginAt</B>(int cellHandle,
2671 int startIndex)
2672 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>.
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
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>
2691 <A NAME="getGroupsNextString(int)"><!-- --></A><H3>
2692 getGroupsNextString</H3>
2694 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getGroupsNextString</B>(int iterationId)
2695 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2697 <DD>Returns the next group of the cell. Returns <code>null</code> if there
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
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>
2712 <A NAME="getGroupsNext(int, int, org.openafs.jafs.Group)"><!-- --></A><H3>
2715 protected static int <B>getGroupsNext</B>(int cellHandle,
2716 int iterationId,
2717 <A HREF="../../../org/openafs/jafs/Group.html">Group</A> theGroup)
2718 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2720 <DD>Fills the next group object of the cell. Returns 0 if there
2721 are no more groups, != 0 otherwise.
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
2729 <DT><B>Returns:</B><DD>0 if there are no more users, != 0 otherwise
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>
2737 <A NAME="getGroupsDone(int)"><!-- --></A><H3>
2740 protected static void <B>getGroupsDone</B>(int iterationId)
2741 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2743 <DD>Signals that the iteration is complete and will not be accessed anymore.
2749 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
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>
2756 <A NAME="getServerCount(int)"><!-- --></A><H3>
2759 protected static int <B>getServerCount</B>(int cellHandle)
2760 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2762 <DD>Returns the total number of servers belonging to the cell denoted
2763 by <CODE>cellHandle</CODE>.
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
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>
2777 <A NAME="getServersBegin(int)"><!-- --></A><H3>
2778 getServersBegin</H3>
2780 protected static int <B>getServersBegin</B>(int cellHandle)
2781 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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>.
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
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>
2799 <A NAME="getServersNextString(int)"><!-- --></A><H3>
2800 getServersNextString</H3>
2802 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getServersNextString</B>(int iterationId)
2803 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2805 <DD>Returns the next server of the cell. Returns <code>null</code> if there
2806 are no more servers.
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
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>
2820 <A NAME="getServersNext(int, int, org.openafs.jafs.Server)"><!-- --></A><H3>
2823 protected static int <B>getServersNext</B>(int cellHandle,
2824 int iterationId,
2825 <A HREF="../../../org/openafs/jafs/Server.html">Server</A> theServer)
2826 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2828 <DD>Fills the next server object of the cell. Returns 0 if there are no
2829 more servers, != 0 otherwise.
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
2837 <DT><B>Returns:</B><DD>0 if there are no more servers, != 0 otherwise
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>
2845 <A NAME="getServersDone(int)"><!-- --></A><H3>
2848 protected static void <B>getServersDone</B>(int iterationId)
2849 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2851 <DD>Signals that the iteration is complete and will not be accessed anymore.
2857 <DT><B>Parameters:</B><DD><CODE>iterationId</CODE> - the iteration ID of this iteration
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>
2864 <A NAME="getCellName(int)"><!-- --></A><H3>
2867 protected static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getCellName</B>(int cellHandle)
2868 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2870 <DD>Returns the name of the cell.
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
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>
2884 <A NAME="createMountPoint(int, java.lang.String, java.lang.String, boolean, boolean)"><!-- --></A><H3>
2885 createMountPoint</H3>
2887 protected static void <B>createMountPoint</B>(int cellHandle,
2888 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> directory,
2889 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> volumeName,
2890 boolean readWrite,
2891 boolean forceCheck)
2892 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2894 <DD>Creates a mount point for a volume within the file system.
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
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>
2908 <A NAME="setACL(java.lang.String, java.lang.String, boolean, boolean, boolean, boolean, boolean, boolean, boolean)"><!-- --></A><H3>
2911 public static void <B>setACL</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> directory,
2912 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> username,
2915 boolean lookup,
2916 boolean delete,
2917 boolean insert,
2920 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
2927 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
2932 <A NAME="getMaxGroupID(int)"><!-- --></A><H3>
2935 protected static int <B>getMaxGroupID</B>(int cellHandle)
2936 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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)
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
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>
2954 <A NAME="setMaxGroupID(int, int)"><!-- --></A><H3>
2957 protected static void <B>setMaxGroupID</B>(int cellHandle,
2959 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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
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>
2975 <A NAME="getMaxUserID(int)"><!-- --></A><H3>
2978 protected static int <B>getMaxUserID</B>(int cellHandle)
2979 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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)
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
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>
2997 <A NAME="setMaxUserID(int, int)"><!-- --></A><H3>
3000 protected static void <B>setMaxUserID</B>(int cellHandle,
3002 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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.
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
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>
3018 <A NAME="reclaimCellMemory()"><!-- --></A><H3>
3019 reclaimCellMemory</H3>
3021 protected static void <B>reclaimCellMemory</B>()</PRE>
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.
3036 <A NAME="getCellHandle(java.lang.String, int)"><!-- --></A><H3>
3039 protected static int <B>getCellHandle</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> cellName,
3040 int tokenHandle)
3041 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
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
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
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>
3060 <A NAME="closeCell(int)"><!-- --></A><H3>
3063 protected static void <B>closeCell</B>(int cellHandle)
3064 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
3066 <DD>Closes the given currently open cell handle.
3072 <DT><B>Parameters:</B><DD><CODE>cellHandle</CODE> - the cell handle to close
3074 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE> - If an error occurs in the native code</DL>
3077 <!-- ========= END OF CLASS DATA ========= -->
3080 <!-- ========== START OF NAVBAR ========== -->
3081 <A NAME="navbar_bottom"><!-- --></A>
3082 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
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> </TD>
3089 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
3090 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Cell.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
3091 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
3092 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
3093 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
3094 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
3098 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
3099 <B>JAFS API v2</B></EM>
3104 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
3105 <A HREF="../../../org/openafs/jafs/AFSShutdownHandler.html"><B>PREV CLASS</B></A>
3106 <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>
3109 <A HREF="Cell.html" TARGET="_top"><B>NO FRAMES</B></A>
3114 document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
3119 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
3124 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
3125 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
3126 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
3127 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
3130 <!-- =========== END OF NAVBAR =========== -->