au.org.ala.biocache.dto

Class DownloadDetailsDTO

java.lang.Object

au.org.ala.biocache.dto.DownloadDetailsDTO

public class DownloadDetailsDTO
extends Object

Stores the details of a download. Will allow for monitoring of downloads

Author:

Natasha Carter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DownloadDetailsDTO.DownloadType Encompasses the different types of downloads that can be performed.

Constructor Summary

Constructors

Constructor and Description
DownloadDetailsDTO() Default constructor necessary for Jackson to create an object from the JSON.
DownloadDetailsDTO(DownloadRequestParams params, String ipAddress, DownloadDetailsDTO.DownloadType type)
DownloadDetailsDTO(String params, String ipAddress, DownloadDetailsDTO.DownloadType type)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDownloadParams()
DownloadDetailsDTO.DownloadType	getDownloadType()
String	getEmail()
String	getFileLocation()
Map<String,String>	getHeaderMap()
boolean	getIncludeSensitive()
String	getIpAddress()
String	getLastUpdate()
long	getRecordsDownloaded()
DownloadRequestParams	getRequestParams()
Date	getStartDate()
String	getStartDateString()
long	getStartTime()
long	getTotalRecords()
void	setDownloadParams(String downloadParams)
void	setDownloadType(DownloadDetailsDTO.DownloadType downloadType)
void	setEmail(String email)
void	setFileLocation(String fileLocation)
void	setHeaderMap(Map<String,String> headerMap)
void	setIncludeSensitive(boolean includeSensitive)
void	setIpAddress(String ipAddress)
void	setRequestParams(DownloadRequestParams requestParams)
void	setStartDate(Date startDate)
void	setTotalRecords(long total)
String	toString()
void	updateCounts(int number)

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadDetailsDTO

public DownloadDetailsDTO()

Default constructor necessary for Jackson to create an object from the JSON.

DownloadDetailsDTO

public DownloadDetailsDTO(String params,
                  String ipAddress,
                  DownloadDetailsDTO.DownloadType type)

DownloadDetailsDTO

public DownloadDetailsDTO(DownloadRequestParams params,
                  String ipAddress,
                  DownloadDetailsDTO.DownloadType type)

Method Detail

getLastUpdate

public String getLastUpdate()

getStartTime

public long getStartTime()

getStartDateString

public String getStartDateString()

getStartDate

public Date getStartDate()

setStartDate

public void setStartDate(Date startDate)

getRecordsDownloaded

public long getRecordsDownloaded()

getDownloadParams

public String getDownloadParams()

setDownloadParams

public void setDownloadParams(String downloadParams)

Parameters:

downloadParams - the downloadParams to set

getIpAddress

public String getIpAddress()

getDownloadType

public DownloadDetailsDTO.DownloadType getDownloadType()

setDownloadType

public void setDownloadType(DownloadDetailsDTO.DownloadType downloadType)

Parameters:

downloadType - the downloadType to set

updateCounts

public void updateCounts(int number)

setTotalRecords

public void setTotalRecords(long total)

getTotalRecords

public long getTotalRecords()

getEmail

public String getEmail()

Returns:

the email

setEmail

public void setEmail(String email)

Parameters:

email - the email to set

getFileLocation

public String getFileLocation()

Returns:

the fileLocation

setFileLocation

public void setFileLocation(String fileLocation)

Parameters:

fileLocation - the fileLocation to set

getRequestParams

public DownloadRequestParams getRequestParams()

Returns:

the requestParams

setRequestParams

public void setRequestParams(DownloadRequestParams requestParams)

Parameters:

requestParams - the requestParams to set

getIncludeSensitive

public boolean getIncludeSensitive()

Returns:

the includeSensitive

setIncludeSensitive

public void setIncludeSensitive(boolean includeSensitive)

Parameters:

includeSensitive - the includeSensitive to set

setIpAddress

public void setIpAddress(String ipAddress)

Parameters:

ipAddress - the ipAddress to set

getHeaderMap

public Map<String,String> getHeaderMap()

Returns:

the headerMap

setHeaderMap

public void setHeaderMap(Map<String,String> headerMap)

Parameters:

headerMap - the headerMap to set

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()