org.opencastproject.mediapackage

Interface ManifestContributor

All Known Subinterfaces:

Attachment, AudioStream, Catalog, MediaPackageElement, Publication, Stream, Track, VideoStream

All Known Implementing Classes:

AbstractMediaPackageElement, AbstractStreamImpl, AttachmentImpl, AudioStreamImpl, CatalogImpl, PublicationImpl, TrackImpl, VideoStreamImpl, XMLCatalogImpl

public interface ManifestContributor

To be implemented by everyone who wishes to contribute to the media package manifest.

Method Summary

Modifier and Type	Method and Description
Node	toManifest(Document document, MediaPackageSerializer serializer) This method returns an XML serialization of the object to be stored in the media package manifest.

Method Detail

toManifest

Node toManifest(Document document,
                MediaPackageSerializer serializer)
         throws MediaPackageException

This method returns an XML serialization of the object to be stored in the media package manifest. It should be possible to reconstruct the object from this data.

For creating MediaPackageElements from a manifest, please use MediaPackageElementBuilder.elementFromManifest(org.w3c.dom.Node, MediaPackageSerializer). All other objects shall provide their own implementation specific reconstruction mechanism.

Parameters:

document - the parent

serializer - the media package serializer

Returns:

the object's xml representation

Throws:

MediaPackageException - if the mediapackage can't be serialized