src/jalview/ws2/WSJob.java

   1 package jalview.ws2;
   2
   3 import java.io.Serializable;
   4 import java.net.URI;
   5 import java.util.Date;
   6
   7 import jalview.util.MathUtils;
   8
   9 import static java.lang.String.format;
  10
  11 import java.beans.PropertyChangeListener;
  12 import java.beans.PropertyChangeSupport;
  13
  14 /**
  15  * An id handler to the external job running on the server. This is the smallest
  16  * job unit which might me a part of a larger multi-stage or parallel task
  17  * handled by the WebServiceWorker. Jobs are created by the JalviewWebService on
  18  * job submission and are used to identify that job during its lifetime. It can
  19  * be serialized and used between application launches.
  20  *
  21  * @author mmwarowny
  22  *
  23  */
  24 public final class WSJob implements Serializable
  25 {
  26   private static final long serialVersionUID = -4600214977954333787L;
  27
  28   /* Client-side identifier */
  29   public final long uid = MathUtils.getUID();
  30
  31   private int jobNum = 0;
  32
  33   /* Shortened server name e.g. "slivka" or "jabaws" */
  34   private String serviceProvider = "";
  35
  36   /* Name of the service e.g. "ClustalW2" */
  37   private String serviceName = "";
  38
  39   /* Server-side identifier */
  40   private String jobId = "";
  41
  42   private WSJobStatus status = WSJobStatus.UNKNOWN;
  43
  44   private String log = "";
  45
  46   private String errorLog = "";
  47
  48   /* Base url of the server associated with the job */
  49   private String hostName = "";
  50
  51   private Date creationTime = new Date();
  52
  53   public PropertyChangeSupport pcs = new PropertyChangeSupport(this);
  54
  55   public WSJob()
  56   {
  57   }
  58
  59   public WSJob(String serviceProvider, String serviceName, String hostName)
  60   {
  61     this.serviceProvider = serviceProvider;
  62     this.serviceName = serviceName;
  63     this.hostName = hostName;
  64   }
  65
  66   @Override
  67   public String toString()
  68   {
  69     return format("%s:%s [%s] Created %s", serviceProvider, serviceName,
  70             jobId, creationTime);
  71   }
  72
  73   public int getJobNum()
  74   {
  75     return jobNum;
  76   }
  77
  78   public void setJobNum(int jobNum)
  79   {
  80     this.jobNum = jobNum;
  81   }
  82
  83   public WSJobStatus getStatus()
  84   {
  85     return status;
  86   }
  87
  88   public void setStatus(WSJobStatus status)
  89   {
  90     var oldStatus = this.status;
  91     this.status = status;
  92     pcs.firePropertyChange("status", oldStatus, status);
  93   }
  94
  95   public String getLog()
  96   {
  97     return log;
  98   }
  99
 100   public void setLog(String log)
 101   {
 102     var oldLog = this.log;
 103     this.log = log;
 104     pcs.firePropertyChange("log", oldLog, log);
 105   }
 106
 107   public String getErrorLog()
 108   {
 109     return errorLog;
 110   }
 111
 112   public void setErrorLog(String log)
 113   {
 114     String oldErrorLog = this.errorLog;
 115     this.errorLog = log;
 116     pcs.firePropertyChange("errorLog", oldErrorLog, this.errorLog);
 117   }
 118
 119   public long getUid()
 120   {
 121     return uid;
 122   }
 123
 124   public String getServiceProvider()
 125   {
 126     return serviceProvider;
 127   }
 128
 129   public void setServiceProvider(String serviceProvider)
 130   {
 131     this.serviceProvider = serviceProvider;
 132   }
 133
 134   public String getServiceName()
 135   {
 136     return serviceName;
 137   }
 138
 139   public void setServiceName(String serviceName)
 140   {
 141     this.serviceName = serviceName;
 142   }
 143
 144   public String getJobId()
 145   {
 146     return jobId;
 147   }
 148
 149   public void setJobId(String jobID)
 150   {
 151     this.jobId = jobID;
 152   }
 153
 154   public String getHostName()
 155   {
 156     return hostName;
 157   }
 158
 159   public void setHostName(String hostName)
 160   {
 161     this.hostName = hostName;
 162   }
 163
 164   public Date getCreationTime()
 165   {
 166     return creationTime;
 167   }
 168
 169   public void setCreationTime(Date creationTime)
 170   {
 171     this.creationTime = creationTime;
 172   }
 173
 174   public void addPropertyChangeListener(PropertyChangeListener listener)
 175   {
 176     pcs.addPropertyChangeListener(listener);
 177   }
 178
 179   public void addPropertyChangeListener(String propertyName,
 180           PropertyChangeListener listener)
 181   {
 182     pcs.addPropertyChangeListener(propertyName, listener);
 183   }
 184
 185   public void removePropertyChangeListener(PropertyChangeListener listener)
 186   {
 187     pcs.removePropertyChangeListener(listener);
 188   }
 189
 190   public void removePropertyChagneListener(String propertyName,
 191           PropertyChangeListener listener)
 192   {
 193     pcs.removePropertyChangeListener(propertyName, listener);
 194   }
 195 }