Package io.goobi.viewer.model.job.download

Class DownloadJob

java.lang.Object

io.goobi.viewer.model.job.download.DownloadJob

Direct Known Subclasses:

EpubDownloadJob, PdfDownloadJob

public abstract class DownloadJob
extends Object

Abstract base class for asynchronous download jobs that generate files (e.g. PDF or EPUB) for digitized records. Manages job state, file locking, expiry, and user notification via e-mail.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE_EXTENSION_CREATING_LOCK

Constructor Summary

Constructors

Constructor	Description
DownloadJob(ViewerMessage message)
DownloadJob(String pi)

Method Summary

Modifier and Type	Method	Description
void	create()
abstract void	create(Dataset work)
boolean	createLock()
static DownloadJob	from(ViewerMessage message)
LocalDateTime	getExirationTime()
abstract String	getFilename()
abstract String	getMimeType()
abstract Path	getPath()
String	getPi()
protected Path	getTempPath()	Creates path to a temporary file to which the data is written.
String	getTimeToLive()	getTimeToLive.
abstract String	getType()
boolean	isExpired()	isExpired.
boolean	isLocked()
boolean	notifyObserver(String email, JobStatus status, URI downloadUri)	notifyObservers.
boolean	releaseLock()

Methods inherited from class java.lang.Object

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

Field Details

FILE_EXTENSION_CREATING_LOCK

public static final String FILE_EXTENSION_CREATING_LOCK

See Also:

• Constant Field Values

Constructor Details

DownloadJob

public DownloadJob(String pi)

DownloadJob

public DownloadJob(ViewerMessage message)

Method Details

getFilename

public abstract String getFilename()

getPath

public abstract Path getPath()

getType

public abstract String getType()

getPi

public String getPi()

getTempPath

protected Path getTempPath()

Creates path to a temporary file to which the data is written. Only after completion is the file moved to #getPath()

Returns:

a path

create

public void create()
            throws PresentationException,
IOException,
IndexUnreachableException,
RecordNotFoundException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

PresentationException

IOException

IndexUnreachableException

RecordNotFoundException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

create

public abstract void create(Dataset work)
                     throws IOException,
PresentationException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

IOException

PresentationException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

createLock

public boolean createLock()
                   throws IOException

Throws:

IOException

releaseLock

public boolean releaseLock()
                    throws IOException

Throws:

IOException

isLocked

public boolean isLocked()
                 throws IOException

Throws:

IOException

notifyObserver

public boolean notifyObserver(String email,
 JobStatus status,
 URI downloadUri)
                       throws UnsupportedEncodingException,
MessagingException

notifyObservers.

Parameters:

email - recipient email address to notify

status - a JobStatus object.

downloadUri - the URI under which the download is made available

Returns:

true if the notification email was sent successfully, false otherwise

Throws:

UnsupportedEncodingException - if any.

MessagingException - if any.

getExirationTime

public LocalDateTime getExirationTime()
                               throws IOException

Throws:

IOException

getTimeToLive

public String getTimeToLive()

getTimeToLive.

Returns:

the configured download PDF time-to-live formatted as "Dd H:MM:SS"

isExpired

public boolean isExpired()

isExpired.

Returns:

true if this download job has passed its expiration time, false otherwise

from

public static DownloadJob from(ViewerMessage message)
                        throws IllegalArgumentException

Throws:

IllegalArgumentException

getMimeType

public abstract String getMimeType()