com.projectdarkstar.tools.dtc.data
Class SystemProbeDTO

java.lang.Object
  com.projectdarkstar.tools.dtc.data.AbstractDTO
      com.projectdarkstar.tools.dtc.data.SystemProbeDTO

All Implemented Interfaces:

Serializable

public class SystemProbeDTO
extends AbstractDTO

Represents a system probe application used to monitor and collect statistics during a DTC test.

See Also:

Serialized Form

Constructor Summary

SystemProbeDTO(Long id, Long versionNumber, String name, String className, String classPath, String metric, String units)

Method Summary

boolean	equals(Object o)
String	getClassName() Returns the fully qualified class name of this system probe required to initiate execution of this system probe
String	getClassPath() Returns the classpath required to run the system probe application.
Long	getId() Returns the id of the entity in persistent storage
String	getMetric() Returns the name of the metric that this system probe is designed to measure.
String	getName()
List<PropertyDTO>	getProperties() Returns a list of arguments in the form of PropertyDTO objects to be passed to the system probe during run time.
PkgLibraryDTO	getRequiredPkg() Returns the package library required to run this system probe.
List<SystemProbeTagDTO>	getTags() Returns a list of SystemProbeTagDTO objects that are used to categorize system probes into groups.
String	getUnits() Returns the unit of measurement of the metric.
Long	getVersionNumber() Returns the version number in the data store that this entity represents.
int	hashCode()
protected void	setClassName(String className)
protected void	setClassPath(String classPath)
void	setId(Long id)
protected void	setMetric(String metric)
protected void	setName(String name)
protected void	setProperties(List<PropertyDTO> properties)
protected void	setRequiredPkg(PkgLibraryDTO requiredPkg)
protected void	setTags(List<SystemProbeTagDTO> tags)
protected void	setUnits(String units)
void	updateClassName(String className)
void	updateClassPath(String classPath)
void	updateMetric(String metric)
void	updateName(String name)
void	updateProperties(List<PropertyDTO> properties)
void	updateRequiredPkg(PkgLibraryDTO requiredPkg)
void	updateTags(List<SystemProbeTagDTO> tags)
void	updateUnits(String units)
void	validate() Validates that each attribute and pending updated attribute (from the updatedAttributes Map) has a valid value in the context of the particular object.

Methods inherited from class com.projectdarkstar.tools.dtc.data.AbstractDTO

checkBlank, checkNull, getFullyPopulated, getUpdatedAttributes, updateAttribute, valueToValidate

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemProbeDTO

public SystemProbeDTO(Long id,
                      Long versionNumber,
                      String name,
                      String className,
                      String classPath,
                      String metric,
                      String units)

Method Detail

getId

public Long getId()

Returns the id of the entity in persistent storage

Specified by:

getId in class AbstractDTO

Returns:

id of the entity

setId

public void setId(Long id)

getVersionNumber

public Long getVersionNumber()

Returns the version number in the data store that this entity represents. Whenever an update to an object is pushed to the persistent data store, the version number is incremented.

Returns:

version number of the entity

getName

public String getName()

setName

protected void setName(String name)

updateName

public void updateName(String name)
                throws DTCInvalidDataException

Throws:

DTCInvalidDataException

getClassName

public String getClassName()

Returns the fully qualified class name of this system probe required to initiate execution of this system probe

Returns:

main class name for the system probe

setClassName

protected void setClassName(String className)

updateClassName

public void updateClassName(String className)
                     throws DTCInvalidDataException

Throws:

DTCInvalidDataException

getClassPath

public String getClassPath()

Returns the classpath required to run the system probe application. The items in this path are relative to the root of the filesystem in the required zip archive.

Returns:

classpath required to run the system probe

setClassPath

protected void setClassPath(String classPath)

updateClassPath

public void updateClassPath(String classPath)
                     throws DTCInvalidDataException

Throws:

DTCInvalidDataException

getMetric

public String getMetric()

Returns the name of the metric that this system probe is designed to measure.

Returns:

metric that this system probe measures

setMetric

protected void setMetric(String metric)

updateMetric

public void updateMetric(String metric)
                  throws DTCInvalidDataException

Throws:

DTCInvalidDataException

getUnits

public String getUnits()

Returns the unit of measurement of the metric.

Returns:

the unit of measurement of the metric.

setUnits

protected void setUnits(String units)

updateUnits

public void updateUnits(String units)
                 throws DTCInvalidDataException

Throws:

DTCInvalidDataException

getTags

public List<SystemProbeTagDTO> getTags()

Returns a list of SystemProbeTagDTO objects that are used to categorize system probes into groups.

Returns:

list of tags for this system probe

setTags

protected void setTags(List<SystemProbeTagDTO> tags)

updateTags

public void updateTags(List<SystemProbeTagDTO> tags)
                throws DTCInvalidDataException

Throws:

DTCInvalidDataException

getProperties

public List<PropertyDTO> getProperties()

Returns a list of arguments in the form of PropertyDTO objects to be passed to the system probe during run time.

Returns:

list of arguments

setProperties

protected void setProperties(List<PropertyDTO> properties)

updateProperties

public void updateProperties(List<PropertyDTO> properties)
                      throws DTCInvalidDataException

Throws:

DTCInvalidDataException

getRequiredPkg

public PkgLibraryDTO getRequiredPkg()

Returns the package library required to run this system probe. It is assumed that this library is a zip archive.

Returns:

the package library required to run this system probe

setRequiredPkg

protected void setRequiredPkg(PkgLibraryDTO requiredPkg)

updateRequiredPkg

public void updateRequiredPkg(PkgLibraryDTO requiredPkg)
                       throws DTCInvalidDataException

Throws:

DTCInvalidDataException

validate

public void validate()
              throws DTCInvalidDataException

Description copied from class: AbstractDTO

Validates that each attribute and pending updated attribute (from the updatedAttributes Map) has a valid value in the context of the particular object.

Specified by:

validate in class AbstractDTO

Throws:

DTCInvalidDataException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object