org.mmbase.streams.download

Class DownloadFunction

java.lang.Object

org.mmbase.util.functions.AbstractFunction<R>

org.mmbase.util.functions.NodeFunction<String>

org.mmbase.streams.download.DownloadFunction

All Implemented Interfaces:

Serializable, Comparable<Function<String>>, Function<String>

public final class DownloadFunction
extends NodeFunction<String>

Downloads a media stream from an url for a media item (mediafragments node) puts it in the files directory and returns it's filename when finished. A timeout parameter let's you set number of seconds you wish to wait for the download to finish. When you specify an email address as parameter you get an email when it's really finished. The function starts a thread and calls Downloader to do the actual work. The media file itself is saved in a mediasources node and transcoded by the streams application when the download finishes. Url and information about success or failure of the download are saved as properties on the mediafragments node.

Version:

$Id$

Author:

Michiel Meeuwissen, André van Toly

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Parameter[]	PARAMETERS

Fields inherited from class org.mmbase.util.functions.AbstractFunction

autoReturnType, name, returnType

Constructor Summary

Constructors

Constructor and Description
DownloadFunction()

Method Summary

Modifier and Type	Method and Description
protected String	getDownloadStatus(Node node)
String	getFunctionValue(Node node, Parameters parameters)
protected String	getProperty(Node node, String key)
protected void	setDownloadStatus(Node node, String status)
protected void	setDownloadUrl(Node node, String link)
protected void	setProperty(Node node, String key, String value)
protected Future<String>	submit(Node node, Parameters parameters)

Methods inherited from class org.mmbase.util.functions.NodeFunction

getFunctionNameAndFillArgs, getFunctionValue, getFunctionValue, getFunctionValueForNode, getNode, getNodeParameterDef, getReturnType, newInstance, wrap

Methods inherited from class org.mmbase.util.functions.AbstractFunction

compareTo, createParameters, equals, getDescription, getFunctionValueWithList, getName, getParameterDefinition, hashCode, setDescription, setParameterDefinition, setReturnType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PARAMETERS

public static final Parameter[] PARAMETERS

Constructor Detail

DownloadFunction

public DownloadFunction()

Method Detail

setProperty

protected void setProperty(Node node,
                           String key,
                           String value)

getProperty

protected String getProperty(Node node,
                             String key)

setDownloadUrl

protected void setDownloadUrl(Node node,
                              String link)

setDownloadStatus

protected void setDownloadStatus(Node node,
                                 String status)

getDownloadStatus

protected String getDownloadStatus(Node node)

submit

protected Future<String> submit(Node node,
                                Parameters parameters)

getFunctionValue

public String getFunctionValue(Node node,
                               Parameters parameters)

Specified by:

getFunctionValue in class NodeFunction<String>