updated javadoc
[jabaws.git] / website / full_javadoc / compbio / ws / server / ShutdownEngines.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:34 BST 2011 -->\r
6 <TITLE>\r
7 ShutdownEngines\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2011-08-12">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     if (location.href.indexOf('is-external=true') == -1) {\r
18         parent.document.title="ShutdownEngines";\r
19     }\r
20 }\r
21 </SCRIPT>\r
22 <NOSCRIPT>\r
23 </NOSCRIPT>\r
24 \r
25 </HEAD>\r
26 \r
27 <BODY BGCOLOR="white" onload="windowTitle();">\r
28 <HR>\r
29 \r
30 \r
31 <!-- ========= START OF TOP NAVBAR ======= -->\r
32 <A NAME="navbar_top"><!-- --></A>\r
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
35 <TR>\r
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
37 <A NAME="navbar_top_firstrow"><!-- --></A>\r
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
39   <TR ALIGN="center" VALIGN="top">\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ShutdownEngines.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
48   </TR>\r
49 </TABLE>\r
50 </TD>\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
52 </EM>\r
53 </TD>\r
54 </TR>\r
55 \r
56 <TR>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58 &nbsp;<A HREF="../../../compbio/ws/server/SequenceAnnotationService.html" title="class in compbio.ws.server"><B>PREV CLASS</B></A>&nbsp;\r
59 &nbsp;<A HREF="../../../compbio/ws/server/SimpleWSPublisher.html" title="class in compbio.ws.server"><B>NEXT CLASS</B></A></FONT></TD>\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
61   <A HREF="../../../index.html?compbio/ws/server/ShutdownEngines.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="ShutdownEngines.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
63 &nbsp;<SCRIPT type="text/javascript">\r
64   <!--\r
65   if(window==top) {\r
66     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
67   }\r
68   //-->\r
69 </SCRIPT>\r
70 <NOSCRIPT>\r
71   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
72 </NOSCRIPT>\r
73 \r
74 \r
75 </FONT></TD>\r
76 </TR>\r
77 <TR>\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
82 </TR>\r
83 </TABLE>\r
84 <A NAME="skip-navbar_top"></A>\r
85 <!-- ========= END OF TOP NAVBAR ========= -->\r
86 \r
87 <HR>\r
88 <!-- ======== START OF CLASS DATA ======== -->\r
89 <H2>\r
90 <FONT SIZE="-1">\r
91 compbio.ws.server</FONT>\r
92 <BR>\r
93 Class ShutdownEngines</H2>\r
94 <PRE>\r
95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>\r
96   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.ws.server.ShutdownEngines</B>\r
97 </PRE>\r
98 <DL>\r
99 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/util/EventListener.html?is-external=true" title="class or interface in java.util">EventListener</A>, javax.servlet.ServletContextListener</DD>\r
100 </DL>\r
101 <HR>\r
102 <DL>\r
103 <DT><PRE>public class <B>ShutdownEngines</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements javax.servlet.ServletContextListener</DL>\r
104 </PRE>\r
105 \r
106 <P>\r
107 Switch off engines if JABAWS web application is undeployed, or web server is
108  shutdown\r
109 <P>\r
110 \r
111 <P>\r
112 <DL>\r
113 <DT><B>Version:</B></DT>\r
114   <DD>1.0</DD>\r
115 <DT><B>Author:</B></DT>\r
116   <DD>Peter Troshin</DD>\r
117 </DL>\r
118 <HR>\r
119 \r
120 <P>\r
121 \r
122 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
123 \r
124 <A NAME="constructor_summary"><!-- --></A>\r
125 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
126 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
127 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
128 <B>Constructor Summary</B></FONT></TH>\r
129 </TR>\r
130 <TR BGCOLOR="white" CLASS="TableRowColor">\r
131 <TD><CODE><B><A HREF="../../../compbio/ws/server/ShutdownEngines.html#ShutdownEngines()">ShutdownEngines</A></B>()</CODE>\r
132 \r
133 <BR>\r
134 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
135 </TR>\r
136 </TABLE>\r
137 &nbsp;\r
138 <!-- ========== METHOD SUMMARY =========== -->\r
139 \r
140 <A NAME="method_summary"><!-- --></A>\r
141 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
142 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
143 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
144 <B>Method Summary</B></FONT></TH>\r
145 </TR>\r
146 <TR BGCOLOR="white" CLASS="TableRowColor">\r
147 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
148 <CODE>&nbsp;void</CODE></FONT></TD>\r
149 <TD><CODE><B><A HREF="../../../compbio/ws/server/ShutdownEngines.html#contextDestroyed(javax.servlet.ServletContextEvent)">contextDestroyed</A></B>(javax.servlet.ServletContextEvent&nbsp;ignored)</CODE>\r
150 \r
151 <BR>\r
152 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
153 </TR>\r
154 <TR BGCOLOR="white" CLASS="TableRowColor">\r
155 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
156 <CODE>&nbsp;void</CODE></FONT></TD>\r
157 <TD><CODE><B><A HREF="../../../compbio/ws/server/ShutdownEngines.html#contextInitialized(javax.servlet.ServletContextEvent)">contextInitialized</A></B>(javax.servlet.ServletContextEvent&nbsp;arg0)</CODE>\r
158 \r
159 <BR>\r
160 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
161 </TR>\r
162 </TABLE>\r
163 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
164 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
165 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
166 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>\r
167 </TR>\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
169 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
170 </TR>\r
171 </TABLE>\r
172 &nbsp;\r
173 <P>\r
174 \r
175 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
176 \r
177 <A NAME="constructor_detail"><!-- --></A>\r
178 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
179 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
180 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
181 <B>Constructor Detail</B></FONT></TH>\r
182 </TR>\r
183 </TABLE>\r
184 \r
185 <A NAME="ShutdownEngines()"><!-- --></A><H3>\r
186 ShutdownEngines</H3>\r
187 <PRE>\r
188 public <B>ShutdownEngines</B>()</PRE>\r
189 <DL>\r
190 </DL>\r
191 \r
192 <!-- ============ METHOD DETAIL ========== -->\r
193 \r
194 <A NAME="method_detail"><!-- --></A>\r
195 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
196 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
197 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
198 <B>Method Detail</B></FONT></TH>\r
199 </TR>\r
200 </TABLE>\r
201 \r
202 <A NAME="contextDestroyed(javax.servlet.ServletContextEvent)"><!-- --></A><H3>\r
203 contextDestroyed</H3>\r
204 <PRE>\r
205 public void <B>contextDestroyed</B>(javax.servlet.ServletContextEvent&nbsp;ignored)</PRE>\r
206 <DL>\r
207 <DD><DL>\r
208 <DT><B>Specified by:</B><DD><CODE>contextDestroyed</CODE> in interface <CODE>javax.servlet.ServletContextListener</CODE></DL>\r
209 </DD>\r
210 <DD><DL>\r
211 </DL>\r
212 </DD>\r
213 </DL>\r
214 <HR>\r
215 \r
216 <A NAME="contextInitialized(javax.servlet.ServletContextEvent)"><!-- --></A><H3>\r
217 contextInitialized</H3>\r
218 <PRE>\r
219 public void <B>contextInitialized</B>(javax.servlet.ServletContextEvent&nbsp;arg0)</PRE>\r
220 <DL>\r
221 <DD><DL>\r
222 <DT><B>Specified by:</B><DD><CODE>contextInitialized</CODE> in interface <CODE>javax.servlet.ServletContextListener</CODE></DL>\r
223 </DD>\r
224 <DD><DL>\r
225 </DL>\r
226 </DD>\r
227 </DL>\r
228 <!-- ========= END OF CLASS DATA ========= -->\r
229 <HR>\r
230 \r
231 \r
232 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
233 <A NAME="navbar_bottom"><!-- --></A>\r
234 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
235 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
236 <TR>\r
237 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
238 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
239 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
240   <TR ALIGN="center" VALIGN="top">\r
241   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
242   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
243   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
244   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ShutdownEngines.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
245   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
246   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
247   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
248   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
249   </TR>\r
250 </TABLE>\r
251 </TD>\r
252 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
253 </EM>\r
254 </TD>\r
255 </TR>\r
256 \r
257 <TR>\r
258 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
259 &nbsp;<A HREF="../../../compbio/ws/server/SequenceAnnotationService.html" title="class in compbio.ws.server"><B>PREV CLASS</B></A>&nbsp;\r
260 &nbsp;<A HREF="../../../compbio/ws/server/SimpleWSPublisher.html" title="class in compbio.ws.server"><B>NEXT CLASS</B></A></FONT></TD>\r
261 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
262   <A HREF="../../../index.html?compbio/ws/server/ShutdownEngines.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
263 &nbsp;<A HREF="ShutdownEngines.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
264 &nbsp;<SCRIPT type="text/javascript">\r
265   <!--\r
266   if(window==top) {\r
267     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
268   }\r
269   //-->\r
270 </SCRIPT>\r
271 <NOSCRIPT>\r
272   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
273 </NOSCRIPT>\r
274 \r
275 \r
276 </FONT></TD>\r
277 </TR>\r
278 <TR>\r
279 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
280   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
281 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
282 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
283 </TR>\r
284 </TABLE>\r
285 <A NAME="skip-navbar_bottom"></A>\r
286 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
287 \r
288 <HR>\r
289 \r
290 </BODY>\r
291 </HTML>\r