Package io.goobi.viewer.model.job.mq

Class DownloadExternalResourceHandler

java.lang.Object

io.goobi.viewer.model.job.mq.DownloadExternalResourceHandler

All Implemented Interfaces:

MessageHandler<MessageStatus>

public class DownloadExternalResourceHandler
extends Object
implements MessageHandler<MessageStatus>

Message handler that downloads external resource files (e.g. ZIP archives) from a remote URI and stores them in the local data repository. Download progress is tracked and made available via the application-scoped storage bean.

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	ALLOWED_FILE_EXTENSIONS

Constructor Summary

Constructors

Constructor	Description
DownloadExternalResourceHandler()

Method Summary

Modifier and Type	Method	Description
MessageStatus	call(ViewerMessage message, MessageQueueManager queueManager)	Call this method to execute the ticket.
static ViewerMessage	createMessage(String pi, String url, String urlTemplate)
List<Path>	getDownloadedFiles(String pi, String downloadUrl, String downloadId)
String	getMessageHandlerName()
ApplicationBean	getStorageBean()
void	setStorageBean(ApplicationBean storageBean)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.goobi.viewer.controller.mq.MessageHandler

call, onStartup

Field Details

ALLOWED_FILE_EXTENSIONS

public static final String[] ALLOWED_FILE_EXTENSIONS

Constructor Details

DownloadExternalResourceHandler

public DownloadExternalResourceHandler()

Method Details

call

public MessageStatus call(ViewerMessage message,
 MessageQueueManager queueManager)

Description copied from interface: MessageHandler

Call this method to execute the ticket.

Specified by:

call in interface MessageHandler<MessageStatus>

Parameters:

message - The ticket to handle

queueManager - reference to to manage the queue

Returns:

V

getDownloadedFiles

public List<Path> getDownloadedFiles(String pi,
 String downloadUrl,
 String downloadId)
                              throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

getMessageHandlerName

public String getMessageHandlerName()

Specified by:

getMessageHandlerName in interface MessageHandler<MessageStatus>

createMessage

public static ViewerMessage createMessage(String pi,
 String url,
 String urlTemplate)

getStorageBean

public ApplicationBean getStorageBean()

setStorageBean

public void setStorageBean(ApplicationBean storageBean)