JWS-109 & JWS-116 Regenerated the JABAWS JavaDoc (with eclipse java 8) and moved...
[jabaws.git] / website / docs / full_javadoc / compbio / ws / server / MainManager.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc (1.8.0_121) on Fri Apr 21 15:32:50 BST 2017 -->
6 <title>MainManager</title>
7 <meta name="date" content="2017-04-21">
8 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9 <script type="text/javascript" src="../../../script.js"></script>
10 </head>
11 <body>
12 <script type="text/javascript"><!--
13     try {
14         if (location.href.indexOf('is-external=true') == -1) {
15             parent.document.title="MainManager";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 var methods = {"i0":10,"i1":10,"i2":9,"i3":9};
22 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23 var altColor = "altColor";
24 var rowColor = "rowColor";
25 var tableTab = "tableTab";
26 var activeTableTab = "activeTableTab";
27 </script>
28 <noscript>
29 <div>JavaScript is disabled on your browser.</div>
30 </noscript>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
33 <!--   -->
34 </a>
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
37 <!--   -->
38 </a>
39 <ul class="navList" title="Navigation">
40 <li><a href="../../../overview-summary.html">Overview</a></li>
41 <li><a href="package-summary.html">Package</a></li>
42 <li class="navBarCell1Rev">Class</li>
43 <li><a href="class-use/MainManager.html">Use</a></li>
44 <li><a href="package-tree.html">Tree</a></li>
45 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
46 <li><a href="../../../index-files/index-1.html">Index</a></li>
47 <li><a href="../../../help-doc.html">Help</a></li>
48 </ul>
49 </div>
50 <div class="subNav">
51 <ul class="navList">
52 <li><a href="../../../compbio/ws/server/MafftWS.html" title="class in compbio.ws.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53 <li><a href="../../../compbio/ws/server/MSAprobsWS.html" title="class in compbio.ws.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54 </ul>
55 <ul class="navList">
56 <li><a href="../../../index.html?compbio/ws/server/MainManager.html" target="_top">Frames</a></li>
57 <li><a href="MainManager.html" target="_top">No&nbsp;Frames</a></li>
58 </ul>
59 <ul class="navList" id="allclasses_navbar_top">
60 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61 </ul>
62 <div>
63 <script type="text/javascript"><!--
64   allClassesLink = document.getElementById("allclasses_navbar_top");
65   if(window==top) {
66     allClassesLink.style.display = "block";
67   }
68   else {
69     allClassesLink.style.display = "none";
70   }
71   //-->
72 </script>
73 </div>
74 <div>
75 <ul class="subNavList">
76 <li>Summary:&nbsp;</li>
77 <li>Nested&nbsp;|&nbsp;</li>
78 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
79 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80 <li><a href="#method.summary">Method</a></li>
81 </ul>
82 <ul class="subNavList">
83 <li>Detail:&nbsp;</li>
84 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
85 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86 <li><a href="#method.detail">Method</a></li>
87 </ul>
88 </div>
89 <a name="skip.navbar.top">
90 <!--   -->
91 </a></div>
92 <!-- ========= END OF TOP NAVBAR ========= -->
93 <!-- ======== START OF CLASS DATA ======== -->
94 <div class="header">
95 <div class="subTitle">compbio.ws.server</div>
96 <h2 title="Class MainManager" class="title">Class MainManager</h2>
97 </div>
98 <div class="contentContainer">
99 <ul class="inheritance">
100 <li>java.lang.Object</li>
101 <li>
102 <ul class="inheritance">
103 <li>compbio.ws.server.MainManager</li>
104 </ul>
105 </li>
106 </ul>
107 <div class="description">
108 <ul class="blockList">
109 <li class="blockList">
110 <dl>
111 <dt>All Implemented Interfaces:</dt>
112 <dd>java.util.EventListener, javax.servlet.ServletContextListener</dd>
113 </dl>
114 <hr>
115 <br>
116 <pre>public class <span class="typeNameLabel">MainManager</span>
117 extends java.lang.Object
118 implements javax.servlet.ServletContextListener</pre>
119 <div class="block">Two tasks:
120  1. Switch off engines if JABAWS web application is un-deployed, or web server is shutdown
121  2. delete old job directories</div>
122 <dl>
123 <dt><span class="simpleTagLabel">Version:</span></dt>
124 <dd>2.0</dd>
125 <dt><span class="simpleTagLabel">Author:</span></dt>
126 <dd>Peter Troshin, Alexander Sherstnev</dd>
127 </dl>
128 </li>
129 </ul>
130 </div>
131 <div class="summary">
132 <ul class="blockList">
133 <li class="blockList">
134 <!-- =========== FIELD SUMMARY =========== -->
135 <ul class="blockList">
136 <li class="blockList"><a name="field.summary">
137 <!--   -->
138 </a>
139 <h3>Field Summary</h3>
140 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
141 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
142 <tr>
143 <th class="colFirst" scope="col">Modifier and Type</th>
144 <th class="colLast" scope="col">Field and Description</th>
145 </tr>
146 <tr class="altColor">
147 <td class="colFirst"><code>private java.util.concurrent.ScheduledFuture&lt;?&gt;</code></td>
148 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/MainManager.html#clustercl">clustercl</a></span></code>&nbsp;</td>
149 </tr>
150 <tr class="rowColor">
151 <td class="colFirst"><code>private java.util.concurrent.ScheduledExecutorService</code></td>
152 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/MainManager.html#executor">executor</a></span></code>&nbsp;</td>
153 </tr>
154 <tr class="altColor">
155 <td class="colFirst"><code>private java.util.concurrent.ScheduledFuture&lt;?&gt;</code></td>
156 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/MainManager.html#localcl">localcl</a></span></code>&nbsp;</td>
157 </tr>
158 <tr class="rowColor">
159 <td class="colFirst"><code>private org.apache.log4j.Logger</code></td>
160 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/MainManager.html#log">log</a></span></code>&nbsp;</td>
161 </tr>
162 <tr class="altColor">
163 <td class="colFirst"><code>(package private) static compbio.util.PropertyHelper</code></td>
164 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/MainManager.html#ph">ph</a></span></code>&nbsp;</td>
165 </tr>
166 </table>
167 </li>
168 </ul>
169 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
170 <ul class="blockList">
171 <li class="blockList"><a name="constructor.summary">
172 <!--   -->
173 </a>
174 <h3>Constructor Summary</h3>
175 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
176 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
177 <tr>
178 <th class="colOne" scope="col">Constructor and Description</th>
179 </tr>
180 <tr class="altColor">
181 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/MainManager.html#MainManager--">MainManager</a></span>()</code>&nbsp;</td>
182 </tr>
183 </table>
184 </li>
185 </ul>
186 <!-- ========== METHOD SUMMARY =========== -->
187 <ul class="blockList">
188 <li class="blockList"><a name="method.summary">
189 <!--   -->
190 </a>
191 <h3>Method Summary</h3>
192 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
193 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
194 <tr>
195 <th class="colFirst" scope="col">Modifier and Type</th>
196 <th class="colLast" scope="col">Method and Description</th>
197 </tr>
198 <tr id="i0" class="altColor">
199 <td class="colFirst"><code>void</code></td>
200 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/MainManager.html#contextDestroyed-javax.servlet.ServletContextEvent-">contextDestroyed</a></span>(javax.servlet.ServletContextEvent&nbsp;ignored)</code>&nbsp;</td>
201 </tr>
202 <tr id="i1" class="rowColor">
203 <td class="colFirst"><code>void</code></td>
204 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/MainManager.html#contextInitialized-javax.servlet.ServletContextEvent-">contextInitialized</a></span>(javax.servlet.ServletContextEvent&nbsp;arg0)</code>&nbsp;</td>
205 </tr>
206 <tr id="i2" class="altColor">
207 <td class="colFirst"><code>(package private) static java.lang.String</code></td>
208 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/MainManager.html#getClusterJobDir--">getClusterJobDir</a></span>()</code>&nbsp;</td>
209 </tr>
210 <tr id="i3" class="rowColor">
211 <td class="colFirst"><code>(package private) static java.lang.String</code></td>
212 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/MainManager.html#getLocalJobDir--">getLocalJobDir</a></span>()</code>&nbsp;</td>
213 </tr>
214 </table>
215 <ul class="blockList">
216 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
217 <!--   -->
218 </a>
219 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
220 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
221 </ul>
222 </li>
223 </ul>
224 </li>
225 </ul>
226 </div>
227 <div class="details">
228 <ul class="blockList">
229 <li class="blockList">
230 <!-- ============ FIELD DETAIL =========== -->
231 <ul class="blockList">
232 <li class="blockList"><a name="field.detail">
233 <!--   -->
234 </a>
235 <h3>Field Detail</h3>
236 <a name="log">
237 <!--   -->
238 </a>
239 <ul class="blockList">
240 <li class="blockList">
241 <h4>log</h4>
242 <pre>private final&nbsp;org.apache.log4j.Logger log</pre>
243 </li>
244 </ul>
245 <a name="ph">
246 <!--   -->
247 </a>
248 <ul class="blockList">
249 <li class="blockList">
250 <h4>ph</h4>
251 <pre>static&nbsp;compbio.util.PropertyHelper ph</pre>
252 </li>
253 </ul>
254 <a name="localcl">
255 <!--   -->
256 </a>
257 <ul class="blockList">
258 <li class="blockList">
259 <h4>localcl</h4>
260 <pre>private&nbsp;java.util.concurrent.ScheduledFuture&lt;?&gt; localcl</pre>
261 </li>
262 </ul>
263 <a name="clustercl">
264 <!--   -->
265 </a>
266 <ul class="blockList">
267 <li class="blockList">
268 <h4>clustercl</h4>
269 <pre>private&nbsp;java.util.concurrent.ScheduledFuture&lt;?&gt; clustercl</pre>
270 </li>
271 </ul>
272 <a name="executor">
273 <!--   -->
274 </a>
275 <ul class="blockListLast">
276 <li class="blockList">
277 <h4>executor</h4>
278 <pre>private&nbsp;java.util.concurrent.ScheduledExecutorService executor</pre>
279 </li>
280 </ul>
281 </li>
282 </ul>
283 <!-- ========= CONSTRUCTOR DETAIL ======== -->
284 <ul class="blockList">
285 <li class="blockList"><a name="constructor.detail">
286 <!--   -->
287 </a>
288 <h3>Constructor Detail</h3>
289 <a name="MainManager--">
290 <!--   -->
291 </a>
292 <ul class="blockListLast">
293 <li class="blockList">
294 <h4>MainManager</h4>
295 <pre>public&nbsp;MainManager()</pre>
296 </li>
297 </ul>
298 </li>
299 </ul>
300 <!-- ============ METHOD DETAIL ========== -->
301 <ul class="blockList">
302 <li class="blockList"><a name="method.detail">
303 <!--   -->
304 </a>
305 <h3>Method Detail</h3>
306 <a name="contextDestroyed-javax.servlet.ServletContextEvent-">
307 <!--   -->
308 </a>
309 <ul class="blockList">
310 <li class="blockList">
311 <h4>contextDestroyed</h4>
312 <pre>public&nbsp;void&nbsp;contextDestroyed(javax.servlet.ServletContextEvent&nbsp;ignored)</pre>
313 <dl>
314 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
315 <dd><code>contextDestroyed</code>&nbsp;in interface&nbsp;<code>javax.servlet.ServletContextListener</code></dd>
316 </dl>
317 </li>
318 </ul>
319 <a name="contextInitialized-javax.servlet.ServletContextEvent-">
320 <!--   -->
321 </a>
322 <ul class="blockList">
323 <li class="blockList">
324 <h4>contextInitialized</h4>
325 <pre>public&nbsp;void&nbsp;contextInitialized(javax.servlet.ServletContextEvent&nbsp;arg0)</pre>
326 <dl>
327 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
328 <dd><code>contextInitialized</code>&nbsp;in interface&nbsp;<code>javax.servlet.ServletContextListener</code></dd>
329 </dl>
330 </li>
331 </ul>
332 <a name="getClusterJobDir--">
333 <!--   -->
334 </a>
335 <ul class="blockList">
336 <li class="blockList">
337 <h4>getClusterJobDir</h4>
338 <pre>static&nbsp;java.lang.String&nbsp;getClusterJobDir()</pre>
339 </li>
340 </ul>
341 <a name="getLocalJobDir--">
342 <!--   -->
343 </a>
344 <ul class="blockListLast">
345 <li class="blockList">
346 <h4>getLocalJobDir</h4>
347 <pre>static&nbsp;java.lang.String&nbsp;getLocalJobDir()</pre>
348 </li>
349 </ul>
350 </li>
351 </ul>
352 </li>
353 </ul>
354 </div>
355 </div>
356 <!-- ========= END OF CLASS DATA ========= -->
357 <!-- ======= START OF BOTTOM NAVBAR ====== -->
358 <div class="bottomNav"><a name="navbar.bottom">
359 <!--   -->
360 </a>
361 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
362 <a name="navbar.bottom.firstrow">
363 <!--   -->
364 </a>
365 <ul class="navList" title="Navigation">
366 <li><a href="../../../overview-summary.html">Overview</a></li>
367 <li><a href="package-summary.html">Package</a></li>
368 <li class="navBarCell1Rev">Class</li>
369 <li><a href="class-use/MainManager.html">Use</a></li>
370 <li><a href="package-tree.html">Tree</a></li>
371 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
372 <li><a href="../../../index-files/index-1.html">Index</a></li>
373 <li><a href="../../../help-doc.html">Help</a></li>
374 </ul>
375 </div>
376 <div class="subNav">
377 <ul class="navList">
378 <li><a href="../../../compbio/ws/server/MafftWS.html" title="class in compbio.ws.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
379 <li><a href="../../../compbio/ws/server/MSAprobsWS.html" title="class in compbio.ws.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
380 </ul>
381 <ul class="navList">
382 <li><a href="../../../index.html?compbio/ws/server/MainManager.html" target="_top">Frames</a></li>
383 <li><a href="MainManager.html" target="_top">No&nbsp;Frames</a></li>
384 </ul>
385 <ul class="navList" id="allclasses_navbar_bottom">
386 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
387 </ul>
388 <div>
389 <script type="text/javascript"><!--
390   allClassesLink = document.getElementById("allclasses_navbar_bottom");
391   if(window==top) {
392     allClassesLink.style.display = "block";
393   }
394   else {
395     allClassesLink.style.display = "none";
396   }
397   //-->
398 </script>
399 </div>
400 <div>
401 <ul class="subNavList">
402 <li>Summary:&nbsp;</li>
403 <li>Nested&nbsp;|&nbsp;</li>
404 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
405 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
406 <li><a href="#method.summary">Method</a></li>
407 </ul>
408 <ul class="subNavList">
409 <li>Detail:&nbsp;</li>
410 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
411 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
412 <li><a href="#method.detail">Method</a></li>
413 </ul>
414 </div>
415 <a name="skip.navbar.bottom">
416 <!--   -->
417 </a></div>
418 <!-- ======== END OF BOTTOM NAVBAR ======= -->
419 </body>
420 </html>