webservices/compbio/ws/server/TcoffeeWS.java

   1 /* Copyright (c) 2009 Peter Troshin\r
   2  *  \r
   3  *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 1.0\r
   4  * \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
   7  * \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
  11  * \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
  14  * \r
  15  * Any republication or derived work distributed in source code form\r
  16  * must include this copyright and license notice.\r
  17  */\r
  18 \r
  19 package compbio.ws.server;\r
  20 \r
  21 import java.io.File;\r
  22 import java.util.List;\r
  23 \r
  24 import javax.annotation.Resource;\r
  25 import javax.jws.WebService;\r
  26 import javax.xml.ws.WebServiceContext;\r
  27 \r
  28 import org.apache.log4j.Logger;\r
  29 \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.engine.client.Executable;\r
  37 import compbio.engine.client.SkeletalExecutable;\r
  38 import compbio.metadata.ChunkHolder;\r
  39 import compbio.metadata.JobStatus;\r
  40 import compbio.metadata.JobSubmissionException;\r
  41 import compbio.metadata.Limit;\r
  42 import compbio.metadata.LimitsManager;\r
  43 import compbio.metadata.Option;\r
  44 import compbio.metadata.Preset;\r
  45 import compbio.metadata.PresetManager;\r
  46 import compbio.metadata.ResultNotAvailableException;\r
  47 import compbio.metadata.RunnerConfig;\r
  48 import compbio.metadata.WrongParameterException;\r
  49 import compbio.runner.Util;\r
  50 import compbio.runner.msa.Tcoffee;\r
  51 \r
  52 @WebService(endpointInterface = "compbio.data.msa.MsaWS", targetNamespace = "http://msa.data.compbio/01/01/2010/", serviceName = "TcoffeeWS")\r
  53 public class TcoffeeWS implements MsaWS<Tcoffee> {\r
  54 \r
  55     // Ask for resource injection\r
  56     @Resource\r
  57     WebServiceContext wsContext;\r
  58 \r
  59     private static Logger statLog = Logger.getLogger("TcoffeeWS-stats");\r
  60 \r
  61     private static Logger log = Logger.getLogger(TcoffeeWS.class);\r
  62 \r
  63     private static final RunnerConfig<Tcoffee> tcoffeeOptions = Util\r
  64             .getSupportedOptions(Tcoffee.class);\r
  65 \r
  66     private static final PresetManager<Tcoffee> tcoffeePresets = Util\r
  67             .getPresets(Tcoffee.class);\r
  68 \r
  69     @Override\r
  70     public String align(List<FastaSequence> sequences)\r
  71             throws JobSubmissionException {\r
  72         WSUtil.validateFastaInput(sequences);\r
  73         ConfiguredExecutable<Tcoffee> confTcoffee = init(sequences);\r
  74         return WSUtil\r
  75                 .align(sequences, confTcoffee, null, "align", getLimit(""));\r
  76     }\r
  77 \r
  78     ConfiguredExecutable<Tcoffee> init(List<FastaSequence> sequences)\r
  79     throws JobSubmissionException {\r
  80         Tcoffee tcoffee = new Tcoffee();\r
  81         tcoffee.setInput("fasta.in").setOutput("fasta.out");\r
  82         ConfiguredExecutable<Tcoffee> confCoffee = Configurator\r
  83         .configureExecutable(tcoffee, sequences);\r
  84         if (confCoffee.getExecProvider() == Executable.ExecProvider.Cluster) {\r
  85                 int clusterCpuNum = SkeletalExecutable.getClusterCpuNum(Tcoffee.class);\r
  86                 if (clusterCpuNum != 0) {\r
  87                         tcoffee.setNCore(clusterCpuNum);\r
  88                 }\r
  89         }\r
  90         return confCoffee;\r
  91     }\r
  92 \r
  93     @Override\r
  94     public String customAlign(List<FastaSequence> sequences,\r
  95             List<Option<Tcoffee>> options) throws JobSubmissionException,\r
  96             WrongParameterException {\r
  97 \r
  98         WSUtil.validateFastaInput(sequences);\r
  99         ConfiguredExecutable<Tcoffee> confTcoffee = init(sequences);\r
 100         List<String> params = WSUtil.getCommands(options,\r
 101                 Tcoffee.KEY_VALUE_SEPARATOR);\r
 102         log.info("Setting parameters:" + params);\r
 103         confTcoffee.addParameters(params);\r
 104         return WSUtil.align(sequences, confTcoffee, null, "customAlign",\r
 105                 getLimit(""));\r
 106     }\r
 107 \r
 108     @Override\r
 109     public String presetAlign(List<FastaSequence> sequences,\r
 110             Preset<Tcoffee> preset) throws JobSubmissionException,\r
 111             WrongParameterException {\r
 112         WSUtil.validateFastaInput(sequences);\r
 113         if (preset == null) {\r
 114             throw new WrongParameterException("Preset must be provided!");\r
 115         }\r
 116         ConfiguredExecutable<Tcoffee> confTcoffee = init(sequences);\r
 117         confTcoffee.addParameters(preset.getOptions());\r
 118         Limit<Tcoffee> limit = getLimit(preset.getName());\r
 119         return WSUtil.align(sequences, confTcoffee, null, "presetAlign", limit);\r
 120     }\r
 121 \r
 122     @SuppressWarnings("unchecked")\r
 123     @Override\r
 124     public Alignment getResult(String jobId) throws ResultNotAvailableException {\r
 125         WSUtil.validateJobId(jobId);\r
 126         AsyncExecutor asyncEngine = Configurator.getAsyncEngine(jobId);\r
 127         ConfiguredExecutable<Tcoffee> tcoffee = (ConfiguredExecutable<Tcoffee>) asyncEngine\r
 128                 .getResults(jobId);\r
 129         Alignment al = tcoffee.getResults();\r
 130         //log(jobId, "getResults");\r
 131         return al;\r
 132     }\r
 133 \r
 134     @Override\r
 135     public Limit<Tcoffee> getLimit(String presetName) {\r
 136         return new Tcoffee().getLimit(presetName);\r
 137     }\r
 138 \r
 139     @Override\r
 140     public LimitsManager<Tcoffee> getLimits() {\r
 141         return new Tcoffee().getLimits();\r
 142     }\r
 143 \r
 144     @Override\r
 145     public ChunkHolder pullExecStatistics(String jobId, long position) {\r
 146         WSUtil.validateJobId(jobId);\r
 147         String file = Configurator.getWorkDirectory(jobId) + File.separator\r
 148                 + new Tcoffee().getError();\r
 149         return WSUtil.pullFile(file, position);\r
 150     }\r
 151 \r
 152     @Override\r
 153     public boolean cancelJob(String jobId) {\r
 154         WSUtil.validateJobId(jobId);\r
 155         return WSUtil.cancelJob(jobId);\r
 156     }\r
 157 \r
 158     @Override\r
 159     public JobStatus getJobStatus(String jobId) {\r
 160         WSUtil.validateJobId(jobId);\r
 161         return WSUtil.getJobStatus(jobId);\r
 162     }\r
 163 \r
 164     @Override\r
 165     public PresetManager<Tcoffee> getPresets() {\r
 166         return tcoffeePresets;\r
 167     }\r
 168 \r
 169     @Override\r
 170     public RunnerConfig<Tcoffee> getRunnerOptions() {\r
 171         return tcoffeeOptions;\r
 172     }\r
 173 \r
 174 }\r