Questioned "make sprm" and commented on "make srpm"
[openafs-wiki.git] / JavaAdminAPI / AFSShutdownHandler.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 AFSShutdownHandler (Java AFS API)
8 </TITLE>
9 <META NAME="keywords" CONTENT="org.openafs.jafs.AFSShutdownHandler,AFSShutdownHandler 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="AFSShutdownHandler (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/AFSShutdownHandler.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/AFSLibraryLoader.html"><B>PREV CLASS</B></A>&nbsp;
46 &nbsp;<A HREF="../../../org/openafs/jafs/Cell.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="AFSShutdownHandler.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="#fields_inherited_from_class_java.lang.Thread">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;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 AFSShutdownHandler</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/Thread.html">java.lang.Thread</A>
83         |
84         +--<B>org.openafs.jafs.AFSShutdownHandler</B>
85 </PRE>
86 <DL>
87 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Runnable.html">Runnable</A></DD>
88 </DL>
89 <HR>
90 <DL>
91 <DT> class <B>AFSShutdownHandler</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html">Thread</A></DL>
92
93 <P>
94 Class that handles graceful AFS application shutdown procedures by
95  instructing the native library to inform the file system server that
96  it is shutting down.
97 <P>
98
99 <P>
100 <DL>
101 <DT><B>Version:</B></DT>
102   <DD>1.0, 06/13/2001</DD>
103 </DL>
104 <HR>
105
106 <P>
107 <!-- ======== NESTED CLASS SUMMARY ======== -->
108
109
110 <!-- =========== FIELD SUMMARY =========== -->
111
112 <A NAME="field_summary"><!-- --></A>
113 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
114 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
115 <TD COLSPAN=2><FONT SIZE="+2">
116 <B>Field Summary</B></FONT></TD>
117 </TR>
118 </TABLE>
119 &nbsp;<A NAME="fields_inherited_from_class_java.lang.Thread"><!-- --></A>
120 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
121 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
122 <TD><B>Fields inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html">Thread</A></B></TD>
123 </TR>
124 <TR BGCOLOR="white" CLASS="TableRowColor">
125 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#MAX_PRIORITY">MAX_PRIORITY</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#MIN_PRIORITY">MIN_PRIORITY</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#NORM_PRIORITY">NORM_PRIORITY</A></CODE></TD>
126 </TR>
127 </TABLE>
128 &nbsp;
129 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
130
131 <A NAME="constructor_summary"><!-- --></A>
132 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
133 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134 <TD COLSPAN=2><FONT SIZE="+2">
135 <B>Constructor Summary</B></FONT></TD>
136 </TR>
137 <TR BGCOLOR="white" CLASS="TableRowColor">
138 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSShutdownHandler.html#AFSShutdownHandler()">AFSShutdownHandler</A></B>()</CODE>
139
140 <BR>
141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
142 </TR>
143 </TABLE>
144 &nbsp;
145 <!-- ========== METHOD SUMMARY =========== -->
146
147 <A NAME="method_summary"><!-- --></A>
148 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
149 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
150 <TD COLSPAN=2><FONT SIZE="+2">
151 <B>Method Summary</B></FONT></TD>
152 </TR>
153 <TR BGCOLOR="white" CLASS="TableRowColor">
154 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155 <CODE>&nbsp;void</CODE></FONT></TD>
156 <TD><CODE><B><A HREF="../../../org/openafs/jafs/AFSShutdownHandler.html#run()">run</A></B>()</CODE>
157
158 <BR>
159 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is the execution method satisfying the interface requirement as a 
160  stand alone runnable thread.
161
162  </TD>
163 </TR>
164 </TABLE>
165 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Thread"><!-- --></A>
166 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
167 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
168 <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html">Thread</A></B></TD>
169 </TR>
170 <TR BGCOLOR="white" CLASS="TableRowColor">
171 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#activeCount()">activeCount</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#checkAccess()">checkAccess</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#countStackFrames()">countStackFrames</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#currentThread()">currentThread</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#destroy()">destroy</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#dumpStack()">dumpStack</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#enumerate(java.lang.Thread[])">enumerate</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#getContextClassLoader()">getContextClassLoader</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#getName()">getName</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#getPriority()">getPriority</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#getThreadGroup()">getThreadGroup</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#holdsLock(java.lang.Object)">holdsLock</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#interrupt()">interrupt</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#interrupted()">interrupted</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#isAlive()">isAlive</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#isDaemon()">isDaemon</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#isInterrupted()">isInterrupted</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#join()">join</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#join(long)">join</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#join(long, int)">join</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#resume()">resume</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#setContextClassLoader(java.lang.ClassLoader)">setContextClassLoader</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#setDaemon(boolean)">setDaemon</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#setName(java.lang.String)">setName</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#setPriority(int)">setPriority</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#sleep(long)">sleep</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#sleep(long, int)">sleep</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#start()">start</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#stop()">stop</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#stop(java.lang.Throwable)">stop</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#suspend()">suspend</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#toString()">toString</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#yield()">yield</A></CODE></TD>
172 </TR>
173 </TABLE>
174 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
175 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
176 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
177 <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>
178 </TR>
179 <TR BGCOLOR="white" CLASS="TableRowColor">
180 <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>
181 </TR>
182 </TABLE>
183 &nbsp;
184 <P>
185
186 <!-- ============ FIELD DETAIL =========== -->
187
188
189 <!-- ========= CONSTRUCTOR DETAIL ======== -->
190
191 <A NAME="constructor_detail"><!-- --></A>
192 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
193 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
194 <TD COLSPAN=1><FONT SIZE="+2">
195 <B>Constructor Detail</B></FONT></TD>
196 </TR>
197 </TABLE>
198
199 <A NAME="AFSShutdownHandler()"><!-- --></A><H3>
200 AFSShutdownHandler</H3>
201 <PRE>
202 public <B>AFSShutdownHandler</B>()</PRE>
203 <DL>
204 </DL>
205
206 <!-- ============ METHOD DETAIL ========== -->
207
208 <A NAME="method_detail"><!-- --></A>
209 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
210 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
211 <TD COLSPAN=1><FONT SIZE="+2">
212 <B>Method Detail</B></FONT></TD>
213 </TR>
214 </TABLE>
215
216 <A NAME="run()"><!-- --></A><H3>
217 run</H3>
218 <PRE>
219 public void <B>run</B>()</PRE>
220 <DL>
221 <DD>This is the execution method satisfying the interface requirement as a 
222  stand alone runnable thread.
223
224  <p> This method will automatically be invoked by the Thread instantiator.
225 <P>
226 <DD><DL>
227 <DT><B>Specified by:</B><DD><CODE>run</CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Runnable.html">Runnable</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html#run()">run</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Thread.html">Thread</A></CODE></DL>
228 </DD>
229 <DD><DL>
230 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/Token.html#shutdown()"><CODE>Token.shutdown()</CODE></A></DL>
231 </DD>
232 </DL>
233 <!-- ========= END OF CLASS DATA ========= -->
234 <HR>
235
236 <!-- ========== START OF NAVBAR ========== -->
237 <A NAME="navbar_bottom"><!-- --></A>
238 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
239 <TR>
240 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
241 <A NAME="navbar_bottom_firstrow"><!-- --></A>
242 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
243   <TR ALIGN="center" VALIGN="top">
244   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
245   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
246   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/AFSShutdownHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
247   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
248   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
249   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
250   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
251   </TR>
252 </TABLE>
253 </TD>
254 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
255 <B>JAFS API v2</B></EM>
256 </TD>
257 </TR>
258
259 <TR>
260 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
261 &nbsp;<A HREF="../../../org/openafs/jafs/AFSLibraryLoader.html"><B>PREV CLASS</B></A>&nbsp;
262 &nbsp;<A HREF="../../../org/openafs/jafs/Cell.html"><B>NEXT CLASS</B></A></FONT></TD>
263 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
264   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
265 &nbsp;<A HREF="AFSShutdownHandler.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
266 &nbsp;
267 <SCRIPT>
268   <!--
269   if(window==top) {
270     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
271   }
272   //-->
273 </SCRIPT>
274 <NOSCRIPT>
275 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
276 </NOSCRIPT>
277 </FONT></TD>
278 </TR>
279 <TR>
280 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
281   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_java.lang.Thread">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
282 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
283 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
284 </TR>
285 </TABLE>
286 <!-- =========== END OF NAVBAR =========== -->
287
288 <HR>
289
290 </BODY>
291 </HTML>