1 package jalview.ws.slivkaws;
3 import jalview.datamodel.SequenceI;
4 import jalview.gui.WebserviceInfo;
5 import jalview.io.FileFormat;
6 import jalview.io.FormatAdapter;
7 import jalview.ws.api.JalviewServiceEndpointProviderI;
8 import jalview.ws.api.JalviewWebServiceI;
9 import jalview.ws.api.JobId;
10 import jalview.ws.api.ServiceWithParameters;
11 import jalview.ws.gui.WsJob;
12 import jalview.ws.params.ArgumentI;
13 import jalview.ws.params.ParamDatastoreI;
14 import jalview.ws.params.ParamManager;
15 import jalview.ws.params.WsParamSetI;
17 import java.io.ByteArrayInputStream;
18 import java.io.IOError;
19 import java.io.IOException;
20 import java.io.InputStream;
21 import java.io.InputStreamReader;
22 import java.util.Arrays;
23 import java.util.EnumMap;
24 import java.util.HashSet;
25 import java.util.List;
26 import java.util.Optional;
29 import uk.ac.dundee.compbio.slivkaclient.FieldType;
30 import uk.ac.dundee.compbio.slivkaclient.FileField;
31 import uk.ac.dundee.compbio.slivkaclient.FormField;
32 import uk.ac.dundee.compbio.slivkaclient.FormValidationException;
33 import uk.ac.dundee.compbio.slivkaclient.JobState;
34 import uk.ac.dundee.compbio.slivkaclient.RemoteFile;
35 import uk.ac.dundee.compbio.slivkaclient.SlivkaClient;
36 import uk.ac.dundee.compbio.slivkaclient.SlivkaForm;
37 import uk.ac.dundee.compbio.slivkaclient.SlivkaService;
38 import uk.ac.dundee.compbio.slivkaclient.ValidationException;
40 public abstract class SlivkaWSInstance extends ServiceWithParameters
41 implements JalviewServiceEndpointProviderI, JalviewWebServiceI
43 protected final SlivkaClient client;
45 protected final SlivkaService service;
47 protected SlivkaDatastore store = null;
49 protected static final EnumMap<JobState, WsJob.JobState> stateMap = new EnumMap<>(JobState.class);
51 stateMap.put(JobState.PENDING, WsJob.JobState.QUEUED);
52 stateMap.put(JobState.REJECTED, WsJob.JobState.INVALID);
53 stateMap.put(JobState.ACCEPTED, WsJob.JobState.QUEUED);
54 stateMap.put(JobState.QUEUED, WsJob.JobState.QUEUED);
55 stateMap.put(JobState.RUNNING, WsJob.JobState.RUNNING);
56 stateMap.put(JobState.COMPLETED, WsJob.JobState.FINISHED);
57 stateMap.put(JobState.INTERRUPED, WsJob.JobState.CANCELLED);
58 stateMap.put(JobState.DELETED, WsJob.JobState.CANCELLED);
59 stateMap.put(JobState.FAILED, WsJob.JobState.FAILED);
60 stateMap.put(JobState.ERROR, WsJob.JobState.SERVERERROR);
61 stateMap.put(JobState.UNKNOWN, WsJob.JobState.UNKNOWN);
63 protected final Set<WsJob.JobState> failedStates = new HashSet<>(Arrays.asList(
64 WsJob.JobState.INVALID, WsJob.JobState.BROKEN, WsJob.JobState.FAILED,
65 WsJob.JobState.SERVERERROR, WsJob.JobState.CANCELLED
68 public SlivkaWSInstance(SlivkaClient client, SlivkaService service, String action)
70 super(service.getName(), action, service.getLabel(), "Slivka", client.getUrl().toString());
72 this.service = service;
75 protected final JobId submit(List<SequenceI> sequences,
76 WsParamSetI preset, List<ArgumentI> args) throws Throwable
78 SlivkaForm form = service.getForm();
79 for (FormField field : form.getFields())
81 if (field.getType() == FieldType.FILE)
83 FormatAdapter fa = new FormatAdapter();
84 fa.setNewlineString("\r\n");
85 FileField fileField = (FileField) field;
87 switch (fileField.getMediaType())
89 case "application/pfam":
90 format = FileFormat.Pfam;
92 case "application/stockholm":
93 format = FileFormat.Stockholm;
96 case "application/fasta":
97 format = FileFormat.Fasta;
100 InputStream stream = new ByteArrayInputStream(
101 fa.formatSequences(format, sequences.toArray(new SequenceI[0]))
103 RemoteFile rf = client.uploadFile(stream, "input",
104 fileField.getMediaType());
105 form.insert(field.getName(), rf);
110 for (ArgumentI arg : args)
112 // multiple choice field names are name$number to avoid duplications
113 // the number is stripped here
114 String fieldName = arg.getName().split("\\$", 2)[0];
115 FormField field = form.getField(fieldName);
116 if (field.getType() == FieldType.BOOLEAN)
118 form.insert(fieldName,
119 (arg.getValue() != null && !arg.getValue().isBlank())
125 form.insert(fieldName, field.valueOf(arg.getValue()));
129 return new JobId(service.getName(), service.getName(), form.submit());
133 public final void updateStatus(WsJob job)
137 job.setState(stateMap.get(client.getJobState(job.getJobId())));
138 } catch (IOException e)
140 throw new IOError(e);
145 public final boolean updateJobProgress(WsJob job) throws IOException
147 List<RemoteFile> files = client.getJobResults(job.getJobId());
148 Optional<RemoteFile> logFile = files.stream()
149 .filter(f -> f.getLabel().equals("log")).findFirst();
150 boolean newContent = false;
151 if (logFile.isPresent())
153 InputStream stream = logFile.get().getContent();
154 long nextChunk = stream.skip(job.getNextChunk());
155 int len = appendJobStatus(job, stream);
156 job.setnextChunk(nextChunk + len);
157 newContent |= len > 0;
159 if (failedStates.contains(job.getJobState()))
161 Optional<RemoteFile> errLogFile = files.stream()
162 .filter(f -> f.getLabel().equals("error-log")).findFirst();
163 if (errLogFile.isPresent())
165 newContent |= appendJobStatus(job, errLogFile.get().getContent()) > 0;
171 private int appendJobStatus(WsJob job, InputStream stream) throws IOException
173 StringBuilder builder = new StringBuilder(job.getStatus());
174 InputStreamReader reader = new InputStreamReader(stream);
175 char[] buffer = new char[4096];
178 while ((len = reader.read(buffer)) != -1)
181 builder.append(buffer, 0, len);
183 job.setStatus(builder.toString());
188 public final boolean handleSubmitError(Throwable _lex, WsJob j, WebserviceInfo wsInfo)
190 if (_lex instanceof FormValidationException)
192 FormValidationException formError = (FormValidationException) _lex;
193 String[] messages = new String[formError.getErrors().size()];
195 for (ValidationException e : formError.getErrors())
197 messages[i++] = String.format("%s: %s,", e.getField().getName(), e.getMessage());
199 j.setState(WsJob.JobState.INVALID);
200 j.setStatus(String.join(", ", messages));
207 public final boolean handleCollectionException(Exception e, WsJob msjob, WebserviceInfo wsInfo)
213 final SlivkaService getService()
219 public final Object getEndpoint()
225 public final void initParamStore(ParamManager userParameterStore)
231 store = new SlivkaDatastore(service);
232 } catch (IOException e)
234 throw new IOError(e);
240 public boolean hasParameters()
246 public final ParamDatastoreI getParamStore()
250 initParamStore(null);