SnapshotDto.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.assetmanager.impl.persistence;

import static org.opencastproject.util.data.functions.Functions.chuck;

import org.opencastproject.assetmanager.api.Availability;
import org.opencastproject.assetmanager.api.Snapshot;
import org.opencastproject.assetmanager.impl.SnapshotImpl;
import org.opencastproject.assetmanager.impl.VersionImpl;
import org.opencastproject.mediapackage.MediaPackage;
import org.opencastproject.mediapackage.MediaPackageParser;

import java.util.Date;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Lob;
import javax.persistence.Table;
import javax.persistence.TableGenerator;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.UniqueConstraint;

/** JPA DTO. */
@Entity(name = "Snapshot")
@Table(name = "mh_assets_snapshot",
        uniqueConstraints = {@UniqueConstraint(columnNames = {"mediapackage_id", "version"})})
// Maintain own generator to support database migrations from Archive to AssetManager
// The generator's initial value has to be set after the data migration.
// Otherwise duplicate key errors will most likely happen.
@TableGenerator(name = "seq_mh_assets_snapshot", initialValue = 0, allocationSize = 50)
public class SnapshotDto {
  @Id
  @Column(name = "id")
  @GeneratedValue(strategy = GenerationType.TABLE, generator = "seq_mh_assets_snapshot")
  private Long id;

  @Column(name = "mediapackage_id", length = 128, nullable = false)
  private String mediaPackageId;

  @Column(name = "version", nullable = false)
  private Long version;

  @Column(name = "series_id", length = 128)
  private String seriesId;

  @Column(name = "organization_id", length = 128, nullable = false)
  private String organizationId;

  @Column(name = "archival_date", nullable = false)
  @Temporal(TemporalType.TIMESTAMP)
  private Date archivalDate;

  @Column(name = "availability", nullable = false)
  private String availability;

  @Column(name = "owner", nullable = false)
  private String owner;

  @Lob
  @Column(name = "mediapackage_xml", length = 65535, nullable = false)
  private String mediaPackageXml;

  public static SnapshotDto mk(
          MediaPackage mediaPackage,
          VersionImpl version,
          String organization,
          Date archivalDate,
          Availability availability,
          String owner) {
    try {
      final SnapshotDto dto = new SnapshotDto();
      dto.mediaPackageId = mediaPackage.getIdentifier().toString();
      dto.version = version.value();
      dto.seriesId = mediaPackage.getSeries();
      dto.organizationId = organization;
      dto.archivalDate = archivalDate;
      dto.mediaPackageXml = MediaPackageParser.getAsXml(mediaPackage);
      dto.availability = availability.name();
      dto.owner = owner;
      return dto;
    } catch (Exception e) {
      return chuck(e);
    }
  }

  public Long getId() {
    return Database.insidePersistenceContextCheck(id);
  }

  public VersionImpl getVersion() {
    return Conversions.toVersion(version);
  }

  public String getMediaPackageId() {
    return mediaPackageId;
  }

  public Snapshot toSnapshot() {
    return new SnapshotImpl(
            Conversions.toVersion(version),
            organizationId,
            archivalDate,
            Availability.valueOf(availability),
            owner,
            Conversions.toMediaPackage(mediaPackageXml));
  }
}