Refactor file layout
[openafs-wiki.git] / archive / JavaAdminAPI / ACL.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc on Mon Jun 09 15:53:36 PDT 2003 -->
6 <TITLE>
7 ACL (Java AFS API)
8 </TITLE>
9 <META NAME="keywords" CONTENT="org.openafs.jafs.ACL,ACL class">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
11 </HEAD>
12 <SCRIPT>
13 function asd()
14 {
15 parent.document.title="ACL (Java AFS API)";
16 }
17 </SCRIPT>
18 <BODY BGCOLOR="white" onload="asd();">
19
20 <!-- ========== START OF NAVBAR ========== -->
21 <A NAME="navbar_top"><!-- --></A>
22 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
23 <TR>
24 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
25 <A NAME="navbar_top_firstrow"><!-- --></A>
26 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
27   <TR ALIGN="center" VALIGN="top">
28   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
29   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
30   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ACL.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
31   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
32   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
33   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
34   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
35   </TR>
36 </TABLE>
37 </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
40 </TD>
41 </TR>
42
43 <TR>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 &nbsp;PREV CLASS&nbsp;
46 &nbsp;<A HREF="../../../org/openafs/jafs/ACL.Entry.html"><B>NEXT CLASS</B></A></FONT></TD>
47 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
48   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
49 &nbsp;<A HREF="ACL.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
50 &nbsp;
51 <SCRIPT>
52   <!--
53   if(window==top) {
54     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
55   }
56   //-->
57 </SCRIPT>
58 <NOSCRIPT>
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
60 </NOSCRIPT>
61 </FONT></TD>
62 </TR>
63 <TR>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65   SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
68 </TR>
69 </TABLE>
70 <!-- =========== END OF NAVBAR =========== -->
71
72 <HR>
73 <!-- ======== START OF CLASS DATA ======== -->
74 <H2>
75 <FONT SIZE="-1">
76 org.openafs.jafs</FONT>
77 <BR>
78 Class ACL</H2>
79 <PRE>
80 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">java.lang.Object</A>
81   |
82   +--<B>org.openafs.jafs.ACL</B>
83 </PRE>
84 <DL>
85 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Serializable.html">Serializable</A></DD>
86 </DL>
87 <HR>
88 <DL>
89 <DT>public class <B>ACL</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A><DT>implements <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Serializable.html">Serializable</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A></DL>
90
91 <P>
92 An abstract representation of AFS file and directory pathnames.
93
94  This class is an extension of the standard Java File class with file-based 
95  manipulation methods overridden by integrated AFS native methods.
96 <P>
97
98 <P>
99 <DL>
100 <DT><B>Version:</B></DT>
101   <DD>2.2, 03/24/2003 - Added new Delta ACL functionality and changes 
102                             from Stonehenge., 2.0, 04/18/2001 - Completely revised class for efficiency.</DD>
103 <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html" TARGET="org.openafs.jafs.ACL">Serialized Form</A></DL>
104 <HR>
105
106 <P>
107 <!-- ======== NESTED CLASS SUMMARY ======== -->
108
109 <A NAME="nested_class_summary"><!-- --></A>
110 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
111 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
112 <TD COLSPAN=2><FONT SIZE="+2">
113 <B>Nested Class Summary</B></FONT></TD>
114 </TR>
115 <TR BGCOLOR="white" CLASS="TableRowColor">
116 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
117 <CODE>static&nbsp;class</CODE></FONT></TD>
118 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A></B></CODE>
119
120 <BR>
121 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;AFS ACL Entry Class.
122
123  </TD>
124 </TR>
125 </TABLE>
126 &nbsp;
127 <!-- =========== FIELD SUMMARY =========== -->
128
129
130 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
131
132 <A NAME="constructor_summary"><!-- --></A>
133 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
134 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
135 <TD COLSPAN=2><FONT SIZE="+2">
136 <B>Constructor Summary</B></FONT></TD>
137 </TR>
138 <TR BGCOLOR="white" CLASS="TableRowColor">
139 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#ACL(java.lang.String)">ACL</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;path)</CODE>
140
141 <BR>
142 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
143 </TR>
144 <TR BGCOLOR="white" CLASS="TableRowColor">
145 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#ACL(java.lang.String, boolean)">ACL</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;path,
146     boolean&nbsp;init)</CODE>
147
148 <BR>
149 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
150 </TR>
151 </TABLE>
152 &nbsp;
153 <!-- ========== METHOD SUMMARY =========== -->
154
155 <A NAME="method_summary"><!-- --></A>
156 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
157 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
158 <TD COLSPAN=2><FONT SIZE="+2">
159 <B>Method Summary</B></FONT></TD>
160 </TR>
161 <TR BGCOLOR="white" CLASS="TableRowColor">
162 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163 <CODE>&nbsp;void</CODE></FONT></TD>
164 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#addNegativeEntries(org.openafs.jafs.ACL.Entry[])">addNegativeEntries</A></B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[]&nbsp;entries)</CODE>
165
166 <BR>
167 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the provided list of negative ACL entries to this ACL instance.</TD>
168 </TR>
169 <TR BGCOLOR="white" CLASS="TableRowColor">
170 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171 <CODE>&nbsp;void</CODE></FONT></TD>
172 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#addNegativeEntry(org.openafs.jafs.ACL.Entry)">addNegativeEntry</A></B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)</CODE>
173
174 <BR>
175 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a single negative ACL entry to this ACL instance.</TD>
176 </TR>
177 <TR BGCOLOR="white" CLASS="TableRowColor">
178 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179 <CODE>&nbsp;void</CODE></FONT></TD>
180 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#addNegativeExpungeEntry(org.openafs.jafs.ACL.Entry)">addNegativeExpungeEntry</A></B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)</CODE>
181
182 <BR>
183 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a negative ACL entry to the list of negative ACL entries to be 
184  expunged; used in Delta ACLs.</TD>
185 </TR>
186 <TR BGCOLOR="white" CLASS="TableRowColor">
187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188 <CODE>&nbsp;void</CODE></FONT></TD>
189 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#addPositiveEntries(org.openafs.jafs.ACL.Entry[])">addPositiveEntries</A></B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[]&nbsp;entries)</CODE>
190
191 <BR>
192 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the provided list of positive ACL entries to this ACL instance.</TD>
193 </TR>
194 <TR BGCOLOR="white" CLASS="TableRowColor">
195 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196 <CODE>&nbsp;void</CODE></FONT></TD>
197 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#addPositiveEntry(org.openafs.jafs.ACL.Entry)">addPositiveEntry</A></B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)</CODE>
198
199 <BR>
200 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a single positive ACL entry to this ACL instance.</TD>
201 </TR>
202 <TR BGCOLOR="white" CLASS="TableRowColor">
203 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204 <CODE>&nbsp;void</CODE></FONT></TD>
205 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#addPositiveExpungeEntry(org.openafs.jafs.ACL.Entry)">addPositiveExpungeEntry</A></B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)</CODE>
206
207 <BR>
208 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a positive ACL entry to the list of positive ACL entries to be 
209  expunged; used in Delta ACLs.</TD>
210 </TR>
211 <TR BGCOLOR="white" CLASS="TableRowColor">
212 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213 <CODE>&nbsp;int</CODE></FONT></TD>
214 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#compareTo(org.openafs.jafs.ACL)">compareTo</A></B>(<A HREF="../../../org/openafs/jafs/ACL.html">ACL</A>&nbsp;acl)</CODE>
215
216 <BR>
217 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares two ACL objects respective to their paths and does not
218  factor any other attribute.    </TD>
219 </TR>
220 <TR BGCOLOR="white" CLASS="TableRowColor">
221 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222 <CODE>&nbsp;int</CODE></FONT></TD>
223 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#compareTo(java.lang.Object)">compareTo</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A>&nbsp;obj)</CODE>
224
225 <BR>
226 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Comparable interface method.</TD>
227 </TR>
228 <TR BGCOLOR="white" CLASS="TableRowColor">
229 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230 <CODE>&nbsp;boolean</CODE></FONT></TD>
231 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#containsNegative(org.openafs.jafs.ACL.Entry)">containsNegative</A></B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)</CODE>
232
233 <BR>
234 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this ACL contains the specified ACL entry.</TD>
235 </TR>
236 <TR BGCOLOR="white" CLASS="TableRowColor">
237 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238 <CODE>&nbsp;boolean</CODE></FONT></TD>
239 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#containsPositiveEntry(org.openafs.jafs.ACL.Entry)">containsPositiveEntry</A></B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)</CODE>
240
241 <BR>
242 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this ACL contains the specified ACL entry.</TD>
243 </TR>
244 <TR BGCOLOR="white" CLASS="TableRowColor">
245 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246 <CODE>&nbsp;boolean</CODE></FONT></TD>
247 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#equals(org.openafs.jafs.ACL)">equals</A></B>(<A HREF="../../../org/openafs/jafs/ACL.html">ACL</A>&nbsp;acl)</CODE>
248
249 <BR>
250 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests whether two <code>ACL</code> objects are equal, based on their 
251  paths and permission bits.</TD>
252 </TR>
253 <TR BGCOLOR="white" CLASS="TableRowColor">
254 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
255 <CODE>&nbsp;void</CODE></FONT></TD>
256 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#flush()">flush</A></B>()</CODE>
257
258 <BR>
259 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes the ACL to AFS, making all changes immediately effective.
260  </TD>
261 </TR>
262 <TR BGCOLOR="white" CLASS="TableRowColor">
263 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/ACL.html">ACL</A></CODE></FONT></TD>
265 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#getDeltaACL(org.openafs.jafs.ACL)">getDeltaACL</A></B>(<A HREF="../../../org/openafs/jafs/ACL.html">ACL</A>&nbsp;acl)</CODE>
266
267 <BR>
268 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a "Delta ACL", which is an ACL that represents only the difference
269  (delta) of two ACLs, relative to the current ACL instance by the provided
270  ACL specified by <code>acl</code>.
271
272  </TD>
273 </TR>
274 <TR BGCOLOR="white" CLASS="TableRowColor">
275 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
276 <CODE>&nbsp;int</CODE></FONT></TD>
277 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#getEntryCount()">getEntryCount</A></B>()</CODE>
278
279 <BR>
280 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the total number of ACL entries, this is the sum of positive
281  and negative entries.</TD>
282 </TR>
283 <TR BGCOLOR="white" CLASS="TableRowColor">
284 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[]</CODE></FONT></TD>
286 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#getNegativeEntries()">getNegativeEntries</A></B>()</CODE>
287
288 <BR>
289 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns all negative ACL entries for this ACL instance.</TD>
290 </TR>
291 <TR BGCOLOR="white" CLASS="TableRowColor">
292 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A></CODE></FONT></TD>
294 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#getNegativeEntry(java.lang.String)">getNegativeEntry</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
295
296 <BR>
297 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the negative ACL entry associated with the specified 
298  user/group name.</TD>
299 </TR>
300 <TR BGCOLOR="white" CLASS="TableRowColor">
301 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
302 <CODE>&nbsp;int</CODE></FONT></TD>
303 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#getNegativeEntryCount()">getNegativeEntryCount</A></B>()</CODE>
304
305 <BR>
306 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of negative ACL entries for this ACL instance.</TD>
307 </TR>
308 <TR BGCOLOR="white" CLASS="TableRowColor">
309 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
310 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[]</CODE></FONT></TD>
311 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#getNegativeExpungeEntries()">getNegativeExpungeEntries</A></B>()</CODE>
312
313 <BR>
314 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns all negative ACL entries to be expunged; used in Delta ACLs.</TD>
315 </TR>
316 <TR BGCOLOR="white" CLASS="TableRowColor">
317 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
318 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
319 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#getPath()">getPath</A></B>()</CODE>
320
321 <BR>
322 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the path this ACL instance is bound to.</TD>
323 </TR>
324 <TR BGCOLOR="white" CLASS="TableRowColor">
325 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
326 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[]</CODE></FONT></TD>
327 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#getPositiveEntries()">getPositiveEntries</A></B>()</CODE>
328
329 <BR>
330 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns all positive ACL entries for this ACL instance.</TD>
331 </TR>
332 <TR BGCOLOR="white" CLASS="TableRowColor">
333 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
334 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A></CODE></FONT></TD>
335 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#getPositiveEntry(java.lang.String)">getPositiveEntry</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
336
337 <BR>
338 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the positive ACL entry associated with the specified 
339  user/group name.</TD>
340 </TR>
341 <TR BGCOLOR="white" CLASS="TableRowColor">
342 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
343 <CODE>&nbsp;int</CODE></FONT></TD>
344 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#getPositiveEntryCount()">getPositiveEntryCount</A></B>()</CODE>
345
346 <BR>
347 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of positive ACL entries for this ACL instance.</TD>
348 </TR>
349 <TR BGCOLOR="white" CLASS="TableRowColor">
350 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
351 <CODE>&nbsp;<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[]</CODE></FONT></TD>
352 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#getPositiveExpungeEntries()">getPositiveExpungeEntries</A></B>()</CODE>
353
354 <BR>
355 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns all positive ACL entries to be expunged; used in Delta ACLs.</TD>
356 </TR>
357 <TR BGCOLOR="white" CLASS="TableRowColor">
358 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
359 <CODE>&nbsp;void</CODE></FONT></TD>
360 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#removeAllNegativeEntries()">removeAllNegativeEntries</A></B>()</CODE>
361
362 <BR>
363 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all negative ACL entries from this ACL instance.</TD>
364 </TR>
365 <TR BGCOLOR="white" CLASS="TableRowColor">
366 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
367 <CODE>&nbsp;void</CODE></FONT></TD>
368 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#removeAllPositiveEntries()">removeAllPositiveEntries</A></B>()</CODE>
369
370 <BR>
371 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all positive ACL entries from this ACL instance.</TD>
372 </TR>
373 <TR BGCOLOR="white" CLASS="TableRowColor">
374 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
375 <CODE>&nbsp;void</CODE></FONT></TD>
376 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#removeNegativeEntry(org.openafs.jafs.ACL.Entry)">removeNegativeEntry</A></B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)</CODE>
377
378 <BR>
379 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a single negative ACL entry from this ACL instance.</TD>
380 </TR>
381 <TR BGCOLOR="white" CLASS="TableRowColor">
382 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
383 <CODE>&nbsp;void</CODE></FONT></TD>
384 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#removePositiveEntry(org.openafs.jafs.ACL.Entry)">removePositiveEntry</A></B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)</CODE>
385
386 <BR>
387 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a single positive ACL entry from this ACL instance.</TD>
388 </TR>
389 <TR BGCOLOR="white" CLASS="TableRowColor">
390 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
391 <CODE>&nbsp;void</CODE></FONT></TD>
392 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#setNegativeEntries(org.openafs.jafs.ACL.Entry[])">setNegativeEntries</A></B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[]&nbsp;entries)</CODE>
393
394 <BR>
395 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the complete array of negative ACL entries to the provided
396  ACL entry list (<code>entries</code>) for this ACL instance.</TD>
397 </TR>
398 <TR BGCOLOR="white" CLASS="TableRowColor">
399 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
400 <CODE>&nbsp;void</CODE></FONT></TD>
401 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#setPositiveEntries(org.openafs.jafs.ACL.Entry[])">setPositiveEntries</A></B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[]&nbsp;entries)</CODE>
402
403 <BR>
404 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the complete array of positive ACL entries to the provided
405  ACL entry list (<code>entries</code>) for this ACL instance.</TD>
406 </TR>
407 <TR BGCOLOR="white" CLASS="TableRowColor">
408 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
409 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
410 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#toString()">toString</A></B>()</CODE>
411
412 <BR>
413 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a String representation of this <CODE>ACL</CODE></TD>
414 </TR>
415 <TR BGCOLOR="white" CLASS="TableRowColor">
416 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
417 <CODE>&nbsp;void</CODE></FONT></TD>
418 <TD><CODE><B><A HREF="../../../org/openafs/jafs/ACL.html#update(org.openafs.jafs.ACL)">update</A></B>(<A HREF="../../../org/openafs/jafs/ACL.html">ACL</A>&nbsp;delta)</CODE>
419
420 <BR>
421 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Updates the current ACL instance by replacing, adding, or deleting 
422  ACL entries designated by the specified Delta ACL (<code>delta</code>).
423
424  </TD>
425 </TR>
426 </TABLE>
427 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
428 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
429 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
430 <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>
431 </TR>
432 <TR BGCOLOR="white" CLASS="TableRowColor">
433 <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>
434 </TR>
435 </TABLE>
436 &nbsp;
437 <P>
438
439 <!-- ============ FIELD DETAIL =========== -->
440
441
442 <!-- ========= CONSTRUCTOR DETAIL ======== -->
443
444 <A NAME="constructor_detail"><!-- --></A>
445 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
446 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
447 <TD COLSPAN=1><FONT SIZE="+2">
448 <B>Constructor Detail</B></FONT></TD>
449 </TR>
450 </TABLE>
451
452 <A NAME="ACL(java.lang.String)"><!-- --></A><H3>
453 ACL</H3>
454 <PRE>
455 public <B>ACL</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;path)
456     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
457 <DL>
458 </DL>
459 <HR>
460
461 <A NAME="ACL(java.lang.String, boolean)"><!-- --></A><H3>
462 ACL</H3>
463 <PRE>
464 public <B>ACL</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;path,
465            boolean&nbsp;init)
466     throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
467 <DL>
468 </DL>
469
470 <!-- ============ METHOD DETAIL ========== -->
471
472 <A NAME="method_detail"><!-- --></A>
473 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
474 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
475 <TD COLSPAN=1><FONT SIZE="+2">
476 <B>Method Detail</B></FONT></TD>
477 </TR>
478 </TABLE>
479
480 <A NAME="getEntryCount()"><!-- --></A><H3>
481 getEntryCount</H3>
482 <PRE>
483 public int <B>getEntryCount</B>()</PRE>
484 <DL>
485 <DD>Returns the total number of ACL entries, this is the sum of positive
486  and negative entries.
487 <P>
488 <DD><DL>
489 </DL>
490 </DD>
491 <DD><DL>
492
493 <DT><B>Returns:</B><DD>Total number of ACL entries</DL>
494 </DD>
495 </DL>
496 <HR>
497
498 <A NAME="getPath()"><!-- --></A><H3>
499 getPath</H3>
500 <PRE>
501 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getPath</B>()</PRE>
502 <DL>
503 <DD>Returns the path this ACL instance is bound to.
504 <P>
505 <DD><DL>
506 </DL>
507 </DD>
508 <DD><DL>
509
510 <DT><B>Returns:</B><DD>Path for this ACL</DL>
511 </DD>
512 </DL>
513 <HR>
514
515 <A NAME="flush()"><!-- --></A><H3>
516 flush</H3>
517 <PRE>
518 public void <B>flush</B>()
519            throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
520 <DL>
521 <DD>Writes the ACL to AFS, making all changes immediately effective.
522  This method requires an active connection to AFS.
523 <P>
524 <DD><DL>
525 </DL>
526 </DD>
527 <DD><DL>
528
529 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
530 </DD>
531 </DL>
532 <HR>
533
534 <A NAME="getPositiveEntryCount()"><!-- --></A><H3>
535 getPositiveEntryCount</H3>
536 <PRE>
537 public int <B>getPositiveEntryCount</B>()</PRE>
538 <DL>
539 <DD>Returns the number of positive ACL entries for this ACL instance.
540 <P>
541 <DD><DL>
542 </DL>
543 </DD>
544 <DD><DL>
545
546 <DT><B>Returns:</B><DD>Positive ACL entry count</DL>
547 </DD>
548 </DL>
549 <HR>
550
551 <A NAME="getPositiveEntries()"><!-- --></A><H3>
552 getPositiveEntries</H3>
553 <PRE>
554 public <A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[] <B>getPositiveEntries</B>()</PRE>
555 <DL>
556 <DD>Returns all positive ACL entries for this ACL instance.
557 <P>
558 <DD><DL>
559 </DL>
560 </DD>
561 <DD><DL>
562
563 <DT><B>Returns:</B><DD>All positive ACL entries</DL>
564 </DD>
565 </DL>
566 <HR>
567
568 <A NAME="getPositiveEntry(java.lang.String)"><!-- --></A><H3>
569 getPositiveEntry</H3>
570 <PRE>
571 public <A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A> <B>getPositiveEntry</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
572 <DL>
573 <DD>Returns the positive ACL entry associated with the specified 
574  user/group name.
575 <P>
576 <DD><DL>
577 </DL>
578 </DD>
579 <DD><DL>
580 <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of user/group for desired ACL entry.
581 <DT><B>Returns:</B><DD>Positive ACL entry<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ACL.Entry.html#getUser()"><CODE>ACL.Entry.getUser()</CODE></A></DL>
582 </DD>
583 </DL>
584 <HR>
585
586 <A NAME="getPositiveExpungeEntries()"><!-- --></A><H3>
587 getPositiveExpungeEntries</H3>
588 <PRE>
589 public <A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[] <B>getPositiveExpungeEntries</B>()</PRE>
590 <DL>
591 <DD>Returns all positive ACL entries to be expunged; used in Delta ACLs.
592 <P>
593 <DD><DL>
594 </DL>
595 </DD>
596 <DD><DL>
597
598 <DT><B>Returns:</B><DD>All positive ACL entries</DL>
599 </DD>
600 </DL>
601 <HR>
602
603 <A NAME="containsPositiveEntry(org.openafs.jafs.ACL.Entry)"><!-- --></A><H3>
604 containsPositiveEntry</H3>
605 <PRE>
606 public boolean <B>containsPositiveEntry</B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)</PRE>
607 <DL>
608 <DD>Returns <code>true</code> if this ACL contains the specified ACL entry.
609 <P>
610 <DD><DL>
611 </DL>
612 </DD>
613 <DD><DL>
614 <DT><B>Parameters:</B><DD><CODE>entry</CODE> - Positive ACL entry
615 <DT><B>Returns:</B><DD><code>true</code> if the specified ACL entry is present; 
616          <code>false</code> otherwise.</DL>
617 </DD>
618 </DL>
619 <HR>
620
621 <A NAME="addPositiveEntry(org.openafs.jafs.ACL.Entry)"><!-- --></A><H3>
622 addPositiveEntry</H3>
623 <PRE>
624 public void <B>addPositiveEntry</B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)
625                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
626 <DL>
627 <DD>Adds a single positive ACL entry to this ACL instance.
628 <P>
629 <DD><DL>
630 </DL>
631 </DD>
632 <DD><DL>
633 <DT><B>Parameters:</B><DD><CODE>entry</CODE> - ACL.Entry object to add
634 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
635 </DD>
636 </DL>
637 <HR>
638
639 <A NAME="addPositiveEntries(org.openafs.jafs.ACL.Entry[])"><!-- --></A><H3>
640 addPositiveEntries</H3>
641 <PRE>
642 public void <B>addPositiveEntries</B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[]&nbsp;entries)
643                         throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
644 <DL>
645 <DD>Adds the provided list of positive ACL entries to this ACL instance.
646 <P>
647 <DD><DL>
648 </DL>
649 </DD>
650 <DD><DL>
651 <DT><B>Parameters:</B><DD><CODE>entries</CODE> - Array of ACL.Entry objects to add
652 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
653 </DD>
654 </DL>
655 <HR>
656
657 <A NAME="setPositiveEntries(org.openafs.jafs.ACL.Entry[])"><!-- --></A><H3>
658 setPositiveEntries</H3>
659 <PRE>
660 public void <B>setPositiveEntries</B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[]&nbsp;entries)
661                         throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
662 <DL>
663 <DD>Sets the complete array of positive ACL entries to the provided
664  ACL entry list (<code>entries</code>) for this ACL instance.
665 <P>
666 <DD><DL>
667 </DL>
668 </DD>
669 <DD><DL>
670 <DT><B>Parameters:</B><DD><CODE>entries</CODE> - Array of ACL.Entry objects that represent this
671                 ACL's positive entry list.
672 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
673 </DD>
674 </DL>
675 <HR>
676
677 <A NAME="addPositiveExpungeEntry(org.openafs.jafs.ACL.Entry)"><!-- --></A><H3>
678 addPositiveExpungeEntry</H3>
679 <PRE>
680 public void <B>addPositiveExpungeEntry</B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)
681                              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
682 <DL>
683 <DD>Add a positive ACL entry to the list of positive ACL entries to be 
684  expunged; used in Delta ACLs.
685 <P>
686 <DD><DL>
687 </DL>
688 </DD>
689 <DD><DL>
690 <DT><B>Parameters:</B><DD><CODE>entry</CODE> - Positive ACL entries to be expunged.
691 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
692 </DD>
693 </DL>
694 <HR>
695
696 <A NAME="removePositiveEntry(org.openafs.jafs.ACL.Entry)"><!-- --></A><H3>
697 removePositiveEntry</H3>
698 <PRE>
699 public void <B>removePositiveEntry</B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)
700                          throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
701 <DL>
702 <DD>Removes a single positive ACL entry from this ACL instance.
703 <P>
704 <DD><DL>
705 </DL>
706 </DD>
707 <DD><DL>
708 <DT><B>Parameters:</B><DD><CODE>entry</CODE> - ACL.Entry object to removed
709 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
710 </DD>
711 </DL>
712 <HR>
713
714 <A NAME="removeAllPositiveEntries()"><!-- --></A><H3>
715 removeAllPositiveEntries</H3>
716 <PRE>
717 public void <B>removeAllPositiveEntries</B>()
718                               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
719 <DL>
720 <DD>Removes all positive ACL entries from this ACL instance.
721 <P>
722 <DD><DL>
723 </DL>
724 </DD>
725 <DD><DL>
726
727 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
728 </DD>
729 </DL>
730 <HR>
731
732 <A NAME="getNegativeEntryCount()"><!-- --></A><H3>
733 getNegativeEntryCount</H3>
734 <PRE>
735 public int <B>getNegativeEntryCount</B>()</PRE>
736 <DL>
737 <DD>Returns the number of negative ACL entries for this ACL instance.
738 <P>
739 <DD><DL>
740 </DL>
741 </DD>
742 <DD><DL>
743
744 <DT><B>Returns:</B><DD>Negative ACL entry count</DL>
745 </DD>
746 </DL>
747 <HR>
748
749 <A NAME="getNegativeEntries()"><!-- --></A><H3>
750 getNegativeEntries</H3>
751 <PRE>
752 public <A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[] <B>getNegativeEntries</B>()</PRE>
753 <DL>
754 <DD>Returns all negative ACL entries for this ACL instance.
755 <P>
756 <DD><DL>
757 </DL>
758 </DD>
759 <DD><DL>
760
761 <DT><B>Returns:</B><DD>All negative ACL entries</DL>
762 </DD>
763 </DL>
764 <HR>
765
766 <A NAME="getNegativeEntry(java.lang.String)"><!-- --></A><H3>
767 getNegativeEntry</H3>
768 <PRE>
769 public <A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A> <B>getNegativeEntry</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name)</PRE>
770 <DL>
771 <DD>Returns the negative ACL entry associated with the specified 
772  user/group name.
773 <P>
774 <DD><DL>
775 </DL>
776 </DD>
777 <DD><DL>
778 <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of user/group for desired ACL entry.
779 <DT><B>Returns:</B><DD>Negative ACL entry<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ACL.Entry.html#getUser()"><CODE>ACL.Entry.getUser()</CODE></A></DL>
780 </DD>
781 </DL>
782 <HR>
783
784 <A NAME="getNegativeExpungeEntries()"><!-- --></A><H3>
785 getNegativeExpungeEntries</H3>
786 <PRE>
787 public <A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[] <B>getNegativeExpungeEntries</B>()</PRE>
788 <DL>
789 <DD>Returns all negative ACL entries to be expunged; used in Delta ACLs.
790 <P>
791 <DD><DL>
792 </DL>
793 </DD>
794 <DD><DL>
795
796 <DT><B>Returns:</B><DD>All negative ACL entries to be expunged.</DL>
797 </DD>
798 </DL>
799 <HR>
800
801 <A NAME="containsNegative(org.openafs.jafs.ACL.Entry)"><!-- --></A><H3>
802 containsNegative</H3>
803 <PRE>
804 public boolean <B>containsNegative</B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)</PRE>
805 <DL>
806 <DD>Returns <code>true</code> if this ACL contains the specified ACL entry.
807 <P>
808 <DD><DL>
809 </DL>
810 </DD>
811 <DD><DL>
812 <DT><B>Parameters:</B><DD><CODE>entry</CODE> - Negative ACL entry
813 <DT><B>Returns:</B><DD><code>true</code> if the specified ACL entry is present; 
814          <code>false</code> otherwise.</DL>
815 </DD>
816 </DL>
817 <HR>
818
819 <A NAME="addNegativeEntry(org.openafs.jafs.ACL.Entry)"><!-- --></A><H3>
820 addNegativeEntry</H3>
821 <PRE>
822 public void <B>addNegativeEntry</B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)
823                       throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
824 <DL>
825 <DD>Adds a single negative ACL entry to this ACL instance.
826 <P>
827 <DD><DL>
828 </DL>
829 </DD>
830 <DD><DL>
831 <DT><B>Parameters:</B><DD><CODE>entry</CODE> - ACL.Entry object to add
832 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
833 </DD>
834 </DL>
835 <HR>
836
837 <A NAME="addNegativeEntries(org.openafs.jafs.ACL.Entry[])"><!-- --></A><H3>
838 addNegativeEntries</H3>
839 <PRE>
840 public void <B>addNegativeEntries</B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[]&nbsp;entries)
841                         throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
842 <DL>
843 <DD>Adds the provided list of negative ACL entries to this ACL instance.
844 <P>
845 <DD><DL>
846 </DL>
847 </DD>
848 <DD><DL>
849 <DT><B>Parameters:</B><DD><CODE>entries</CODE> - Array of ACL.Entry objects to add
850 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
851 </DD>
852 </DL>
853 <HR>
854
855 <A NAME="addNegativeExpungeEntry(org.openafs.jafs.ACL.Entry)"><!-- --></A><H3>
856 addNegativeExpungeEntry</H3>
857 <PRE>
858 public void <B>addNegativeExpungeEntry</B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)
859                              throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
860 <DL>
861 <DD>Add a negative ACL entry to the list of negative ACL entries to be 
862  expunged; used in Delta ACLs.
863 <P>
864 <DD><DL>
865 </DL>
866 </DD>
867 <DD><DL>
868 <DT><B>Parameters:</B><DD><CODE>entry</CODE> - Negative ACL entries to be expunged.
869 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
870 </DD>
871 </DL>
872 <HR>
873
874 <A NAME="setNegativeEntries(org.openafs.jafs.ACL.Entry[])"><!-- --></A><H3>
875 setNegativeEntries</H3>
876 <PRE>
877 public void <B>setNegativeEntries</B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>[]&nbsp;entries)
878                         throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
879 <DL>
880 <DD>Sets the complete array of negative ACL entries to the provided
881  ACL entry list (<code>entries</code>) for this ACL instance.
882 <P>
883 <DD><DL>
884 </DL>
885 </DD>
886 <DD><DL>
887 <DT><B>Parameters:</B><DD><CODE>entries</CODE> - Array of ACL.Entry objects that represent this
888                 ACL's negative entry list.
889 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
890 </DD>
891 </DL>
892 <HR>
893
894 <A NAME="removeNegativeEntry(org.openafs.jafs.ACL.Entry)"><!-- --></A><H3>
895 removeNegativeEntry</H3>
896 <PRE>
897 public void <B>removeNegativeEntry</B>(<A HREF="../../../org/openafs/jafs/ACL.Entry.html">ACL.Entry</A>&nbsp;entry)
898                          throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
899 <DL>
900 <DD>Removes a single negative ACL entry from this ACL instance.
901 <P>
902 <DD><DL>
903 </DL>
904 </DD>
905 <DD><DL>
906 <DT><B>Parameters:</B><DD><CODE>entry</CODE> - ACL.Entry object to removed
907 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
908 </DD>
909 </DL>
910 <HR>
911
912 <A NAME="removeAllNegativeEntries()"><!-- --></A><H3>
913 removeAllNegativeEntries</H3>
914 <PRE>
915 public void <B>removeAllNegativeEntries</B>()
916                               throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
917 <DL>
918 <DD>Removes all negative ACL entries from this ACL instance.
919 <P>
920 <DD><DL>
921 </DL>
922 </DD>
923 <DD><DL>
924
925 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
926 </DD>
927 </DL>
928 <HR>
929
930 <A NAME="getDeltaACL(org.openafs.jafs.ACL)"><!-- --></A><H3>
931 getDeltaACL</H3>
932 <PRE>
933 public <A HREF="../../../org/openafs/jafs/ACL.html">ACL</A> <B>getDeltaACL</B>(<A HREF="../../../org/openafs/jafs/ACL.html">ACL</A>&nbsp;acl)
934                 throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
935 <DL>
936 <DD>Returns a "Delta ACL", which is an ACL that represents only the difference
937  (delta) of two ACLs, relative to the current ACL instance by the provided
938  ACL specified by <code>acl</code>.
939
940  <P> This ACL instance represents the base or reference object while the 
941  provided ACL (<code>acl</code>) represents the object in question. 
942  Therefore, if the provided ACL has an entry that differs from the base ACL,
943  then the resulting Delta ACL will contain that entry found in the provided 
944  ACL; base ACL entries are never entered into the Delta ACL, but rather are
945  used solely for comparison.
946 <P>
947 <DD><DL>
948 </DL>
949 </DD>
950 <DD><DL>
951 <DT><B>Parameters:</B><DD><CODE>acl</CODE> - the ACL to compare this ACL instance to
952 <DT><B>Returns:</B><DD>Delta ACL by comparing this ACL instance with <code>acl</code>
953 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
954 </DD>
955 </DL>
956 <HR>
957
958 <A NAME="update(org.openafs.jafs.ACL)"><!-- --></A><H3>
959 update</H3>
960 <PRE>
961 public void <B>update</B>(<A HREF="../../../org/openafs/jafs/ACL.html">ACL</A>&nbsp;delta)
962             throws <A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></PRE>
963 <DL>
964 <DD>Updates the current ACL instance by replacing, adding, or deleting 
965  ACL entries designated by the specified Delta ACL (<code>delta</code>).
966
967  <P> If the provided Delta ACL has an entry that differs from this ACL 
968  instance, then the ACL entry of the Delta ACL will be set.
969 <P>
970 <DD><DL>
971 </DL>
972 </DD>
973 <DD><DL>
974 <DT><B>Parameters:</B><DD><CODE>delta</CODE> - the Delta ACL to be applied to this ACL instance
975 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSException.html">AFSException</A></CODE></DL>
976 </DD>
977 </DL>
978 <HR>
979
980 <A NAME="compareTo(org.openafs.jafs.ACL)"><!-- --></A><H3>
981 compareTo</H3>
982 <PRE>
983 public int <B>compareTo</B>(<A HREF="../../../org/openafs/jafs/ACL.html">ACL</A>&nbsp;acl)</PRE>
984 <DL>
985 <DD>Compares two ACL objects respective to their paths and does not
986  factor any other attribute.    Alphabetic case is significant in 
987  comparing names.
988 <P>
989 <DD><DL>
990 </DL>
991 </DD>
992 <DD><DL>
993 <DT><B>Parameters:</B><DD><CODE>acl</CODE> - The ACL object to be compared to this ACL
994                    instance
995 <DT><B>Returns:</B><DD>Zero if the argument is equal to this ACL's path, a
996                 value less than zero if this ACL's path is
997                 lexicographically less than the argument, or a value greater
998                 than zero if this ACL's path is lexicographically
999                 greater than the argument</DL>
1000 </DD>
1001 </DL>
1002 <HR>
1003
1004 <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
1005 compareTo</H3>
1006 <PRE>
1007 public int <B>compareTo</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A>&nbsp;obj)</PRE>
1008 <DL>
1009 <DD>Comparable interface method.
1010 <P>
1011 <DD><DL>
1012 <DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html">Comparable</A></CODE></DL>
1013 </DD>
1014 <DD><DL>
1015 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ACL.html#compareTo(org.openafs.jafs.ACL)"><CODE>compareTo(ACL)</CODE></A></DL>
1016 </DD>
1017 </DL>
1018 <HR>
1019
1020 <A NAME="equals(org.openafs.jafs.ACL)"><!-- --></A><H3>
1021 equals</H3>
1022 <PRE>
1023 public boolean <B>equals</B>(<A HREF="../../../org/openafs/jafs/ACL.html">ACL</A>&nbsp;acl)</PRE>
1024 <DL>
1025 <DD>Tests whether two <code>ACL</code> objects are equal, based on their 
1026  paths and permission bits.
1027 <P>
1028 <DD><DL>
1029 </DL>
1030 </DD>
1031 <DD><DL>
1032 <DT><B>Parameters:</B><DD><CODE>acl</CODE> - the ACL to test
1033 <DT><B>Returns:</B><DD>whether the specifed ACL is the same as this ACL</DL>
1034 </DD>
1035 </DL>
1036 <HR>
1037
1038 <A NAME="toString()"><!-- --></A><H3>
1039 toString</H3>
1040 <PRE>
1041 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
1042 <DL>
1043 <DD>Returns a String representation of this <CODE>ACL</CODE>
1044 <P>
1045 <DD><DL>
1046 <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>
1047 </DD>
1048 <DD><DL>
1049
1050 <DT><B>Returns:</B><DD>a String representation of this <CODE>ACL</CODE></DL>
1051 </DD>
1052 </DL>
1053 <!-- ========= END OF CLASS DATA ========= -->
1054 <HR>
1055
1056 <!-- ========== START OF NAVBAR ========== -->
1057 <A NAME="navbar_bottom"><!-- --></A>
1058 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
1059 <TR>
1060 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1061 <A NAME="navbar_bottom_firstrow"><!-- --></A>
1062 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
1063   <TR ALIGN="center" VALIGN="top">
1064   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1065   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1066   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ACL.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
1067   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1068   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1069   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1070   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1071   </TR>
1072 </TABLE>
1073 </TD>
1074 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1075 <B>JAFS API v2</B></EM>
1076 </TD>
1077 </TR>
1078
1079 <TR>
1080 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1081 &nbsp;PREV CLASS&nbsp;
1082 &nbsp;<A HREF="../../../org/openafs/jafs/ACL.Entry.html"><B>NEXT CLASS</B></A></FONT></TD>
1083 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1084   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
1085 &nbsp;<A HREF="ACL.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
1086 &nbsp;
1087 <SCRIPT>
1088   <!--
1089   if(window==top) {
1090     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
1091   }
1092   //-->
1093 </SCRIPT>
1094 <NOSCRIPT>
1095 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
1096 </NOSCRIPT>
1097 </FONT></TD>
1098 </TR>
1099 <TR>
1100 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1101   SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1102 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1103 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1104 </TR>
1105 </TABLE>
1106 <!-- =========== END OF NAVBAR =========== -->
1107
1108 <HR>
1109
1110 </BODY>
1111 </HTML>