org.opencastproject.mediapackage

Class MediaPackageSupport

java.lang.Object

org.opencastproject.mediapackage.MediaPackageSupport

public final class MediaPackageSupport
extends Object

Utility class used for media package handling.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaPackageSupport.Filters Filters and predicates to work with media package element collections.
static class	MediaPackageSupport.Fn Functions on media packages.
static class	MediaPackageSupport.MergeMode Mode used when merging media packages.

Field Summary

Fields

Modifier and Type	Field and Description
static Function<MediaPackageElement,Option<String>>	getChecksum Get the checksum from a media package element.
static Function<MediaPackage,String>	getId Deprecated. use MediaPackageSupport.Fn.getId
static Function<MediaPackageElement,String>	getMediaPackageElementId
static Function<MediaPackageElement,Option<String>>	getMediaPackageElementReferenceId
static Function<MediaPackageReference,String>	getReferenceId

Method Summary

Modifier and Type	Method and Description
static boolean	contains(String identifier, MediaPackage mp) Returns true if the media package contains an element with the specified identifier.
static MediaPackage	copy(MediaPackage mp) Create a copy of the given media package.
static MediaPackageElement	copy(MediaPackageElement mpe) Create a copy of the given media package element.
static com.entwinemedia.fn.data.Opt<String>	getFileName(MediaPackageElement mpe) Extract the file name from a media package elements URI.
static InputStream	getJsonInputStream(MediaPackage mp)
static InputStream	getJsonInputStream(XMLCatalog catalog)
static InputStream	getXmlInputStream(MediaPackage mp)
static InputStream	getXmlInputStream(XMLCatalog catalog)
static boolean	isPublishable(MediaPackage mp) Media package must have a title and contain tracks in order to be published.
static MediaPackage	loadFromClassPath(String path) To be used in unit tests.
static MediaPackage	merge(MediaPackage dest, MediaPackage src, MediaPackageSupport.MergeMode mode) Merges the contents of media package located at sourceDir into the media package located at targetDir.
static <A extends MediaPackageElement> A	modify(A mpe, Effect<A> e) Immutable modification of a media package element.
static MediaPackage	modify(MediaPackage mp, Effect<MediaPackage> e) Immutable modification of a media package.
static Effect<MediaPackage>	removeElements(List<MediaPackageElement> es)
static void	removeElements(List<MediaPackageElement> es, MediaPackage mp)
static void	replaceElements(MediaPackage mp, List<MediaPackageElement> es) Replaces all elements of mp with es.
static Option<List<String>>	sanityCheck(MediaPackage mp) Basic sanity checking for media packages.
static Effect<MediaPackageElement>	updateElement(MediaPackage mp) updateElement(MediaPackage, MediaPackageElement) as en effect.
static void	updateElement(MediaPackage mp, MediaPackageElement e) Update a mediapackage element of a mediapackage.

Methods inherited from class java.lang.Object

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

Field Detail

getMediaPackageElementId

public static final Function<MediaPackageElement,String> getMediaPackageElementId

getMediaPackageElementReferenceId

public static final Function<MediaPackageElement,Option<String>> getMediaPackageElementReferenceId

getReferenceId

public static final Function<MediaPackageReference,String> getReferenceId

getChecksum

public static final Function<MediaPackageElement,Option<String>> getChecksum

Get the checksum from a media package element.

getId

@Deprecated
public static final Function<MediaPackage,String> getId

Deprecated. use MediaPackageSupport.Fn.getId

Function to extract the ID of a media package.

Method Detail

merge

public static MediaPackage merge(MediaPackage dest,
                                 MediaPackage src,
                                 MediaPackageSupport.MergeMode mode)
                          throws MediaPackageException

Merges the contents of media package located at sourceDir into the media package located at targetDir.

When choosing to move the media package element into the new place instead of copying them, the source media package folder will be removed afterwards.

Parameters:

dest - the target media package directory

src - the source media package directory

mode - conflict resolution strategy in case of identical element identifier

Throws:

MediaPackageException - if an error occurs either accessing one of the two media packages or merging them

contains

public static boolean contains(String identifier,
                               MediaPackage mp)

Returns true if the media package contains an element with the specified identifier.

Parameters:

identifier - the identifier

Returns:

true if the media package contains an element with this identifier

getFileName

public static com.entwinemedia.fn.data.Opt<String> getFileName(MediaPackageElement mpe)

Extract the file name from a media package elements URI.

Returns:

the file name or none if it could not be determined

getJsonInputStream

public static InputStream getJsonInputStream(MediaPackage mp)

getXmlInputStream

public static InputStream getXmlInputStream(MediaPackage mp)

getJsonInputStream

public static InputStream getJsonInputStream(XMLCatalog catalog)

getXmlInputStream

public static InputStream getXmlInputStream(XMLCatalog catalog)

modify

public static MediaPackage modify(MediaPackage mp,
                                  Effect<MediaPackage> e)

Immutable modification of a media package.

modify

public static <A extends MediaPackageElement> A modify(A mpe,
                                                       Effect<A> e)

Immutable modification of a media package element. Attention: The returned element loses its media package membership (see AbstractMediaPackageElement.clone())

copy

public static MediaPackage copy(MediaPackage mp)

Create a copy of the given media package.

ATTENTION: Copying changes the type of the media package elements, e.g. an element of type DublinCoreCatalog will become a CatalogImpl.

copy

public static MediaPackageElement copy(MediaPackageElement mpe)

Create a copy of the given media package element.

updateElement

public static void updateElement(MediaPackage mp,
                                 MediaPackageElement e)

Update a mediapackage element of a mediapackage. Mutates mp.

updateElement

public static Effect<MediaPackageElement> updateElement(MediaPackage mp)

updateElement(MediaPackage, MediaPackageElement) as en effect.

removeElements

public static void removeElements(List<MediaPackageElement> es,
                                  MediaPackage mp)

removeElements

public static Effect<MediaPackage> removeElements(List<MediaPackageElement> es)

replaceElements

public static void replaceElements(MediaPackage mp,
                                   List<MediaPackageElement> es)

Replaces all elements of mp with es. Mutates mp.

sanityCheck

public static Option<List<String>> sanityCheck(MediaPackage mp)

Basic sanity checking for media packages.

 // media package is ok
 sanityCheck(mp).isNone()
 

Returns:

none if the media package is a healthy condition, some([error_msgs]) otherwise

loadFromClassPath

public static MediaPackage loadFromClassPath(String path)

To be used in unit tests.

isPublishable

public static boolean isPublishable(MediaPackage mp)

Media package must have a title and contain tracks in order to be published.

Parameters:

mp - the media package

Returns:

true if the media package can be published