Package io.goobi.viewer.websockets

Class DownloadTaskEndpoint

java.lang.Object

io.goobi.viewer.websockets.DownloadTaskEndpoint

public class DownloadTaskEndpoint
extends Object

Endpoint that maps HTTP session IDs to connected web sockets.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DownloadTaskEndpoint.Action	Enumerates the client-initiated actions that can be sent over the WebSocket connection to control or query a download task.
static class	DownloadTaskEndpoint.ResourceFile
static class	DownloadTaskEndpoint.SocketMessage
static enum	DownloadTaskEndpoint.Status	Enumerates the runtime states of a download task as communicated to WebSocket clients.

Constructor Summary

Constructors

Constructor	Description
DownloadTaskEndpoint()

Method Summary

Modifier and Type	Method	Description
List<Path>	getDownloadedFiles(String pi, String downloadUrl)
Path	getDownloadFolder(String pi, String downloadUrl)
String	getMimetype(String path)
void	handleDownloadRequest(DownloadTaskEndpoint.SocketMessage message)
void	onClose(Session session)
void	onError(Session session, Throwable t)
void	onMessage(String messageString)
void	onOpen(Session session, EndpointConfig config)
void	startDownload(DownloadTaskEndpoint.SocketMessage message)

Methods inherited from class java.lang.Object

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

Constructor Details

DownloadTaskEndpoint

public DownloadTaskEndpoint()

Method Details

onOpen

public void onOpen(Session session,
 EndpointConfig config)

onMessage

public void onMessage(String messageString)

handleDownloadRequest

public void handleDownloadRequest(DownloadTaskEndpoint.SocketMessage message)
                           throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

startDownload

public void startDownload(DownloadTaskEndpoint.SocketMessage message)
                   throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getDownloadedFiles

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

Throws:

PresentationException

IndexUnreachableException

getDownloadFolder

public Path getDownloadFolder(String pi,
 String downloadUrl)
                       throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

getMimetype

public String getMimetype(String path)

onClose

public void onClose(Session session)

onError

public void onError(Session session,
 Throwable t)