Package org.opencastproject.mediapackage

Class MediaPackageBuilderImpl

java.lang.Object

org.opencastproject.mediapackage.MediaPackageBuilderImpl

All Implemented Interfaces:

MediaPackageBuilder

public class MediaPackageBuilderImpl
extends Object
implements MediaPackageBuilder

This class provides factory methods for the creation of media packages from manifest files, directories or from scratch. This class is not thread safe, so create a new builder in each method invocation.

Field Summary

Fields

Modifier and Type	Field	Description
protected MediaPackageSerializer	serializer	The media package serializer

Constructor Summary

Constructors

Constructor	Description
MediaPackageBuilderImpl()	Creates a new media package builder.
MediaPackageBuilderImpl(MediaPackageSerializer serializer)	Creates a new media package builder that uses the given serializer to resolve urls while reading manifests and adding new elements.

Method Summary

Modifier and Type	Method	Description
MediaPackage	createNew()	Creates a new media package in the temporary directory defined by the java runtime property java.io.tmpdir.
MediaPackage	createNew(Id identifier)	Creates a new media package in the temporary directory defined by the java runtime property java.io.tmpdir.
MediaPackageSerializer	getSerializer()	Returns the currently active serializer.
MediaPackage	loadFromXml(InputStream is)	Loads a media package from the manifest.
MediaPackage	loadFromXml(String xml)	Loads a media package from the manifest.
MediaPackage	loadFromXml(Node xml)	Loads a media package from the manifest.
void	setSerializer(MediaPackageSerializer serializer)	Sets the media package serializer that is used to resolve urls and helps in serialization and deserialization of media package elements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serializer

protected MediaPackageSerializer serializer

The media package serializer

Constructor Details

MediaPackageBuilderImpl

public MediaPackageBuilderImpl()

Creates a new media package builder.

Throws:

IllegalStateException - if the temporary directory cannot be created or is not accessible

MediaPackageBuilderImpl

public MediaPackageBuilderImpl(MediaPackageSerializer serializer)

Creates a new media package builder that uses the given serializer to resolve urls while reading manifests and adding new elements.

Parameters:

serializer - the media package serializer

Throws:

IllegalStateException - if the temporary directory cannot be created or is not accessible

Method Details

createNew

public MediaPackage createNew()

Creates a new media package in the temporary directory defined by the java runtime property java.io.tmpdir.

Specified by:

createNew in interface MediaPackageBuilder

Returns:

the new media package

See Also:

• MediaPackageBuilder.createNew()

createNew

public MediaPackage createNew(Id identifier)

Creates a new media package in the temporary directory defined by the java runtime property java.io.tmpdir.

The name of the media package root folder will be equal to the handle value.

Specified by:

createNew in interface MediaPackageBuilder

Parameters:

identifier - the media package identifier

Returns:

the new media package

See Also:

• MediaPackageBuilder.createNew(org.opencastproject.mediapackage.identifier.Id)

loadFromXml

public MediaPackage loadFromXml(InputStream is)
                         throws MediaPackageException

Loads a media package from the manifest.

Specified by:

loadFromXml in interface MediaPackageBuilder

Parameters:

is - the media package manifest input stream

Returns:

the media package

Throws:

MediaPackageException - if loading of the media package fails

See Also:

• MediaPackageBuilder.loadFromXml(java.io.InputStream)

getSerializer

public MediaPackageSerializer getSerializer()

Description copied from interface: MediaPackageBuilder

Returns the currently active serializer. The serializer is used to resolve urls and helps in serialization and deserialization of media package elements.

Specified by:

getSerializer in interface MediaPackageBuilder

Returns:

the serializer

See Also:

• MediaPackageBuilder.getSerializer()

setSerializer

public void setSerializer(MediaPackageSerializer serializer)

Description copied from interface: MediaPackageBuilder

Sets the media package serializer that is used to resolve urls and helps in serialization and deserialization of media package elements.

Specified by:

setSerializer in interface MediaPackageBuilder

Parameters:

serializer - the serializer

See Also:

• MediaPackageBuilder.setSerializer(org.opencastproject.mediapackage.MediaPackageSerializer)

loadFromXml

public MediaPackage loadFromXml(String xml)
                         throws MediaPackageException

Loads a media package from the manifest.

Specified by:

loadFromXml in interface MediaPackageBuilder

Parameters:

xml - the media package manifest as an xml string

Returns:

the media package

Throws:

MediaPackageException - if loading of the media package fails

See Also:

• MediaPackageBuilder.loadFromXml(java.lang.String)

loadFromXml

public MediaPackage loadFromXml(Node xml)
                         throws MediaPackageException

Description copied from interface: MediaPackageBuilder

Loads a media package from the manifest.

Specified by:

loadFromXml in interface MediaPackageBuilder

Parameters:

xml - the media package manifest as an xml node

Returns:

the media package

Throws:

MediaPackageException - if loading of the media package fails