ome.smuggler.web

Class TaskFileStoreAdapter<T extends util.object.Identifiable>

java.lang.Object

ome.smuggler.web.TaskFileStoreAdapter<T>

Direct Known Subclasses:

ImportFailureController, MailFailureController

public abstract class TaskFileStoreAdapter<T extends util.object.Identifiable>
extends java.lang.Object

Provides the means to make the functionality of a TaskFileStore available to web clients.

Constructor Summary

Constructors

Constructor and Description
TaskFileStoreAdapter()

Method Summary

Modifier and Type	Method and Description
protected java.util.function.Consumer<javax.servlet.http.HttpServletResponse>	cacheStrategy()
org.springframework.http.ResponseEntity<java.lang.Void>	deleteFile(java.lang.String taskId) Removes the file associated to a task if it is in the store; does nothing otherwise.
protected org.springframework.http.MediaType	filesContentType()
java.lang.String[]	listTaskFileUrlPaths()
protected abstract java.lang.String	rootPath()
protected abstract TaskFileStore<T>	service()
org.springframework.http.ResponseEntity<java.lang.String>	streamFileOr404(java.lang.String taskId, javax.servlet.http.HttpServletResponse response) Looks up the file associated to a task using the task ID and streams that file to the client if found; otherwise outputs a 404 to the client.
protected abstract java.util.function.Function<java.lang.String,T>	taskIdFromString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskFileStoreAdapter

public TaskFileStoreAdapter()

Method Detail

service

protected abstract TaskFileStore<T> service()

Returns:

the underlying task file store.

rootPath

protected abstract java.lang.String rootPath()

Returns:

the base web path from which the files will be served.

taskIdFromString

protected abstract java.util.function.Function<java.lang.String,T> taskIdFromString()

Returns:

a function to create a task ID from its string representation.

filesContentType

protected org.springframework.http.MediaType filesContentType()

Returns:

the content type of the files in the store; defaults to plain text.

cacheStrategy

protected java.util.function.Consumer<javax.servlet.http.HttpServletResponse> cacheStrategy()

Returns:

the HTTP caching strategy to use when streaming files to the client; defaults to caching forever.

See Also:

Caches

listTaskFileUrlPaths

@RequestMapping(method=GET,
                produces="application/json")
public java.lang.String[] listTaskFileUrlPaths()

Returns:

the URL root paths to access each of the files currently in the store.

streamFileOr404

@RequestMapping(method=GET,
                value="{taskId}")
public org.springframework.http.ResponseEntity<java.lang.String> streamFileOr404(@PathVariable(value="taskId")
                                                                                                                                               java.lang.String taskId,
                                                                                                                                               javax.servlet.http.HttpServletResponse response)
                                                                                                                                        throws java.io.IOException

Looks up the file associated to a task using the task ID and streams that file to the client if found; otherwise outputs a 404 to the client.

Parameters:

taskId - the ID of the task associated to the file.

response - the response to use to stream the file.

Returns:

dummy entity to make this work with Spring MVC.

Throws:

java.io.IOException - If an error occurs while reading and streaming the file.

deleteFile

@RequestMapping(method=DELETE,
                value="{taskId}")
public org.springframework.http.ResponseEntity<java.lang.Void> deleteFile(@PathVariable(value="taskId")
                                                                                                                                           java.lang.String taskId)

Removes the file associated to a task if it is in the store; does nothing otherwise.

Parameters:

taskId - the ID of the task associated to the file.

Returns:

a 204 response to the client.