FileUploadJob.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License
 * at:
 *
 *   http://opensource.org/licenses/ecl2.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 */

package org.opencastproject.fileupload.api.job;

import org.opencastproject.mediapackage.MediaPackage;
import org.opencastproject.mediapackage.MediaPackageElementFlavor;

import java.util.UUID;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlEnum;
import javax.xml.bind.annotation.XmlEnumValue;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

/**
 * A Class representing the information about an upload job.
 *
 */
@XmlType(name = "uploadjob", namespace = "http://fileupload.opencastproject.org")
@XmlRootElement(name = "uploadjob", namespace = "http://fileupload.opencastproject.org")
@XmlAccessorType(XmlAccessType.NONE)
public class FileUploadJob {

  @XmlEnum
  public enum JobState { // states an upload job can be in
    @XmlEnumValue("READY")
    READY, @XmlEnumValue("INPROGRESS")
    INPROGRESS, @XmlEnumValue("FINALIZING")
    FINALIZING, @XmlEnumValue("COMPLETE")
    COMPLETE
  }

  @XmlAttribute()
  private String id; // this jobs identifier
  @XmlAttribute()
  private JobState state = JobState.READY; // this jobs state
  private long modified;  // time of last modification
  @XmlElement(name = "payload")
  private Payload payload; // information about this jobs payload
  @XmlElement(name = "chunksize")
  private int chunksize = -1; // size of the chunks that are tranfered
  @XmlElement(name = "chunks-total")
  private long chunksTotal = 1; // total number of chunks the upload consists of
  @XmlElement(name = "current-chunk")
  private Chunk currentChunk = new Chunk(); // information about the current chunk

  public FileUploadJob() {
    this.id = UUID.randomUUID().toString();
    this.modified = System.currentTimeMillis();
    this.payload = new Payload("unknown", -1, null, null);
  }

  public FileUploadJob(String filename, long filesize, int chunksize, MediaPackage mp, MediaPackageElementFlavor flavor) {
    this.id = UUID.randomUUID().toString();
    this.modified = System.currentTimeMillis();
    this.chunksize = chunksize;
    if (chunksize == -1) {           // indicates ordinary HTTP upload
      chunksTotal = 1;               // ..so we have only one chunk
    } else {                         // chunked upload
      chunksTotal = filesize / chunksize;  // compute number of chunks
      if (filesize % chunksize != 0) {     // if file size is not a multiple of chunk size
        chunksTotal++;                     // ..add one chunk for the rest
      }
    }
    this.payload = new Payload(filename, filesize, mp, flavor);
  }

  public String getId() {
    return id;
  }

  public synchronized JobState getState() {
    return this.state;
  }

  public synchronized void setState(JobState state) {
    setLastModified(System.currentTimeMillis());
    this.state = state;
  }

  public void setLastModified(long time) {
    this.modified = time;
  }

  public long lastModified() {
    return this.modified;
  }

  public Payload getPayload() {
    return this.payload;
  }

  public int getChunksize() {
    return chunksize;
  }

  public long getChunksTotal() {
    return chunksTotal;
  }

  public Chunk getCurrentChunk() {
    return currentChunk;
  }

  public void setCurrentChunk(Chunk currentChunk) {
    setLastModified(System.currentTimeMillis());
    this.currentChunk = currentChunk;
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder().append("FileUploadJob(id=").append(this.id).append(", filename=")
            .append(this.payload.getFilename()).append(")");
    return sb.toString();
  }
}