1 /* Copyright (c) 2009 Peter Troshin
\r
3 * JAva Bioinformatics Analysis Web Services (JABAWS) @version: 1.0
\r
5 * This library is free software; you can redistribute it and/or modify it under the terms of the
\r
6 * Apache License version 2 as published by the Apache Software Foundation
\r
8 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
\r
9 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache
\r
10 * License for more details.
\r
12 * A copy of the license is in apache_license.txt. It is also available here:
\r
13 * @see: http://www.apache.org/licenses/LICENSE-2.0.txt
\r
15 * Any republication or derived work distributed in source code form
\r
16 * must include this copyright and license notice.
\r
19 package compbio.engine.client;
\r
21 import java.io.File;
\r
22 import java.io.FileInputStream;
\r
23 import java.io.IOException;
\r
24 import java.io.InputStream;
\r
25 import java.util.ArrayList;
\r
26 import java.util.Collections;
\r
27 import java.util.List;
\r
28 import java.util.Map;
\r
30 import javax.xml.bind.JAXBException;
\r
32 import org.apache.log4j.Logger;
\r
34 import compbio.engine.conf.PropertyHelperManager;
\r
35 import compbio.engine.conf.RunnerConfigMarshaller;
\r
36 import compbio.metadata.Limit;
\r
37 import compbio.metadata.LimitsManager;
\r
38 import compbio.metadata.PresetManager;
\r
39 import compbio.metadata.ResultNotAvailableException;
\r
40 import compbio.metadata.RunnerConfig;
\r
41 import compbio.metadata.UnsupportedRuntimeException;
\r
42 import compbio.util.FileUtil;
\r
43 import compbio.util.PropertyHelper;
\r
44 import compbio.util.SysPrefs;
\r
45 import compbio.util.Util;
\r
47 public class ConfExecutable<T> implements ConfiguredExecutable<T> {
\r
49 private static final Logger log = Logger.getLogger(ConfExecutable.class);
\r
51 private static final PropertyHelper ph = PropertyHelperManager
\r
52 .getPropertyHelper();
\r
53 public final static String CLUSTER_TASK_ID_PREFIX = "@";
\r
55 private String workDirectory;
\r
56 private String taskDirectory;
\r
58 private ExecProvider provider;
\r
59 private Executable<T> exec;
\r
61 public ConfExecutable(Executable<T> executable, String taskDirectory) {
\r
62 this.exec = executable;
\r
63 assert !compbio.util.Util.isEmpty(taskDirectory);
\r
64 this.taskDirectory = taskDirectory;
\r
67 // TODO think about appropriate exception here
\r
68 ConfExecutable(RunConfiguration rconf) {
\r
70 exec = (Executable<T>) Class.forName(rconf.runnerClassName).newInstance();
\r
71 } catch (InstantiationException e) {
\r
72 e.printStackTrace();
\r
73 } catch (IllegalAccessException e) {
\r
74 e.printStackTrace();
\r
75 } catch (ClassNotFoundException e) {
\r
76 e.printStackTrace();
\r
78 exec.loadRunConfiguration(rconf);
\r
79 setWorkDirectory(rconf.workDirectory);
\r
80 this.taskDirectory = rconf.taskId;
\r
84 public ExecProvider getExecProvider() {
\r
88 public void setExecProvider(ExecProvider provider) {
\r
89 assert provider != null && provider != ExecProvider.Any;
\r
90 this.provider = provider;
\r
91 if (provider == Executable.ExecProvider.Cluster) {
\r
92 this.taskDirectory = CLUSTER_TASK_ID_PREFIX + taskDirectory;
\r
97 public String getCommand(ExecProvider provider)
\r
98 throws UnsupportedRuntimeException {
\r
99 String command = compbio.engine.client.Util.getCommand(provider,
\r
101 if (Util.isEmpty(command)) {
\r
102 throw new UnsupportedRuntimeException(
\r
104 + this.exec.getClass().getSimpleName()
\r
105 + " is not supported by the current runtime environment! Current runtime environment is "
\r
106 + (SysPrefs.isWindows
\r
108 : "Linux/Unix/Mac"));
\r
114 public ExecProvider getSupportedRuntimes() {
\r
115 return compbio.engine.client.Util.getSupportedRuntimes(exec.getClass());
\r
119 public Limit<T> getLimit(String presetName) {
\r
120 return exec.getLimit(presetName);
\r
124 public LimitsManager<T> getLimits() {
\r
125 return exec.getLimits();
\r
129 public String getTaskId() {
\r
130 return taskDirectory;
\r
134 public void setWorkDirectory(String workDirectory) {
\r
135 assert !compbio.util.Util.isEmpty(workDirectory);
\r
136 this.workDirectory = workDirectory;
\r
140 public String getWorkDirectory() {
\r
141 return this.workDirectory;
\r
145 public Executable<T> addParameters(List<String> parameters) {
\r
146 exec.addParameters(parameters);
\r
151 public String getOutput() {
\r
152 return exec.getOutput();
\r
156 public String getError() {
\r
157 return exec.getError();
\r
161 public List<String> getCreatedFiles() {
\r
162 return getFullPath(exec.getCreatedFiles());
\r
165 List<String> getFullPath(List<String> fileNames) {
\r
166 List<String> files = new ArrayList<String>();
\r
167 for (String fileName : fileNames) {
\r
168 files.add(compbio.engine.client.Util.getFullPath(workDirectory,
\r
175 * Not all input paths are relative! Input path could be absolute!
\r
177 * @see compbio.engine.client.Executable#getInputFiles()
\r
180 public String getInput() {
\r
181 String path = exec.getInput();
\r
182 if (PathValidator.isAbsolutePath(path)) {
\r
185 return compbio.engine.client.Util.getFullPath(workDirectory, path);
\r
189 public CommandBuilder<T> getParameters() {
\r
190 return exec.getParameters(provider);
\r
194 public CommandBuilder<T> getParameters(
\r
195 compbio.engine.client.Executable.ExecProvider provider) {
\r
196 return getParameters();
\r
200 public Executable<T> getExecutable() {
\r
205 public <V> V getResults() throws ResultNotAvailableException {
\r
206 return (V) exec.getResults(workDirectory);
\r
210 * This is just a pass through method (non-Javadoc)
\r
212 * @see compbio.runner.Executable#getResults(java.lang.String)
\r
215 public <V> V getResults(String directory)
\r
216 throws ResultNotAvailableException {
\r
217 return (V) exec.getResults(directory);
\r
221 * This method should be executed once and result of its execution reused.
\r
222 * If not used carefully it could slow down the system!
\r
224 public static <V> RunnerConfig<V> getRunnerOptions(
\r
225 Class<? extends Executable<V>> clazz) throws IOException {
\r
226 String parametersFile = clazz.getSimpleName().toLowerCase() + ".parameters.file";
\r
227 return (RunnerConfig<V>) getRunnerConfiguration(clazz, RunnerConfig.class, parametersFile);
\r
231 * This method should be executed once and result of its execution reused.
\r
232 * If not used carefully it could slow down the system!
\r
234 public static <V> PresetManager<V> getRunnerPresets(
\r
235 Class<? extends Executable<V>> clazz) throws IOException {
\r
236 String parametersFile = clazz.getSimpleName().toLowerCase() + ".presets.file";
\r
237 PresetManager<V> presets = (PresetManager<V>) getRunnerConfiguration(clazz, PresetManager.class, parametersFile);
\r
242 * This method should be executed once and result of its execution reused.
\r
243 * If not used carefully it could slow down the system!
\r
247 * @return LimitsManager instance
\r
248 * @throws IOException
\r
250 public static <V> LimitsManager<V> getRunnerLimits(Class<V> clazz)
\r
251 throws IOException {
\r
252 String parametersFile = clazz.getSimpleName().toLowerCase() + ".limits.file";
\r
253 LimitsManager<V> limits = (LimitsManager<V>) getRunnerConfiguration(clazz, LimitsManager.class, parametersFile);
\r
257 static <V> Object getRunnerConfiguration(Class<V> clazz,
\r
258 Class<?> configurationHolder, String propertyName)
\r
259 throws IOException {
\r
261 Object rconf = null;
\r
262 FileInputStream confFileStream = null;
\r
264 RunnerConfigMarshaller<V> rcm = new RunnerConfigMarshaller<V>(
\r
265 configurationHolder);
\r
266 String path = ph.getProperty(propertyName);
\r
267 if (compbio.util.Util.isEmpty(path)) {
\r
268 log.debug("Configuration " + path + " is not provided");
\r
271 log.debug("Loading Configuration from " + path + " Config type:"
\r
272 + configurationHolder);
\r
273 File confFile = new File(PropertyHelperManager.getLocalPath()
\r
275 confFileStream = new FileInputStream(confFile);
\r
276 rconf = rcm.read(confFileStream, configurationHolder);
\r
277 confFileStream.close();
\r
278 } catch (JAXBException e) {
\r
279 log.error(e.getLocalizedMessage(), e.getCause());
\r
281 FileUtil.closeSilently(log, confFileStream);
\r
287 public Map<String, String> getEnvironment() {
\r
288 String envProperty = ph.getProperty(exec.getClass().getSimpleName()
\r
291 if (envProperty == null) {
\r
292 return Collections.emptyMap();
\r
295 return EnvVariableProcessor.getEnvVariables(envProperty,
\r
300 public ConfiguredExecutable<?> loadRunConfiguration(RunConfiguration rconf) {
\r
301 if (rconf == null) {
\r
302 throw new NullPointerException("RunConfiguration is expected!");
\r
304 return new ConfExecutable(rconf);
\r
307 public static ConfiguredExecutable<?> newConfExecutable(
\r
308 RunConfiguration rconf) {
\r
309 if (rconf == null) {
\r
310 throw new NullPointerException("RunConfiguration is expected!");
\r
312 return new ConfExecutable(rconf);
\r
316 public boolean saveRunConfiguration() throws IOException {
\r
317 RunConfiguration rconf = getRunConfiguration();
\r
318 return RunConfiguration.write(rconf);
\r
321 public RunConfiguration getRunConfiguration() {
\r
323 * Distinguish between dynamic settings and static settings (set in conf
\r
324 * or class) The latter does not need saving (as if they change there
\r
325 * were a good reason for this and it make it impossible/dangerous to
\r
326 * rerun the task with old settings)
\r
328 // Set within Executable
\r
329 // String taskId = executable.getTaskId();
\r
332 * All things below are handled by Executable
\r
334 * getInput() && getOutput()
\r
336 * // Handle PipedExecutables String error = executable.getError(); if
\r
337 * (error != null) {
\r
339 * } String output = executable.getOutput(); if (output != null) {
\r
341 * } List<String> outputs = executable.getCreatedFiles(); List<String>
\r
342 * inputs = executable.getInputFiles();
\r
344 * /* Environment is defined only declaratively. Map<String,String> env
\r
345 * = executable.getEnvironment();
\r
347 * List<String> params = executable.getParameters();
\r
349 RunConfiguration rconf = new RunConfiguration(this);
\r
354 public ConfiguredExecutable<?> loadRunConfiguration(InputStream input)
\r
355 throws IOException {
\r
356 RunConfiguration rconf = RunConfiguration.load(input);
\r
357 log.info("Loaded saved RunConfiguration " + rconf);
\r
358 return new ConfExecutable(rconf);
\r
362 public String toString() {
\r
363 String value = "Work dir: " + this.workDirectory + "\n";
\r
364 value += "TaskId: " + this.taskDirectory + "\n";
\r
365 value += "Params: " + this.getParameters() + "\n";
\r
366 value += exec.toString();
\r
371 public String getClusterJobSettings() {
\r
372 return exec.getClusterJobSettings();
\r