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.Mafft;
\r
50 @WebService(endpointInterface = "compbio.data.msa.MsaWS", targetNamespace = "http://msa.data.compbio/01/01/2010/", serviceName = "MafftWS")
\r
51 public class MafftWS implements MsaWS<Mafft> {
\r
53 // Ask for resource injection
\r
55 WebServiceContext wsContext;
\r
57 private static Logger statLog = Logger.getLogger("MafftWS-stats");
\r
59 private static Logger log = Logger.getLogger(MafftWS.class);
\r
61 private static final RunnerConfig<Mafft> mafftOptions = Util
\r
62 .getSupportedOptions(Mafft.class);
\r
64 private static final PresetManager<Mafft> mafftPresets = Util
\r
65 .getPresets(Mafft.class);
\r
67 private static final LimitsManager<Mafft> limitMan = compbio.runner.Util
\r
68 .getLimits(new Mafft().getType());
\r
71 public String align(List<FastaSequence> sequences)
\r
72 throws JobSubmissionException {
\r
73 WSUtil.validateFastaInput(sequences);
\r
74 ConfiguredExecutable<Mafft> confMafft = init(sequences);
\r
75 return WSUtil.align(sequences, confMafft, null, "align", getLimit(""));
\r
78 ConfiguredExecutable<Mafft> init(List<FastaSequence> dataSet)
\r
79 throws JobSubmissionException {
\r
80 Mafft mafft = new Mafft();
\r
81 mafft.setInput("fasta.in").setOutput("fasta.out");
\r
82 return Configurator.configureExecutable(mafft, dataSet);
\r
86 public String customAlign(List<FastaSequence> sequences,
\r
87 List<Option<Mafft>> options) throws JobSubmissionException,
\r
88 WrongParameterException {
\r
89 WSUtil.validateFastaInput(sequences);
\r
90 ConfiguredExecutable<Mafft> confMafft = init(sequences);
\r
91 List<String> params = WSUtil.getCommands(options,
\r
92 Mafft.KEY_VALUE_SEPARATOR);
\r
93 log.info("Setting parameters: " + params);
\r
94 confMafft.addParameters(params);
\r
95 return WSUtil.align(sequences, confMafft, null, "customAlign",
\r
100 public String presetAlign(List<FastaSequence> sequences,
\r
101 Preset<Mafft> preset) throws JobSubmissionException,
\r
102 WrongParameterException {
\r
103 WSUtil.validateFastaInput(sequences);
\r
104 if (preset == null) {
\r
105 throw new WrongParameterException("Preset must be provided!");
\r
107 ConfiguredExecutable<Mafft> confMafft = init(sequences);
\r
108 confMafft.addParameters(preset.getOptions());
\r
109 // This will return default limit if a specific the limit for a
\r
110 // particular preset is not found
\r
111 Limit<Mafft> limit = getLimit(preset.getName());
\r
113 return WSUtil.align(sequences, confMafft, null, "presetAlign", limit);
\r
116 @SuppressWarnings("unchecked")
\r
118 public Alignment getResult(String jobId) throws ResultNotAvailableException {
\r
119 WSUtil.validateJobId(jobId);
\r
120 AsyncExecutor asyncEngine = Configurator.getAsyncEngine(jobId);
\r
121 ConfiguredExecutable<Mafft> mafft = (ConfiguredExecutable<Mafft>) asyncEngine
\r
122 .getResults(jobId);
\r
123 Alignment al = mafft.getResults();
\r
124 // log(jobId, "getResults");
\r
129 public Limit<Mafft> getLimit(String presetName) {
\r
130 if (limitMan == null) {
\r
131 // Limit is not defined
\r
134 return limitMan.getLimitByName(presetName);
\r
138 public LimitsManager<Mafft> getLimits() {
\r
143 public ChunkHolder pullExecStatistics(String jobId, long position) {
\r
144 WSUtil.validateJobId(jobId);
\r
145 String file = Configurator.getWorkDirectory(jobId) + File.separator
\r
146 + new Mafft().getError();
\r
147 return WSUtil.pullFile(file, position);
\r
151 public boolean cancelJob(String jobId) {
\r
152 WSUtil.validateJobId(jobId);
\r
153 return WSUtil.cancelJob(jobId);
\r
157 public JobStatus getJobStatus(String jobId) {
\r
158 WSUtil.validateJobId(jobId);
\r
159 return WSUtil.getJobStatus(jobId);
\r
163 public PresetManager<Mafft> getPresets() {
\r
164 return mafftPresets;
\r
168 public RunnerConfig<Mafft> getRunnerOptions() {
\r
169 return mafftOptions;
\r