webservices/compbio/ws/server/MuscleWS.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.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
  49 \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
  52 \r
  53         // Ask for resource injection\r
  54         @Resource\r
  55         WebServiceContext wsContext;\r
  56 \r
  57         private static Logger statLog = Logger.getLogger("MuscleWS-stats");\r
  58 \r
  59         private static Logger log = Logger.getLogger(MuscleWS.class);\r
  60 \r
  61         private static final RunnerConfig<Muscle> muscleOptions = Util\r
  62                         .getSupportedOptions(Muscle.class);\r
  63 \r
  64         private static final PresetManager<Muscle> musclePresets = Util\r
  65                         .getPresets(Muscle.class);\r
  66 \r
  67         private static final LimitsManager<Muscle> limitMan = compbio.runner.Util\r
  68                         .getLimits(new Muscle().getType());\r
  69 \r
  70         @Override\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
  76         }\r
  77 \r
  78         ConfiguredExecutable<Muscle> init(List<FastaSequence> sequences)\r
  79                         throws JobSubmissionException {\r
  80                 Muscle muscle = new Muscle();\r
  81                 return Configurator.configureExecutable(muscle, sequences);\r
  82         }\r
  83 \r
  84         @Override\r
  85         public String customAlign(List<FastaSequence> sequences,\r
  86                         List<Option<Muscle>> options) throws JobSubmissionException,\r
  87                         WrongParameterException {\r
  88                 WSUtil.validateFastaInput(sequences);\r
  89                 ConfiguredExecutable<Muscle> confMuscle = init(sequences);\r
  90                 // Could not do that! Space separated values\r
  91                 // will all be treated as keys! thus duplicates removed\r
  92                 // String params = cbuilder.getCommand();\r
  93                 List<String> params = WSUtil.getCommands(options,\r
  94                                 Muscle.KEY_VALUE_SEPARATOR);\r
  95                 confMuscle.addParameters(params);\r
  96                 return WSUtil.align(sequences, confMuscle, null, "customAlign",\r
  97                                 getLimit(""));\r
  98         }\r
  99 \r
 100         @Override\r
 101         public String presetAlign(List<FastaSequence> sequences,\r
 102                         Preset<Muscle> preset) throws JobSubmissionException,\r
 103                         WrongParameterException {\r
 104                 WSUtil.validateFastaInput(sequences);\r
 105                 if (preset == null) {\r
 106                         throw new WrongParameterException("Preset must be provided!");\r
 107                 }\r
 108                 ConfiguredExecutable<Muscle> confMuscle = init(sequences);\r
 109                 confMuscle.addParameters(preset.getOptions());\r
 110                 Limit<Muscle> limit = getLimit(preset.getName());\r
 111                 return WSUtil.align(sequences, confMuscle, null, "presetAlign", limit);\r
 112         }\r
 113 \r
 114         @SuppressWarnings("unchecked")\r
 115         @Override\r
 116         public Alignment getResult(String jobId) throws ResultNotAvailableException {\r
 117                 WSUtil.validateJobId(jobId);\r
 118                 AsyncExecutor asyncEngine = Configurator.getAsyncEngine(jobId);\r
 119                 ConfiguredExecutable<Muscle> muscle = (ConfiguredExecutable<Muscle>) asyncEngine\r
 120                                 .getResults(jobId);\r
 121                 Alignment al = muscle.getResults();\r
 122                 // log(jobId, "getResults");\r
 123                 return al;\r
 124         }\r
 125 \r
 126         @Override\r
 127         public Limit<Muscle> getLimit(String presetName) {\r
 128                 if (limitMan == null) {\r
 129                         // No limit is configured\r
 130                         return null;\r
 131                 }\r
 132                 return limitMan.getLimitByName(presetName);\r
 133         }\r
 134 \r
 135         @Override\r
 136         public LimitsManager<Muscle> getLimits() {\r
 137                 return limitMan;\r
 138         }\r
 139 \r
 140         @Override\r
 141         public ChunkHolder pullExecStatistics(String jobId, long position) {\r
 142                 WSUtil.validateJobId(jobId);\r
 143                 String file = Configurator.getWorkDirectory(jobId) + File.separator\r
 144                                 + Muscle.getStatFile();\r
 145                 return WSUtil.pullFile(file, position);\r
 146         }\r
 147 \r
 148         @Override\r
 149         public boolean cancelJob(String jobId) {\r
 150                 WSUtil.validateJobId(jobId);\r
 151                 return WSUtil.cancelJob(jobId);\r
 152         }\r
 153 \r
 154         @Override\r
 155         public JobStatus getJobStatus(String jobId) {\r
 156                 WSUtil.validateJobId(jobId);\r
 157                 return WSUtil.getJobStatus(jobId);\r
 158         }\r
 159 \r
 160         @Override\r
 161         public PresetManager<Muscle> getPresets() {\r
 162                 return musclePresets;\r
 163         }\r
 164 \r
 165         @Override\r
 166         public RunnerConfig<Muscle> getRunnerOptions() {\r
 167                 return muscleOptions;\r
 168         }\r
 169 \r
 170 }\r