1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.6.0_24) on Wed Dec 07 12:30:42 GMT 2011 -->
\r
10 <META NAME="date" CONTENT="2011-12-07">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 if (location.href.indexOf('is-external=true') == -1) {
\r
18 parent.document.title="ExecutableWrapper";
\r
27 <BODY BGCOLOR="white" onload="windowTitle();">
\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
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> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ExecutableWrapper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../../compbio/engine/local/AsyncLocalRunner.html" title="class in compbio.engine.local"><B>PREV CLASS</B></A>
\r
59 <A HREF="../../../compbio/engine/local/LocalEngineUtil.html" title="class in compbio.engine.local"><B>NEXT CLASS</B></A></FONT></TD>
\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
61 <A HREF="../../../index.html?compbio/engine/local/ExecutableWrapper.html" target="_top"><B>FRAMES</B></A>
\r
62 <A HREF="ExecutableWrapper.html" target="_top"><B>NO FRAMES</B></A>
\r
63 <SCRIPT type="text/javascript">
\r
66 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
71 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
79 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
81 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
84 <A NAME="skip-navbar_top"></A>
\r
85 <!-- ========= END OF TOP NAVBAR ========= -->
\r
88 <!-- ======== START OF CLASS DATA ======== -->
\r
91 compbio.engine.local</FONT>
\r
93 Class ExecutableWrapper</H2>
\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.engine.local.ExecutableWrapper</B>
\r
99 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</A><<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?>></DD>
\r
103 <DT><PRE><FONT SIZE="-1">@Immutable
\r
104 </FONT>public final class <B>ExecutableWrapper</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 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</A><<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?>></DL>
\r
111 <!-- =========== FIELD SUMMARY =========== -->
\r
113 <A NAME="field_summary"><!-- --></A>
\r
114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
116 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
117 <B>Field Summary</B></FONT></TH>
\r
119 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
120 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
121 <CODE>static <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
\r
122 <TD><CODE><B><A HREF="../../../compbio/engine/local/ExecutableWrapper.html#PROC_ERR_FILE">PROC_ERR_FILE</A></B></CODE>
\r
125 </TD>
\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
129 <CODE>static <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
\r
130 <TD><CODE><B><A HREF="../../../compbio/engine/local/ExecutableWrapper.html#PROC_OUT_FILE">PROC_OUT_FILE</A></B></CODE>
\r
133 </TD>
\r
137 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
139 <A NAME="constructor_summary"><!-- --></A>
\r
140 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
141 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
142 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
143 <B>Constructor Summary</B></FONT></TH>
\r
145 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
146 <TD><CODE><B><A HREF="../../../compbio/engine/local/ExecutableWrapper.html#ExecutableWrapper(compbio.engine.client.ConfiguredExecutable, java.lang.String)">ExecutableWrapper</A></B>(<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> executable,
\r
147 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> workDirectory)</CODE>
\r
150 </TD>
\r
154 <!-- ========== METHOD SUMMARY =========== -->
\r
156 <A NAME="method_summary"><!-- --></A>
\r
157 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
158 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
159 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
160 <B>Method Summary</B></FONT></TH>
\r
162 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
163 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
164 <CODE> <A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?></CODE></FONT></TD>
\r
165 <TD><CODE><B><A HREF="../../../compbio/engine/local/ExecutableWrapper.html#call()">call</A></B>()</CODE>
\r
168 It is vital that output and error streams are captured immediately for
169 this call() to succeed.</TD>
\r
171 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
172 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
173 <CODE>static void</CODE></FONT></TD>
\r
174 <TD><CODE><B><A HREF="../../../compbio/engine/local/ExecutableWrapper.html#shutdownService()">shutdownService</A></B>()</CODE>
\r
177 Stops internal executor service which captures streams of native
181 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
182 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
183 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
184 <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
186 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
187 <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
193 <!-- ============ FIELD DETAIL =========== -->
\r
195 <A NAME="field_detail"><!-- --></A>
\r
196 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
197 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
198 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
199 <B>Field Detail</B></FONT></TH>
\r
203 <A NAME="PROC_OUT_FILE"><!-- --></A><H3>
\r
206 public static final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>PROC_OUT_FILE</B></PRE>
\r
209 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#compbio.engine.local.ExecutableWrapper.PROC_OUT_FILE">Constant Field Values</A></DL>
\r
213 <A NAME="PROC_ERR_FILE"><!-- --></A><H3>
\r
216 public static final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>PROC_ERR_FILE</B></PRE>
\r
219 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#compbio.engine.local.ExecutableWrapper.PROC_ERR_FILE">Constant Field Values</A></DL>
\r
222 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
224 <A NAME="constructor_detail"><!-- --></A>
\r
225 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
226 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
227 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
228 <B>Constructor Detail</B></FONT></TH>
\r
232 <A NAME="ExecutableWrapper(compbio.engine.client.ConfiguredExecutable, java.lang.String)"><!-- --></A><H3>
\r
233 ExecutableWrapper</H3>
\r
235 public <B>ExecutableWrapper</B>(<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> executable,
\r
236 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> workDirectory)
\r
237 throws <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>
\r
242 <DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE></DL>
\r
245 <!-- ============ METHOD DETAIL ========== -->
\r
247 <A NAME="method_detail"><!-- --></A>
\r
248 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
249 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
250 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
251 <B>Method Detail</B></FONT></TH>
\r
255 <A NAME="shutdownService()"><!-- --></A><H3>
\r
256 shutdownService</H3>
\r
258 public static final void <B>shutdownService</B>()</PRE>
\r
260 <DD>Stops internal executor service which captures streams of native
261 executables. This method is intended for stopping service if deployed in
262 the web application content. There is NO NEED of using this method
263 otherwise as the executor service is taken care of internally.
\r
274 <A NAME="call()"><!-- --></A><H3>
\r
277 public <A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> <B>call</B>()
\r
278 throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
\r
280 <DD>It is vital that output and error streams are captured immediately for
281 this call() to succeed. Thus each instance if ExecutableWrapper has 2 its
282 own thread ready to capture the output. If executor could not execute
283 capture immediately this could lead to the call method to stale, as
284 execution could not proceed without output being captured. Every call to
285 call() method will use 2 threads
\r
288 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true#call()" title="class or interface in java.util.concurrent">call</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</A><<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?>></CODE></DL>
\r
293 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
\r
296 <!-- ========= END OF CLASS DATA ========= -->
\r
300 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
301 <A NAME="navbar_bottom"><!-- --></A>
\r
302 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
303 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
305 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
306 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
307 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
308 <TR ALIGN="center" VALIGN="top">
\r
309 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
310 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
311 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
312 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ExecutableWrapper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
314 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
315 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
320 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
326 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
327 <A HREF="../../../compbio/engine/local/AsyncLocalRunner.html" title="class in compbio.engine.local"><B>PREV CLASS</B></A>
\r
328 <A HREF="../../../compbio/engine/local/LocalEngineUtil.html" title="class in compbio.engine.local"><B>NEXT CLASS</B></A></FONT></TD>
\r
329 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
330 <A HREF="../../../index.html?compbio/engine/local/ExecutableWrapper.html" target="_top"><B>FRAMES</B></A>
\r
331 <A HREF="ExecutableWrapper.html" target="_top"><B>NO FRAMES</B></A>
\r
332 <SCRIPT type="text/javascript">
\r
335 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
340 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
347 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
348 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
349 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
350 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
353 <A NAME="skip-navbar_bottom"></A>
\r
354 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r