org.jmythapi.protocol.events
Interface IDownloadFile<E extends Enum<E>>

All Superinterfaces:

Cloneable, IMythEvent<E>, IPropertyAware<E>, ISendable, IVersionable

All Known Subinterfaces:

IDownloadFileFinished, IDownloadFileUpdate

All Known Implementing Classes:

DownloadFileFinished, DownloadFileUpdate

public interface IDownloadFile<E extends Enum<E>>
extends IMythEvent<E>

Backend Event - Download File.

This message informs the client about a currently running backend download.

The following sub-events of this event are possible.

• IDownloadFileUpdate for a in-progress download.
• IDownloadFileFinished for a finished download.

Since:

58

See Also:

BACKEND_MESSAGE_DOWNLOAD_FILE, IBackend.downloadFile(URI, String, String)

Method Summary

Long	getBytesTotal() Gets the total size of the file in bytes.
URI	getLocalURI() Gets the URI to the local copy of the remote file, stored into a backend storage-group
Float	getReceivedPercent() Returns how many percent of the remote file were downloaded so far.
URI	getRemoteURI() Gets the URI to the remote file, which is downloaded by the backend.

Methods inherited from interface org.jmythapi.protocol.events.IMythEvent

getEventName

Methods inherited from interface org.jmythapi.IPropertyAware

getProperties, getProperty, getPropertyClass, getPropertyCount, getPropertyIndex, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValues, setPropertyValue, setPropertyValue, setPropertyValueObject

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Methods inherited from interface org.jmythapi.protocol.ISendable

getPacket

Method Detail

getRemoteURI

URI getRemoteURI()

Gets the URI to the remote file, which is downloaded by the backend.

Returns:

the URI of a remote file

getLocalURI

URI getLocalURI()

Gets the URI to the local copy of the remote file, stored into a backend storage-group

Returns:

the URI of the local file stored in a storage group

getBytesTotal

Long getBytesTotal()

Gets the total size of the file in bytes.

Returns:

the total size of the file in bytes

getReceivedPercent

Float getReceivedPercent()

Returns how many percent of the remote file were downloaded so far.

Returns:

how many percent of the file were downloaded so far.