package jalview.ws.slivkaws;
-import jalview.datamodel.AlignmentI;
import jalview.datamodel.SequenceI;
import jalview.gui.WebserviceInfo;
-import jalview.io.DataSourceType;
import jalview.io.FileFormat;
import jalview.io.FormatAdapter;
import jalview.ws.api.JalviewServiceEndpointProviderI;
+import jalview.ws.api.JalviewWebServiceI;
import jalview.ws.api.JobId;
-import jalview.ws.api.MultipleSequenceAlignmentI;
import jalview.ws.api.ServiceWithParameters;
import jalview.ws.gui.WsJob;
import jalview.ws.params.ArgumentI;
-import jalview.ws.params.InvalidArgumentException;
import jalview.ws.params.ParamDatastoreI;
import jalview.ws.params.ParamManager;
import jalview.ws.params.WsParamSetI;
+import javajs.http.ClientProtocolException;
import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
import java.io.IOError;
import java.io.IOException;
import java.io.InputStream;
-import java.rmi.ServerError;
+import java.util.Arrays;
+import java.util.Collection;
import java.util.EnumMap;
-import java.util.HashMap;
+import java.util.HashSet;
import java.util.List;
+import java.util.Set;
-import uk.ac.dundee.compbio.slivkaclient.FormField;
-import uk.ac.dundee.compbio.slivkaclient.FormValidationException;
-import uk.ac.dundee.compbio.slivkaclient.JobState;
+import uk.ac.dundee.compbio.slivkaclient.Job;
+import uk.ac.dundee.compbio.slivkaclient.JobRequest;
+import uk.ac.dundee.compbio.slivkaclient.Parameter;
import uk.ac.dundee.compbio.slivkaclient.RemoteFile;
import uk.ac.dundee.compbio.slivkaclient.SlivkaClient;
-import uk.ac.dundee.compbio.slivkaclient.SlivkaForm;
import uk.ac.dundee.compbio.slivkaclient.SlivkaService;
-import uk.ac.dundee.compbio.slivkaclient.ValidationException;
-public class SlivkaWSInstance extends ServiceWithParameters
- implements MultipleSequenceAlignmentI, JalviewServiceEndpointProviderI
+public abstract class SlivkaWSInstance extends ServiceWithParameters
+ implements JalviewServiceEndpointProviderI, JalviewWebServiceI
{
- private SlivkaClient client;
- private SlivkaService service;
- private SlivkaDatastore store = null;
+ protected final SlivkaClient client;
- private EnumMap<JobState, WsJob.JobState> stateMap = new EnumMap<>(JobState.class);
+ protected final SlivkaService service;
+
+ protected SlivkaDatastore store = null;
+
+ protected static final EnumMap<Job.Status, WsJob.JobState> stateMap = new EnumMap<>(Job.Status.class);
{
- stateMap.put(JobState.PENDING, WsJob.JobState.QUEUED);
- stateMap.put(JobState.QUEUED, WsJob.JobState.QUEUED);
- stateMap.put(JobState.RUNNING, WsJob.JobState.RUNNING);
- stateMap.put(JobState.COMPLETED, WsJob.JobState.FINISHED);
- stateMap.put(JobState.FAILED, WsJob.JobState.FAILED);
- stateMap.put(JobState.ERROR, WsJob.JobState.SERVERERROR);
- stateMap.put(JobState.UNKNOWN, WsJob.JobState.UNKNOWN);
+ stateMap.put(Job.Status.PENDING, WsJob.JobState.QUEUED);
+ stateMap.put(Job.Status.REJECTED, WsJob.JobState.INVALID);
+ stateMap.put(Job.Status.ACCEPTED, WsJob.JobState.QUEUED);
+ stateMap.put(Job.Status.QUEUED, WsJob.JobState.QUEUED);
+ stateMap.put(Job.Status.RUNNING, WsJob.JobState.RUNNING);
+ stateMap.put(Job.Status.COMPLETED, WsJob.JobState.FINISHED);
+ stateMap.put(Job.Status.INTERRUPTED, WsJob.JobState.CANCELLED);
+ stateMap.put(Job.Status.DELETED, WsJob.JobState.CANCELLED);
+ stateMap.put(Job.Status.FAILED, WsJob.JobState.FAILED);
+ stateMap.put(Job.Status.ERROR, WsJob.JobState.SERVERERROR);
+ stateMap.put(Job.Status.UNKNOWN, WsJob.JobState.UNKNOWN);
}
+ protected final Set<WsJob.JobState> failedStates = new HashSet<>(Arrays.asList(
+ WsJob.JobState.INVALID, WsJob.JobState.BROKEN, WsJob.JobState.FAILED,
+ WsJob.JobState.SERVERERROR, WsJob.JobState.CANCELLED
+ ));
- SlivkaWSInstance(SlivkaClient client, SlivkaService service) {
- super(service.getName(), "Alignment", service.getName(), "Slivka", client.getUrl().toString());
+ public SlivkaWSInstance(SlivkaClient client, SlivkaService service, String action)
+ {
+ super(action, action, service.getName(), "Slivka", client.getUrl().toString());
this.client = client;
this.service = service;
}
- @Override
- public void updateStatus(WsJob job)
+ protected final JobId submit(List<SequenceI> sequences,
+ WsParamSetI preset, List<ArgumentI> args) throws Throwable
{
- try
+ var parameters = service.getParameters();
+ var request = new JobRequest();
+ for (Parameter param : parameters)
{
- job.setState(stateMap.get(client.getJobState(job.getJobId())));
- } catch (IOException e)
- {
- throw new RuntimeException(e);
+ if (param instanceof Parameter.FileParameter)
+ {
+ FormatAdapter fa = new FormatAdapter();
+ fa.setNewlineString("\r\n");
+ Parameter.FileParameter fileParam = (Parameter.FileParameter) param;
+ FileFormat format;
+ switch (fileParam.getMediaType())
+ {
+ case "application/pfam":
+ format = FileFormat.Pfam;
+ break;
+ case "application/stockholm":
+ format = FileFormat.Stockholm;
+ break;
+ default:
+ case "application/fasta":
+ format = FileFormat.Fasta;
+ break;
+ }
+
+ // we avoid any use of Jalview's user facing export routines here
+
+ InputStream stream = new ByteArrayInputStream(format.getWriter(null)
+ .print(sequences.toArray(new SequenceI[0]), false)
+ .getBytes());
+ request.addFile(param.getId(), stream);
+ }
}
- }
-
- SlivkaService getService()
- {
- return service;
- }
-
- @Override
- public boolean updateJobProgress(WsJob job)
- {
- return false;
- }
-
- @Override
- public boolean handleSubmitError(Throwable _lex, WsJob j, WebserviceInfo wsInfo)
- {
- if (_lex instanceof FormValidationException)
+ if (args != null)
{
- FormValidationException formError = (FormValidationException) _lex;
- String[] messages = new String[formError.getErrors().size()];
- int i = 0;
- for (ValidationException e : formError.getErrors())
+ for (ArgumentI arg : args)
{
- messages[i++] = String.format("%s: %s,", e.getField().getName(), e.getMessage());
+ // multiple choice field names are name$number to avoid duplications
+ // the number is stripped here
+ String paramId = arg.getName().split("\\$", 2)[0];
+ Parameter param = service.getParameter(paramId);
+ if (param instanceof Parameter.FlagParameter) {
+ if (arg.getValue() != null && !arg.getValue().isBlank())
+ request.addData(paramId, true);
+ else
+ request.addData(paramId, false);
+ }
+ else
+ {
+ request.addData(paramId, arg.getValue());
+ }
}
- j.setState(WsJob.JobState.INVALID);
- j.setStatus(String.join(", ", messages));
- return true;
}
- return false;
+ var job = service.submitJob(request);
+ return new JobId(service.getName(), service.getName(), job.getId());
}
@Override
- public boolean handleCollectionException(Exception e, WsJob msjob, WebserviceInfo wsInfo)
+ public final void updateStatus(WsJob job)
{
- return false;
+ try
+ {
+ var slivkaJob = client.getJob(job.getJobId());
+ job.setState(stateMap.get(slivkaJob.getStatus()));
+ } catch (IOException e)
+ {
+ throw new IOError(e);
+ }
}
@Override
- public JobId align(List<SequenceI> toalign, WsParamSetI parameters, List<ArgumentI> list) throws Throwable
- {
- StringBuilder builder = new StringBuilder();
- for (SequenceI seq : toalign)
+ public final boolean updateJobProgress(WsJob job) throws IOException
+ {
+ var slivkaJob = client.getJob(job.getJobId());
+ Collection<RemoteFile> files = slivkaJob.getResults();
+ RemoteFile logFile=null;
+ for (RemoteFile f : files)
{
- builder.append(">").append(seq.getName()).append("\n");
- builder.append(seq.getSequence()).append("\n");
- }
- InputStream stream = new ByteArrayInputStream(builder.toString().getBytes());
- RemoteFile file = client.uploadFile(stream, "input.fasta", "application/fasta");
- SlivkaForm form = service.getForm();
- HashMap<String, String> values = new HashMap<>(list != null ? list.size() : 0);
- if (list != null)
- {
- for (ArgumentI arg : list)
+ if (f.getLabel().equals("log"))
{
- values.put(arg.getName(), arg.getValue());
+ logFile = f; break;
}
}
- for (FormField field : form.getFields())
+
+ boolean newContent = false;
+ if (logFile!=null)
{
- switch (field.getType()) {
- case FILE:
- form.insert(field.getName(), file);
- break;
- case BOOLEAN:
- String value = values.get(field.getName());
- form.insert(field.getName(), (value != null && !value.isBlank()) ? true : false);
- break;
- default:
- form.insert(field.getName(), field.valueOf(values.get(field.getName())));
+ ByteArrayOutputStream output = new ByteArrayOutputStream();
+ logFile.writeTo(output);
+ if (output.size() > job.getNextChunk())
+ {
+ newContent = true;
+ job.setStatus(output.toString("UTF-8"));
+ job.setnextChunk(output.size());
}
}
- return new JobId(service.getName(), service.getName(), form.submit());
- }
-
- @Override
- public AlignmentI getAlignmentFor(JobId jobId) throws InvalidArgumentException, ServerError, IOError
- {
- List<RemoteFile> files;
- try
+ if (failedStates.contains(job.getJobState()))
{
- files = client.getJobResults(jobId.getJobId());
+
+ RemoteFile errLogFile = null;
for (RemoteFile f : files)
{
- if (f.getMimeType().equals("application/clustal"))
+ if (f.getLabel().equals("error-log"))
{
- return new FormatAdapter().readFile(f.getURL().toString(), DataSourceType.URL, FileFormat.Clustal);
+ errLogFile = f;
+ break;
}
}
- } catch (IOException e)
+
+ if (errLogFile!=null)
+ {
+ ByteArrayOutputStream output = new ByteArrayOutputStream();
+ errLogFile.writeTo(output);
+ if (output.size() > 0)
+ {
+ newContent = true;
+ job.setStatus(job.getStatus() + "\n" + output.toString("UTF-8"));
+ }
+ }
+ }
+ return newContent;
+ }
+
+ @Override
+ public final boolean handleSubmitError(Throwable _lex, WsJob j, WebserviceInfo wsInfo)
+ {
+ if (_lex instanceof ClientProtocolException)
{
- throw new IOError(e);
+ j.setState(WsJob.JobState.INVALID);
+ j.setStatus(_lex.getMessage());
+ return true;
}
- return null;
+ return false;
+ }
+
+ @Override
+ public final boolean handleCollectionException(Exception e, WsJob msjob, WebserviceInfo wsInfo)
+ {
+ // TODO
+ return false;
+ }
+
+ final SlivkaService getService()
+ {
+ return service;
}
@Override
- public Object getEndpoint()
+ public final Object getEndpoint()
{
return this;
}
@Override
- public void initParamStore(ParamManager userParameterStore)
+ public final void initParamStore(ParamManager userParameterStore)
{
if (store == null)
{
}
@Override
- public ParamDatastoreI getParamStore()
+ public final ParamDatastoreI getParamStore()
{
+ if (store == null)
+ {
+ initParamStore(null);
+ }
return store;
}
+
}
git://source.jalview.org / jalview.git / blobdiff