Payload.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.net.URL;

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

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

  @XmlElement(name = "filename")
  private String filename; // name of the uploaded file
  @XmlElement(name = "totalsize")
  private long totalsize; // size of the file
  @XmlElement(name = "currentsize")
  private long currentsize; // number of bytes that have already been (successfully) recieved
  @XmlElement(name = "url")
  private URL url; // URL of the completely uploaded file
  @XmlElement(name = "mediapackage", namespace = "http://mediapackage.opencastproject.org")
  private MediaPackage mediapackage; // the mediapackage this UploadJob should belong to
  @XmlElement(name = "flavor")
  private MediaPackageElementFlavor flavor;

  public Payload() {
    this.filename = "unknown";
    this.totalsize = -1;
    this.currentsize = 0;
    this.mediapackage = null;
    this.flavor = null;
  }

  public Payload(String filename, long size, MediaPackage mp, MediaPackageElementFlavor flavor) {
    this.filename = filename;
    this.totalsize = size;
    this.currentsize = 0;
    this.mediapackage = mp;
    this.flavor = flavor;
  }

  public String getFilename() {
    return filename;
  }

  public long getTotalSize() {
    return totalsize;
  }

  public void setTotalSize(long totalsize) {
    this.totalsize = totalsize;
  }

  public long getCurrentSize() {
    return currentsize;
  }

  public void setCurrentSize(long size) {
    this.currentsize = size;
  }

  public MediaPackage getMediaPackage() {
    return this.mediapackage;
  }

  public void setMediaPackage(MediaPackage mp) {
    this.mediapackage = mp;
  }

  public MediaPackageElementFlavor getFlavor() {
    return this.flavor;
  }

  public void setFlavor(MediaPackageElementFlavor flavor) {
    this.flavor = flavor;
  }

  public URL getUrl() {
    return url;
  }

  public void setUrl(URL url) {
    this.url = url;
  }
}