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.ws.server;
\r
21 import java.io.File;
\r
22 import java.util.List;
\r
24 import javax.annotation.Resource;
\r
25 import javax.jws.WebService;
\r
26 import javax.xml.ws.WebServiceContext;
\r
28 import org.apache.log4j.Logger;
\r
30 import compbio.data.msa.MsaWS;
\r
31 import compbio.data.sequence.Alignment;
\r
32 import compbio.data.sequence.FastaSequence;
\r
33 import compbio.engine.AsyncExecutor;
\r
34 import compbio.engine.Configurator;
\r
35 import compbio.engine.client.ConfiguredExecutable;
\r
36 import compbio.metadata.ChunkHolder;
\r
37 import compbio.metadata.JobStatus;
\r
38 import compbio.metadata.JobSubmissionException;
\r
39 import compbio.metadata.Limit;
\r
40 import compbio.metadata.LimitsManager;
\r
41 import compbio.metadata.Option;
\r
42 import compbio.metadata.Preset;
\r
43 import compbio.metadata.PresetManager;
\r
44 import compbio.metadata.ResultNotAvailableException;
\r
45 import compbio.metadata.RunnerConfig;
\r
46 import compbio.metadata.WrongParameterException;
\r
47 import compbio.runner.Util;
\r
48 import compbio.runner.msa.Muscle;
\r
50 @WebService(endpointInterface = "compbio.data.msa.MsaWS", targetNamespace = "http://msa.data.compbio/01/01/2010/", serviceName = "MuscleWS")
\r
51 public class MuscleWS implements MsaWS<Muscle> {
\r
53 // Ask for resource injection
\r
55 WebServiceContext wsContext;
\r
57 private static Logger statLog = Logger.getLogger("MuscleWS-stats");
\r
59 private static Logger log = Logger.getLogger(MuscleWS.class);
\r
61 private static final RunnerConfig<Muscle> muscleOptions = Util
\r
62 .getSupportedOptions(Muscle.class);
\r
64 private static final PresetManager<Muscle> musclePresets = Util
\r
65 .getPresets(Muscle.class);
\r
67 private static final LimitsManager<Muscle> limitMan = compbio.runner.Util
\r
68 .getLimits(new Muscle().getType());
\r
71 public String align(List<FastaSequence> sequences)
\r
72 throws JobSubmissionException {
\r
73 WSUtil.validateFastaInput(sequences);
\r
74 ConfiguredExecutable<Muscle> confMuscle = init(sequences);
\r
75 return WSUtil.align(sequences, confMuscle, null, "align", getLimit(""));
\r
78 ConfiguredExecutable<Muscle> init(List<FastaSequence> sequences)
\r
79 throws JobSubmissionException {
\r
80 Muscle muscle = new Muscle();
\r
81 muscle.setInput("fasta.in").setOutput("fasta.out");
\r
82 return Configurator.configureExecutable(muscle, sequences);
\r
86 public String customAlign(List<FastaSequence> sequences,
\r
87 List<Option<Muscle>> options) throws JobSubmissionException,
\r
88 WrongParameterException {
\r
89 WSUtil.validateFastaInput(sequences);
\r
90 ConfiguredExecutable<Muscle> confMuscle = init(sequences);
\r
91 // Could not do that! Space separated values
\r
92 // will all be treated as keys! thus duplicates removed
\r
93 // String params = cbuilder.getCommand();
\r
94 List<String> params = WSUtil.getCommands(options,
\r
95 Muscle.KEY_VALUE_SEPARATOR);
\r
96 confMuscle.addParameters(params);
\r
97 return WSUtil.align(sequences, confMuscle, null, "customAlign",
\r
102 public String presetAlign(List<FastaSequence> sequences,
\r
103 Preset<Muscle> preset) throws JobSubmissionException,
\r
104 WrongParameterException {
\r
105 WSUtil.validateFastaInput(sequences);
\r
106 if (preset == null) {
\r
107 throw new WrongParameterException("Preset must be provided!");
\r
109 ConfiguredExecutable<Muscle> confMuscle = init(sequences);
\r
110 confMuscle.addParameters(preset.getOptions());
\r
111 Limit<Muscle> limit = getLimit(preset.getName());
\r
112 return WSUtil.align(sequences, confMuscle, null, "presetAlign", limit);
\r
115 @SuppressWarnings("unchecked")
\r
117 public Alignment getResult(String jobId) throws ResultNotAvailableException {
\r
118 WSUtil.validateJobId(jobId);
\r
119 AsyncExecutor asyncEngine = Configurator.getAsyncEngine(jobId);
\r
120 ConfiguredExecutable<Muscle> muscle = (ConfiguredExecutable<Muscle>) asyncEngine
\r
121 .getResults(jobId);
\r
122 Alignment al = muscle.getResults();
\r
123 // log(jobId, "getResults");
\r
128 public Limit<Muscle> getLimit(String presetName) {
\r
129 if (limitMan == null) {
\r
130 // No limit is configured
\r
133 return limitMan.getLimitByName(presetName);
\r
137 public LimitsManager<Muscle> getLimits() {
\r
142 public ChunkHolder pullExecStatistics(String jobId, long position) {
\r
143 WSUtil.validateJobId(jobId);
\r
144 String file = Configurator.getWorkDirectory(jobId) + File.separator
\r
145 + Muscle.getStatFile();
\r
146 return WSUtil.pullFile(file, position);
\r
150 public boolean cancelJob(String jobId) {
\r
151 WSUtil.validateJobId(jobId);
\r
152 return WSUtil.cancelJob(jobId);
\r
156 public JobStatus getJobStatus(String jobId) {
\r
157 WSUtil.validateJobId(jobId);
\r
158 return WSUtil.getJobStatus(jobId);
\r
162 public PresetManager<Muscle> getPresets() {
\r
163 return musclePresets;
\r
167 public RunnerConfig<Muscle> getRunnerOptions() {
\r
168 return muscleOptions;
\r