webservices/compbio/ws/server/AAConWS.java

   1 package compbio.ws.server;\r
   2 \r
   3 import java.io.File;\r
   4 import java.util.Arrays;\r
   5 import java.util.HashSet;\r
   6 import java.util.List;\r
   7 \r
   8 import javax.annotation.Resource;\r
   9 import javax.jws.WebService;\r
  10 import javax.xml.ws.WebServiceContext;\r
  11 \r
  12 import org.apache.log4j.Logger;\r
  13 \r
  14 import compbio.data.msa.SequenceAnnotation;\r
  15 import compbio.data.sequence.FastaSequence;\r
  16 import compbio.data.sequence.Score;\r
  17 import compbio.data.sequence.ScoreManager;\r
  18 import compbio.engine.AsyncExecutor;\r
  19 import compbio.engine.Configurator;\r
  20 import compbio.engine.client.ConfiguredExecutable;\r
  21 import compbio.metadata.ChunkHolder;\r
  22 import compbio.metadata.JobStatus;\r
  23 import compbio.metadata.JobSubmissionException;\r
  24 import compbio.metadata.Limit;\r
  25 import compbio.metadata.LimitExceededException;\r
  26 import compbio.metadata.LimitsManager;\r
  27 import compbio.metadata.Option;\r
  28 import compbio.metadata.Preset;\r
  29 import compbio.metadata.PresetManager;\r
  30 import compbio.metadata.ResultNotAvailableException;\r
  31 import compbio.metadata.RunnerConfig;\r
  32 import compbio.metadata.UnsupportedRuntimeException;\r
  33 import compbio.metadata.WrongParameterException;\r
  34 import compbio.runner.Util;\r
  35 import compbio.runner.conservation.AACon;\r
  36 \r
  37 @WebService(endpointInterface = "compbio.data.msa.SequenceAnnotation", targetNamespace = "http://msa.data.compbio/01/12/2010/", serviceName = "AAConWS")\r
  38 public class AAConWS implements SequenceAnnotation<AACon> {\r
  39 \r
  40         // Ask for resource injection\r
  41         @Resource\r
  42         WebServiceContext wsContext;\r
  43 \r
  44         private static Logger statLog = Logger.getLogger("AAConWS-stats");\r
  45 \r
  46         private static Logger log = Logger.getLogger(AAConWS.class);\r
  47 \r
  48         private static final RunnerConfig<AACon> aaconOptions = Util\r
  49                         .getSupportedOptions(AACon.class);\r
  50 \r
  51         private static final PresetManager<AACon> aaconPresets = Util\r
  52                         .getPresets(AACon.class);\r
  53 \r
  54         private static final LimitsManager<AACon> limitMan = compbio.engine.client.Util\r
  55                         .getLimits(new AACon().getType());\r
  56 \r
  57         ConfiguredExecutable<AACon> init(List<FastaSequence> sequences)\r
  58                         throws JobSubmissionException {\r
  59                 AACon aacon = new AACon();\r
  60                 return Configurator.configureExecutable(aacon, sequences);\r
  61         }\r
  62 \r
  63         @Override\r
  64         public ScoreManager getAnnotation(String jobId)\r
  65                         throws ResultNotAvailableException {\r
  66                 WSUtil.validateJobId(jobId);\r
  67                 AsyncExecutor asyncEngine = Configurator.getAsyncEngine(jobId);\r
  68                 ConfiguredExecutable<AACon> aacon = (ConfiguredExecutable<AACon>) asyncEngine\r
  69                                 .getResults(jobId);\r
  70                 HashSet<Score> mas = aacon.getResults();\r
  71                 // ScoreManager result = new HashMap<String, HashSet<Score>>();\r
  72                 // result.put("Alignment", mas);\r
  73                 log.trace(jobId + " getConservation : " + mas);\r
  74                 // FIXME\r
  75                 return null;\r
  76         }\r
  77         /*\r
  78          * @SuppressWarnings("unchecked") public JalviewAnnotation\r
  79          * getJalviewAnnotation(String jobId) throws ResultNotAvailableException {\r
  80          * MultiAnnotatedSequence<Method> result = getResult(jobId); // TODO //\r
  81          * log(jobId, "getResults"); return result.toJalviewAnnotation(); }\r
  82          */\r
  83 \r
  84         @Override\r
  85         public Limit<AACon> getLimit(String presetName) {\r
  86                 if (limitMan == null) {\r
  87                         // Limit is not defined\r
  88                         return null;\r
  89                 }\r
  90                 return limitMan.getLimitByName(presetName);\r
  91         }\r
  92 \r
  93         @Override\r
  94         public LimitsManager<AACon> getLimits() {\r
  95                 return limitMan;\r
  96         }\r
  97 \r
  98         @Override\r
  99         public ChunkHolder pullExecStatistics(String jobId, long position) {\r
 100                 WSUtil.validateJobId(jobId);\r
 101                 String file = Configurator.getWorkDirectory(jobId) + File.separator\r
 102                                 + AACon.getStatFile();\r
 103                 return WSUtil.pullFile(file, position);\r
 104         }\r
 105 \r
 106         @Override\r
 107         public boolean cancelJob(String jobId) {\r
 108                 WSUtil.validateJobId(jobId);\r
 109                 return WSUtil.cancelJob(jobId);\r
 110         }\r
 111 \r
 112         @Override\r
 113         public JobStatus getJobStatus(String jobId) {\r
 114                 WSUtil.validateJobId(jobId);\r
 115                 return WSUtil.getJobStatus(jobId);\r
 116         }\r
 117 \r
 118         @Override\r
 119         public PresetManager<AACon> getPresets() {\r
 120                 return aaconPresets;\r
 121         }\r
 122 \r
 123         @Override\r
 124         public RunnerConfig<AACon> getRunnerOptions() {\r
 125                 return aaconOptions;\r
 126         }\r
 127 \r
 128         String analize(List<FastaSequence> sequences,\r
 129                         ConfiguredExecutable<AACon> confExec, Logger log, String method,\r
 130                         Limit<AACon> limit) throws JobSubmissionException {\r
 131                 if (limit != null && limit.isExceeded(sequences)) {\r
 132                         throw LimitExceededException.newLimitExceeded(limit, sequences);\r
 133                 }\r
 134 \r
 135                 compbio.runner.Util.writeInput(sequences, confExec);\r
 136                 AsyncExecutor engine = Configurator.getAsyncEngine(confExec);\r
 137                 String jobId = engine.submitJob(confExec);\r
 138                 return jobId;\r
 139         }\r
 140 \r
 141         @Override\r
 142         public String analize(List<FastaSequence> sequences)\r
 143                         throws UnsupportedRuntimeException, LimitExceededException,\r
 144                         JobSubmissionException {\r
 145                 WSUtil.validateFastaInput(sequences);\r
 146                 ConfiguredExecutable<AACon> confAAcon = init(sequences);\r
 147 \r
 148                 // set default conservation method to fastest - SHENKIN\r
 149                 // TODO: This violates encapsulation, should be moved to the runners\r
 150                 // level.\r
 151                 confAAcon.addParameters(Arrays.asList("-m=SHENKIN"));\r
 152                 return analize(sequences, confAAcon, null, "analize", getLimit(""));\r
 153         }\r
 154 \r
 155         @Override\r
 156         public String customAnalize(List<FastaSequence> sequences,\r
 157                         List<Option<AACon>> options) throws UnsupportedRuntimeException,\r
 158                         LimitExceededException, JobSubmissionException,\r
 159                         WrongParameterException {\r
 160                 WSUtil.validateFastaInput(sequences);\r
 161                 ConfiguredExecutable<AACon> confAACon = init(sequences);\r
 162                 // Could not do that! Space separated values\r
 163                 // will all be treated as keys! thus duplicates removed\r
 164                 // String params = cbuilder.getCommand();\r
 165                 List<String> params = WSUtil.getCommands(options,\r
 166                                 AACon.KEY_VALUE_SEPARATOR);\r
 167                 confAACon.addParameters(params);\r
 168                 return analize(sequences, confAACon, null, "customAnalize",\r
 169                                 getLimit(""));\r
 170         }\r
 171 \r
 172         @Override\r
 173         public String presetAnalize(List<FastaSequence> sequences,\r
 174                         Preset<AACon> preset) throws UnsupportedRuntimeException,\r
 175                         LimitExceededException, JobSubmissionException,\r
 176                         WrongParameterException {\r
 177                 WSUtil.validateFastaInput(sequences);\r
 178                 if (preset == null) {\r
 179                         throw new WrongParameterException("Preset must be provided!");\r
 180                 }\r
 181                 ConfiguredExecutable<AACon> confAAcon = init(sequences);\r
 182                 confAAcon.addParameters(preset.getOptions());\r
 183                 Limit<AACon> limit = getLimit(preset.getName());\r
 184                 return WSUtil.align(sequences, confAAcon, null, "presetAnalize", limit);\r
 185         }\r
 186 \r
 187 }\r