Remove broken link
[openafs-wiki.git] / archive / JavaAdminAPI / AFSSecurityException.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:40 PDT 2003 -->
6 <TITLE>
7 AFSSecurityException (Java AFS API)
8 </TITLE>
9 <META NAME="keywords" CONTENT="org.openafs.jafs.AFSSecurityException,AFSSecurityException 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="AFSSecurityException (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/AFSSecurityException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
31   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
32   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
33   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
34   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
35   </TR>
36 </TABLE>
37 </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
40 </TD>
41 </TR>
42
43 <TR>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 &nbsp;<A HREF="../../../org/openafs/jafs/AFSFileException.html"><B>PREV CLASS</B></A>&nbsp;
46 &nbsp;NEXT CLASS</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="AFSSecurityException.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
50 &nbsp;
51 <SCRIPT>
52   <!--
53   if(window==top) {
54     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
55   }
56   //-->
57 </SCRIPT>
58 <NOSCRIPT>
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
60 </NOSCRIPT>
61 </FONT></TD>
62 </TR>
63 <TR>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
68 </TR>
69 </TABLE>
70 <!-- =========== END OF NAVBAR =========== -->
71
72 <HR>
73 <!-- ======== START OF CLASS DATA ======== -->
74 <H2>
75 <FONT SIZE="-1">
76 org.openafs.jafs</FONT>
77 <BR>
78 Class AFSSecurityException</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   +--<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html">java.lang.Throwable</A>
83         |
84         +--<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Exception.html">java.lang.Exception</A>
85               |
86               +--<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/RuntimeException.html">java.lang.RuntimeException</A>
87                     |
88                     +--<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/SecurityException.html">java.lang.SecurityException</A>
89                           |
90                           +--<B>org.openafs.jafs.AFSSecurityException</B>
91 </PRE>
92 <DL>
93 <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>
94 </DL>
95 <HR>
96 <DL>
97 <DT>public class <B>AFSSecurityException</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/SecurityException.html">SecurityException</A></DL>
98
99 <P>
100 An exception indicating that a security related error has occured in the
101  Java AFS API, in the Java AFS JNI, or in the AFS file system.
102 <P>
103
104 <P>
105 <DL>
106 <DT><B>Version:</B></DT>
107   <DD>1.0, 04/16/2001</DD>
108 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSException.html"><CODE>AFSException</CODE></A>, 
109 <A HREF="../../../serialized-form.html" TARGET="org.openafs.jafs.AFSSecurityException">Serialized Form</A></DL>
110 <HR>
111
112 <P>
113 <!-- ======== NESTED CLASS SUMMARY ======== -->
114
115
116 <!-- =========== FIELD SUMMARY =========== -->
117
118 <A NAME="field_summary"><!-- --></A>
119 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
120 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121 <TD COLSPAN=2><FONT SIZE="+2">
122 <B>Field Summary</B></FONT></TD>
123 </TR>
124 <TR BGCOLOR="white" CLASS="TableRowColor">
125 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
126 <CODE>protected &nbsp;int</CODE></FONT></TD>
127 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#errno">errno</A></B></CODE>
128
129 <BR>
130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The AFS specific error number (code).</TD>
131 </TR>
132 </TABLE>
133 &nbsp;<A NAME="fields_inherited_from_class_java.lang.RuntimeException"><!-- --></A>
134 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
135 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
136 <TD><B>Fields inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/RuntimeException.html">RuntimeException</A></B></TD>
137 </TR>
138 <TR BGCOLOR="white" CLASS="TableRowColor">
139 <TD><CODE></CODE></TD>
140 </TR>
141 </TABLE>
142 &nbsp;
143 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
144
145 <A NAME="constructor_summary"><!-- --></A>
146 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
147 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
148 <TD COLSPAN=2><FONT SIZE="+2">
149 <B>Constructor Summary</B></FONT></TD>
150 </TR>
151 <TR BGCOLOR="white" CLASS="TableRowColor">
152 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#AFSSecurityException(int)">AFSSecurityException</A></B>(int&nbsp;errno)</CODE>
153
154 <BR>
155 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an <code>AFSSecurityException</code> with the specified error
156  code. </TD>
157 </TR>
158 <TR BGCOLOR="white" CLASS="TableRowColor">
159 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#AFSSecurityException(java.lang.String)">AFSSecurityException</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;reason)</CODE>
160
161 <BR>
162 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an <code>AFSSecurityException</code> with the specified detail
163  message.</TD>
164 </TR>
165 <TR BGCOLOR="white" CLASS="TableRowColor">
166 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#AFSSecurityException(java.lang.String, int)">AFSSecurityException</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;reason,
167                      int&nbsp;errno)</CODE>
168
169 <BR>
170 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an <code>AFSFileException</code> with the specified detail
171  message and specified error code.  </TD>
172 </TR>
173 </TABLE>
174 &nbsp;
175 <!-- ========== METHOD SUMMARY =========== -->
176
177 <A NAME="method_summary"><!-- --></A>
178 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
179 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
180 <TD COLSPAN=2><FONT SIZE="+2">
181 <B>Method Summary</B></FONT></TD>
182 </TR>
183 <TR BGCOLOR="white" CLASS="TableRowColor">
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
186 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getAFSMessage()">getAFSMessage</A></B>()</CODE>
187
188 <BR>
189 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the AFS error message string defined by the <code>ErrorTable
190  </code> class.  </TD>
191 </TR>
192 <TR BGCOLOR="white" CLASS="TableRowColor">
193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
195 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getAFSMessage(java.util.Locale)">getAFSMessage</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html">Locale</A>&nbsp;locale)</CODE>
196
197 <BR>
198 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the AFS error message defined by the <code>ErrorTable</code>
199  class.  </TD>
200 </TR>
201 <TR BGCOLOR="white" CLASS="TableRowColor">
202 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203 <CODE>&nbsp;int</CODE></FONT></TD>
204 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getErrorCode()">getErrorCode</A></B>()</CODE>
205
206 <BR>
207 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the AFS specific error number (code).  </TD>
208 </TR>
209 <TR BGCOLOR="white" CLASS="TableRowColor">
210 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
212 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getMessage()">getMessage</A></B>()</CODE>
213
214 <BR>
215 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the error message string of this exception.</TD>
216 </TR>
217 <TR BGCOLOR="white" CLASS="TableRowColor">
218 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
220 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getMessage(java.util.Locale)">getMessage</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html">Locale</A>&nbsp;locale)</CODE>
221
222 <BR>
223 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the locale specific error message string of this exception.</TD>
224 </TR>
225 <TR BGCOLOR="white" CLASS="TableRowColor">
226 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
228 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#toString()">toString</A></B>()</CODE>
229
230 <BR>
231 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string representation of this AFS Exception.</TD>
232 </TR>
233 </TABLE>
234 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
235 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
236 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
237 <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html">Throwable</A></B></TD>
238 </TR>
239 <TR BGCOLOR="white" CLASS="TableRowColor">
240 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#fillInStackTrace()">fillInStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#getCause()">getCause</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#getLocalizedMessage()">getLocalizedMessage</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#getStackTrace()">getStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#initCause(java.lang.Throwable)">initCause</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#printStackTrace()">printStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#printStackTrace(java.io.PrintStream)">printStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#printStackTrace(java.io.PrintWriter)">printStackTrace</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#setStackTrace(java.lang.StackTraceElement[])">setStackTrace</A></CODE></TD>
241 </TR>
242 </TABLE>
243 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
244 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
245 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
246 <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>
247 </TR>
248 <TR BGCOLOR="white" CLASS="TableRowColor">
249 <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>
250 </TR>
251 </TABLE>
252 &nbsp;
253 <P>
254
255 <!-- ============ FIELD DETAIL =========== -->
256
257 <A NAME="field_detail"><!-- --></A>
258 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
259 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
260 <TD COLSPAN=1><FONT SIZE="+2">
261 <B>Field Detail</B></FONT></TD>
262 </TR>
263 </TABLE>
264
265 <A NAME="errno"><!-- --></A><H3>
266 errno</H3>
267 <PRE>
268 protected int <B>errno</B></PRE>
269 <DL>
270 <DD>The AFS specific error number (code).
271 <P>
272 <DL>
273 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getErrorCode()"><CODE>getErrorCode()</CODE></A></DL>
274 </DL>
275
276 <!-- ========= CONSTRUCTOR DETAIL ======== -->
277
278 <A NAME="constructor_detail"><!-- --></A>
279 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
280 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
281 <TD COLSPAN=1><FONT SIZE="+2">
282 <B>Constructor Detail</B></FONT></TD>
283 </TR>
284 </TABLE>
285
286 <A NAME="AFSSecurityException(java.lang.String)"><!-- --></A><H3>
287 AFSSecurityException</H3>
288 <PRE>
289 public <B>AFSSecurityException</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;reason)</PRE>
290 <DL>
291 <DD>Constructs an <code>AFSSecurityException</code> with the specified detail
292  message.
293 <P>
294 <DT><B>Parameters:</B><DD><CODE>reason</CODE> - the detail message.</DL>
295 <HR>
296
297 <A NAME="AFSSecurityException(int)"><!-- --></A><H3>
298 AFSSecurityException</H3>
299 <PRE>
300 public <B>AFSSecurityException</B>(int&nbsp;errno)</PRE>
301 <DL>
302 <DD>Constructs an <code>AFSSecurityException</code> with the specified error
303  code. This constructor will also generate the appropriate error message
304  respective to the specified error code.
305 <P>
306 <DT><B>Parameters:</B><DD><CODE>errno</CODE> - the AFS error number (error code).</DL>
307 <HR>
308
309 <A NAME="AFSSecurityException(java.lang.String, int)"><!-- --></A><H3>
310 AFSSecurityException</H3>
311 <PRE>
312 public <B>AFSSecurityException</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;reason,
313                             int&nbsp;errno)</PRE>
314 <DL>
315 <DD>Constructs an <code>AFSFileException</code> with the specified detail
316  message and specified error code.  In this constructor the specified
317  detail message overrides the default AFS error message defined by the
318  <code>ErrorTable</code> class.  Therefore, to retrieve the AFS specific 
319  error message, you must use the <code><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A>
320  </code> method. The <code><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getMessage()"><CODE>getMessage()</CODE></A></code> method will return
321  the message specified in this constructor.
322 <P>
323 <DT><B>Parameters:</B><DD><CODE>reason</CODE> - the detail message.<DD><CODE>errno</CODE> - the AFS error number (error code).<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A></DL>
324
325 <!-- ============ METHOD DETAIL ========== -->
326
327 <A NAME="method_detail"><!-- --></A>
328 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
329 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
330 <TD COLSPAN=1><FONT SIZE="+2">
331 <B>Method Detail</B></FONT></TD>
332 </TR>
333 </TABLE>
334
335 <A NAME="getErrorCode()"><!-- --></A><H3>
336 getErrorCode</H3>
337 <PRE>
338 public int <B>getErrorCode</B>()</PRE>
339 <DL>
340 <DD>Returns the AFS specific error number (code).  This code can be interpreted 
341  by use of the <code><A HREF="../../../org/openafs/jafs/ErrorTable.html"><CODE>ErrorTable</CODE></A></code> class method 
342  <code><A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A></code>.
343 <P>
344 <DD><DL>
345
346 <DT><B>Returns:</B><DD>the AFS error code of this <code>AFSException</code> 
347           object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A></DL>
348 </DD>
349 </DL>
350 <HR>
351
352 <A NAME="getMessage()"><!-- --></A><H3>
353 getMessage</H3>
354 <PRE>
355 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getMessage</B>()</PRE>
356 <DL>
357 <DD>Returns the error message string of this exception.
358 <P>
359 <DD><DL>
360 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#getMessage()">getMessage</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html">Throwable</A></CODE></DL>
361 </DD>
362 <DD><DL>
363
364 <DT><B>Returns:</B><DD>the error message string of this exception object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A></DL>
365 </DD>
366 </DL>
367 <HR>
368
369 <A NAME="getMessage(java.util.Locale)"><!-- --></A><H3>
370 getMessage</H3>
371 <PRE>
372 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getMessage</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html">Locale</A>&nbsp;locale)</PRE>
373 <DL>
374 <DD>Returns the locale specific error message string of this exception.
375 <P>
376 <DD><DL>
377 <DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale for which this message will be displayed
378 <DT><B>Returns:</B><DD>the error message string of this exception object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A></DL>
379 </DD>
380 </DL>
381 <HR>
382
383 <A NAME="getAFSMessage()"><!-- --></A><H3>
384 getAFSMessage</H3>
385 <PRE>
386 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getAFSMessage</B>()</PRE>
387 <DL>
388 <DD>Returns the AFS error message string defined by the <code>ErrorTable
389  </code> class.  The message will be formatted according to the default
390  Locale.
391
392  <P> This message is also available from this object's super class
393  method <code>getMessage</code>. However, this method will always return
394  the string message associated with the actual AFS error code/number
395  specified, whereas the <A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getMessage()"><CODE>getMessage()</CODE></A> method will return the
396  string message intended for this Exception object, which may be
397  an overridden message defined in the constructor of this Exception.
398 <P>
399 <DD><DL>
400
401 <DT><B>Returns:</B><DD>the AFS error message string of this exception object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getAFSMessage(java.util.Locale)"><CODE>getAFSMessage(Locale)</CODE></A>, 
402 <A HREF="../../../org/openafs/jafs/AFSSecurityException.html#AFSSecurityException(java.lang.String, int)"><CODE>AFSSecurityException(String, int)</CODE></A>, 
403 <A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int)"><CODE>ErrorTable.getMessage(int)</CODE></A>, 
404 <CODE>Throwable.getMessage()</CODE></DL>
405 </DD>
406 </DL>
407 <HR>
408
409 <A NAME="getAFSMessage(java.util.Locale)"><!-- --></A><H3>
410 getAFSMessage</H3>
411 <PRE>
412 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>getAFSMessage</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html">Locale</A>&nbsp;locale)</PRE>
413 <DL>
414 <DD>Returns the AFS error message defined by the <code>ErrorTable</code>
415  class.  The message will be formatted according to the specified Locale.
416
417  <P> This message is also available from this object's super class
418  method <code>getMessage</code>. However, this method will always return
419  the string message associated with the actual AFS error code/number
420  specified, whereas the <A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getMessage()"><CODE>getMessage()</CODE></A> method will return the
421  string message intended for this Exception object, which may be
422  an overridden message defined in the constructor of this Exception.
423 <P>
424 <DD><DL>
425 <DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale for which this message will be displayed
426 <DT><B>Returns:</B><DD>the AFS error message string of this exception object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getAFSMessage()"><CODE>getAFSMessage()</CODE></A>, 
427 <A HREF="../../../org/openafs/jafs/AFSSecurityException.html#AFSSecurityException(java.lang.String, int)"><CODE>AFSSecurityException(String, int)</CODE></A>, 
428 <A HREF="../../../org/openafs/jafs/ErrorTable.html#getMessage(int, java.util.Locale)"><CODE>ErrorTable.getMessage(int, Locale)</CODE></A>, 
429 <CODE>Throwable.getMessage()</CODE></DL>
430 </DD>
431 </DL>
432 <HR>
433
434 <A NAME="toString()"><!-- --></A><H3>
435 toString</H3>
436 <PRE>
437 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>
438 <DL>
439 <DD>Returns a string representation of this AFS Exception.
440 <P>
441 <DD><DL>
442 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html#toString()">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html">Throwable</A></CODE></DL>
443 </DD>
444 <DD><DL>
445
446 <DT><B>Returns:</B><DD>the AFS error message string of this 
447           <code>AFSSecurityException</code> object.<DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/AFSSecurityException.html#getMessage()"><CODE>getMessage()</CODE></A></DL>
448 </DD>
449 </DL>
450 <!-- ========= END OF CLASS DATA ========= -->
451 <HR>
452
453 <!-- ========== START OF NAVBAR ========== -->
454 <A NAME="navbar_bottom"><!-- --></A>
455 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
456 <TR>
457 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
458 <A NAME="navbar_bottom_firstrow"><!-- --></A>
459 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
460   <TR ALIGN="center" VALIGN="top">
461   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
462   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
463   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/AFSSecurityException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
464   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
465   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
466   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
467   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
468   </TR>
469 </TABLE>
470 </TD>
471 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
472 <B>JAFS API v2</B></EM>
473 </TD>
474 </TR>
475
476 <TR>
477 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
478 &nbsp;<A HREF="../../../org/openafs/jafs/AFSFileException.html"><B>PREV CLASS</B></A>&nbsp;
479 &nbsp;NEXT CLASS</FONT></TD>
480 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
481   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
482 &nbsp;<A HREF="AFSSecurityException.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
483 &nbsp;
484 <SCRIPT>
485   <!--
486   if(window==top) {
487     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
488   }
489   //-->
490 </SCRIPT>
491 <NOSCRIPT>
492 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
493 </NOSCRIPT>
494 </FONT></TD>
495 </TR>
496 <TR>
497 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
498   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
499 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
500 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
501 </TR>
502 </TABLE>
503 <!-- =========== END OF NAVBAR =========== -->
504
505 <HR>
506
507 </BODY>
508 </HTML>