com.denimgroup.threadfix.data.entities

Class ScanQueueTask

java.lang.Object

com.denimgroup.threadfix.data.entities.BaseEntity

com.denimgroup.threadfix.data.entities.AuditableEntity

com.denimgroup.threadfix.data.entities.ScanQueueTask

All Implemented Interfaces:

Serializable

@Entity
public class ScanQueueTask
extends AuditableEntity

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScanQueueTask.ScanQueueTaskStatus

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCANAGENT_CONFIG_FILE_EXTENSION

Constructor Summary

Constructors

Constructor and Description
ScanQueueTask()
ScanQueueTask(int numHoursTilTimeout)

Method Summary

Modifier and Type	Method and Description
void	addScanStatus(ScanStatus status)
Application	getApplication()
Date	getCreateTime()
Date	getEndTime()
String	getScanAgentInfo()
String	getScanAgentInstanceSecureKey()
Document	getScanConfig()
String	getScanner()
String	getScannerShortName()
List<ScanStatus>	getScanStatuses()
String	getSecureKey()
Date	getStartTime()
int	getStatus()
String	getStatusString()
String	getTargetUrl()
ScanQueueTask.ScanQueueTaskStatus	getTaskStatus()
Date	getTimeoutTime()
String	getVersion()
static String	makeScanAgentConfigFileName(String scannerType) Take a scanner type and return the filename for storing that scanner's configuration for that scan agent.
void	setApplication(Application application)
void	setCreateTime(Date createTime)
void	setEndTime(Date endTime)
void	setScanAgentInfo(String scanAgentInfo)
void	setScanAgentInstanceSecureKey(String scanAgentInstanceSecureKey)
void	setScanConfig(Document scanConfig)
void	setScanner(String scanner)
void	setScanStatuses(List<ScanStatus> scanStatuses)
void	setSecureKey(String secureKey)
void	setStartTime(Date startTime)
void	setStatus(int status)
void	setTargetUrl(String targetUrl)
void	setTaskStatus(ScanQueueTask.ScanQueueTaskStatus status)
void	setTimeoutTime(Date timeoutTime)
void	setVersion(String version)
String	showStatusString()
int	taskId()
void	taskId(int taskId)
String	toString()
static boolean	validateScanner(String proposedScanner) Determines if a proposed scanner name is valid.

Methods inherited from class com.denimgroup.threadfix.data.entities.AuditableEntity

getCreatedDate, getModifiedDate, isActive, setActive, setCreatedDate, setModifiedDate

Methods inherited from class com.denimgroup.threadfix.data.entities.BaseEntity

getId, isNew, setId

Methods inherited from class java.lang.Object

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

Field Detail

SCANAGENT_CONFIG_FILE_EXTENSION

public static final String SCANAGENT_CONFIG_FILE_EXTENSION

See Also:

Constant Field Values

Constructor Detail

ScanQueueTask

public ScanQueueTask()

ScanQueueTask

public ScanQueueTask(int numHoursTilTimeout)

Method Detail

taskId

public int taskId()

taskId

public void taskId(int taskId)

getScanStatuses

public List<ScanStatus> getScanStatuses()

setScanStatuses

public void setScanStatuses(List<ScanStatus> scanStatuses)

getApplication

public Application getApplication()

setApplication

public void setApplication(Application application)

getScanner

public String getScanner()

setScanner

public void setScanner(String scanner)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getCreateTime

public Date getCreateTime()

setCreateTime

public void setCreateTime(Date createTime)

getStartTime

public Date getStartTime()

setStartTime

public void setStartTime(Date startTime)

getEndTime

public Date getEndTime()

setEndTime

public void setEndTime(Date endTime)

getTimeoutTime

public Date getTimeoutTime()

setTimeoutTime

public void setTimeoutTime(Date timeoutTime)

getStatus

public int getStatus()

setStatus

public void setStatus(int status)

getTaskStatus

public ScanQueueTask.ScanQueueTaskStatus getTaskStatus()

setTaskStatus

public void setTaskStatus(ScanQueueTask.ScanQueueTaskStatus status)

getStatusString

public String getStatusString()

getScanAgentInfo

public String getScanAgentInfo()

setScanAgentInfo

public void setScanAgentInfo(String scanAgentInfo)

getSecureKey

public String getSecureKey()

setSecureKey

public void setSecureKey(String secureKey)

getScanAgentInstanceSecureKey

public String getScanAgentInstanceSecureKey()

setScanAgentInstanceSecureKey

public void setScanAgentInstanceSecureKey(String scanAgentInstanceSecureKey)

getScanConfig

public Document getScanConfig()

setScanConfig

public void setScanConfig(Document scanConfig)

getTargetUrl

@URL(message="{errors.url}")
 @Size(min=0,
      max=255,
      message="{errors.maxlength} 255.")
public String getTargetUrl()

setTargetUrl

public void setTargetUrl(String targetUrl)

addScanStatus

public void addScanStatus(ScanStatus status)

showStatusString

public String showStatusString()

validateScanner

public static boolean validateScanner(String proposedScanner)

Determines if a proposed scanner name is valid. Currently this just checks to make sure that all of the characters are alphanumeric and that the length is less than 32. TODO - This needs to whitelist-check against a list of known "good" scanner names rather than just try to avoid riffraff entries.

Parameters:

proposedScanner - proposed scanner name to validate

Returns:

true if the scanner name is valid, false if it is not valid

makeScanAgentConfigFileName

public static String makeScanAgentConfigFileName(String scannerType)

Take a scanner type and return the filename for storing that scanner's configuration for that scan agent.

Parameters:

scannerType - scanner type

Returns:

filename for storing the scan agent configuration for that scanner (returns null if an invalid scanner type is passed in)

toString

public String toString()

Overrides:

toString in class Object

getScannerShortName

public String getScannerShortName()