au.org.ala.biocache.web

Class DownloadController

java.lang.Object

au.org.ala.biocache.web.AbstractSecureController

au.org.ala.biocache.web.DownloadController

@Controller
public class DownloadController
extends AbstractSecureController

A Controller for downloading records based on queries. This controller will provide methods for offline asynchronous downloads of large result sets.

• persistent queue to contain the offline downloads. - written to filesystem before emailing to supplied user
• administering the queue - changing order, removing items from queue

Author:

Natasha Carter (natasha.carter@csiro.au)

Field Summary

Fields

Modifier and Type	Field and Description
protected PersistentQueueDAO	persistentQueueDAO
protected SearchDAO	searchDAO Fulltext search DAO

Fields inherited from class au.org.ala.biocache.web.AbstractSecureController

apiCheckUrl

Constructor Summary

Constructors

Constructor and Description
DownloadController()

Method Summary

Methods

Modifier and Type	Method and Description
List<DownloadDetailsDTO>	getCurrentDownloads() Retrieves all the downloads that are on the queue
String	occurrenceDownload(DownloadRequestParams requestParams, String ip, String apiKey, String type, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletRequest request) Add a download to the offline queue

Methods inherited from class au.org.ala.biocache.web.AbstractSecureController

isValidKey, shouldPerformOperation, shouldPerformOperation

Methods inherited from class java.lang.Object

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

Field Detail

searchDAO

@Inject
protected SearchDAO searchDAO

Fulltext search DAO

persistentQueueDAO

@Inject
protected PersistentQueueDAO persistentQueueDAO

Constructor Detail

DownloadController

public DownloadController()

Method Detail

getCurrentDownloads

@RequestMapping(value="/offline/download/stats")
@ResponseBody
public List<DownloadDetailsDTO> getCurrentDownloads()

Retrieves all the downloads that are on the queue

Returns:

occurrenceDownload

@RequestMapping(value="occurrences/offline/{type}/download*",
                method=GET)
public String occurrenceDownload(DownloadRequestParams requestParams,
                                       @RequestParam(value="ip",required=false)
                                       String ip,
                                       @RequestParam(value="apiKey",required=false)
                                       String apiKey,
                                       @PathVariable(value="type")
                                       String type,
                                       javax.servlet.http.HttpServletResponse response,
                                       javax.servlet.http.HttpServletRequest request)
                          throws Exception

Add a download to the offline queue

Parameters:

requestParams -

ip -

apiKey -

type -

response -

request -

Returns:

Throws:

Exception