MediaPackageBuilder.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.mediapackage;

import org.opencastproject.mediapackage.identifier.Id;

import org.w3c.dom.Node;

import java.io.InputStream;

/**
 * A media package builder provides factory methods for the creation of media packages from manifest files, packages,
 * directories or from sratch.
 */
public interface MediaPackageBuilder {

  /**
   * Creates a new media package in the temporary directory defined by the java runtime property
   * <code>java.io.tmpdir</code>.
   *
   * @return the new media package
   * @throws MediaPackageException
   *           if creation of the new media package fails
   */
  MediaPackage createNew() throws MediaPackageException;

  /**
   * Creates a new media package in the temporary directory defined by the java runtime property
   * <code>java.io.tmpdir</code>.
   * <p>
   * The name of the media package root folder will be equal to the handle value.
   * </p>
   *
   * @param identifier
   *          the media package identifier
   * @return the new media package
   * @throws MediaPackageException
   *           if creation of the new media package fails
   */
  MediaPackage createNew(Id identifier) throws MediaPackageException;

  /**
   * Loads a media package from the manifest.
   *
   * @param is
   *          the media package manifest input stream
   * @return the media package
   * @throws MediaPackageException
   *           if loading of the media package fails
   */
  MediaPackage loadFromXml(InputStream is) throws MediaPackageException;

  /**
   * Loads a media package from the manifest.
   *
   * @param xml
   *          the media package manifest as an xml string
   * @return the media package
   * @throws MediaPackageException
   *           if loading of the media package fails
   */
  MediaPackage loadFromXml(String xml) throws MediaPackageException;

  /**
   * Loads a media package from the manifest.
   *
   * @param xml
   *          the media package manifest as an xml node
   * @return the media package
   * @throws MediaPackageException
   *           if loading of the media package fails
   */
  MediaPackage loadFromXml(Node xml) throws MediaPackageException;

  /**
   * Sets the media package serializer that is used to resolve urls and helps in serialization and deserialization of
   * media package elements.
   *
   * @param serializer
   *          the serializer
   */
  void setSerializer(MediaPackageSerializer serializer);

  /**
   * Returns the currently active serializer. The serializer is used to resolve urls and helps in serialization and
   * deserialization of media package elements.
   *
   * @return the serializer
   * @see #setSerializer(MediaPackageSerializer)
   */
  MediaPackageSerializer getSerializer();

}