com.redhat.rhn.taskomatic

Class TaskoRun

java.lang.Object

com.redhat.rhn.taskomatic.TaskoRun

public class TaskoRun
extends java.lang.Object

TaskoRun

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STATUS_FAILED
static java.lang.String	STATUS_FINISHED
static java.lang.String	STATUS_INTERRUPTED
static java.lang.String	STATUS_READY_TO_RUN
static java.lang.String	STATUS_RUNNING
static java.lang.String	STATUS_SKIPPED

Constructor Summary

Constructors

Constructor and Description
TaskoRun() default constructor required by hibernate
TaskoRun(java.lang.Integer orgIdIn, TaskoTemplate templateIn, java.lang.Long scheduleIdIn) constructor run is always associated with organization, template and schedule

Method Summary

Modifier and Type	Method and Description
void	appendToErrorLog(java.lang.String errorLog) appends a string to error log usefull for exception logging when the run doesn't get executed at all
void	appendToOutputLog(java.lang.String outputLog) appends a string to output log usefull to log something if the run didn't start at all
java.lang.String	buildStdErrorLogPath() builds path to std error log file
java.lang.String	buildStdOutputLogPath() builds path to std output log file
void	failed() if task execution fails
void	finished() run finish method has to be called right after job execution
java.util.Date	getCreated()
java.util.Date	getEndTime()
java.lang.Long	getId()
java.util.Date	getModified()
java.lang.Integer	getOrgId()
java.lang.Long	getScheduleId()
java.util.Date	getStartTime()
java.lang.String	getStatus()
java.lang.String	getStdErrorPath()
java.lang.String	getStdOutputPath()
java.lang.String	getTailOfStdError(java.lang.Integer nBytes) returns last nBytes bytes of the std error log
java.lang.String	getTailOfStdOutput(java.lang.Integer nBytes) returns last nBytes bytes of the std output log
TaskoTemplate	getTemplate()
void	saveStatus(java.lang.String statusIn) sets run status
void	setCreated(java.util.Date createdIn)
void	setEndTime(java.util.Date endTimeIn)
void	setId(java.lang.Long idIn)
void	setModified(java.util.Date modifiedIn)
void	setOrgId(java.lang.Integer orgIdIn)
void	setScheduleId(java.lang.Long scheduleIdIn)
void	setStartTime(java.util.Date startTimeIn)
void	setStatus(java.lang.String statusIn)
void	setStdErrorPath(java.lang.String stdErrorPathIn)
void	setStdOutputPath(java.lang.String stdOutputPathIn)
void	setTemplate(TaskoTemplate templateId)
void	skipped() if task execution will be skipped (used for queue tasks)
void	start() run start method has to be called right before job execution

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_READY_TO_RUN

public static final java.lang.String STATUS_READY_TO_RUN

See Also:

Constant Field Values

STATUS_RUNNING

public static final java.lang.String STATUS_RUNNING

See Also:

Constant Field Values

STATUS_FINISHED

public static final java.lang.String STATUS_FINISHED

See Also:

Constant Field Values

STATUS_FAILED

public static final java.lang.String STATUS_FAILED

See Also:

Constant Field Values

STATUS_SKIPPED

public static final java.lang.String STATUS_SKIPPED

See Also:

Constant Field Values

STATUS_INTERRUPTED

public static final java.lang.String STATUS_INTERRUPTED

See Also:

Constant Field Values

Constructor Detail

TaskoRun

public TaskoRun()

default constructor required by hibernate

TaskoRun

public TaskoRun(java.lang.Integer orgIdIn,
                TaskoTemplate templateIn,
                java.lang.Long scheduleIdIn)

constructor run is always associated with organization, template and schedule

Parameters:

orgIdIn - organization id

templateIn - template id

scheduleIdIn - schedule id

Method Detail

start

public void start()

run start method has to be called right before job execution

finished

public void finished()

run finish method has to be called right after job execution

skipped

public void skipped()

if task execution will be skipped (used for queue tasks)

failed

public void failed()

if task execution fails

appendToOutputLog

public void appendToOutputLog(java.lang.String outputLog)

appends a string to output log usefull to log something if the run didn't start at all

Parameters:

outputLog - error message to append

appendToErrorLog

public void appendToErrorLog(java.lang.String errorLog)

appends a string to error log usefull for exception logging when the run doesn't get executed at all

Parameters:

errorLog - error message to append

saveStatus

public void saveStatus(java.lang.String statusIn)

sets run status

Parameters:

statusIn - status to set

getTailOfStdOutput

public java.lang.String getTailOfStdOutput(java.lang.Integer nBytes)

returns last nBytes bytes of the std output log

Parameters:

nBytes - number of bytes

Returns:

last bytes of the output log

getTailOfStdError

public java.lang.String getTailOfStdError(java.lang.Integer nBytes)

returns last nBytes bytes of the std error log

Parameters:

nBytes - number of bytes

Returns:

last bytes of the error log

buildStdOutputLogPath

public java.lang.String buildStdOutputLogPath()

builds path to std output log file

Returns:

path

buildStdErrorLogPath

public java.lang.String buildStdErrorLogPath()

builds path to std error log file

Returns:

path

getId

public java.lang.Long getId()

Returns:

Returns the id.

setId

public void setId(java.lang.Long idIn)

Parameters:

idIn - The id to set.

getTemplate

public TaskoTemplate getTemplate()

Returns:

Returns the templateId.

setTemplate

public void setTemplate(TaskoTemplate templateId)

Parameters:

templateId - The templateId to set.

getStartTime

public java.util.Date getStartTime()

Returns:

Returns the startTime.

setStartTime

public void setStartTime(java.util.Date startTimeIn)

Parameters:

startTimeIn - The startTime to set.

getEndTime

public java.util.Date getEndTime()

Returns:

Returns the endTime.

setEndTime

public void setEndTime(java.util.Date endTimeIn)

Parameters:

endTimeIn - The endTime to set.

getStdOutputPath

public java.lang.String getStdOutputPath()

Returns:

Returns the stdOutputPath.

setStdOutputPath

public void setStdOutputPath(java.lang.String stdOutputPathIn)

Parameters:

stdOutputPathIn - The stdOutputPath to set.

getStdErrorPath

public java.lang.String getStdErrorPath()

Returns:

Returns the stdErrorPath.

setStdErrorPath

public void setStdErrorPath(java.lang.String stdErrorPathIn)

Parameters:

stdErrorPathIn - The stdErrorPath to set.

getStatus

public java.lang.String getStatus()

Returns:

Returns the status.

setStatus

public void setStatus(java.lang.String statusIn)

Parameters:

statusIn - The status to set.

getCreated

public java.util.Date getCreated()

Returns:

Returns the created.

setCreated

public void setCreated(java.util.Date createdIn)

Parameters:

createdIn - The created to set.

getModified

public java.util.Date getModified()

Returns:

Returns the modified.

setModified

public void setModified(java.util.Date modifiedIn)

Parameters:

modifiedIn - The modified to set.

getOrgId

public java.lang.Integer getOrgId()

Returns:

Returns the orgId.

setOrgId

public void setOrgId(java.lang.Integer orgIdIn)

Parameters:

orgIdIn - The orgId to set.

getScheduleId

public java.lang.Long getScheduleId()

Returns:

Returns the jobLabel.

setScheduleId

public void setScheduleId(java.lang.Long scheduleIdIn)

Parameters:

scheduleIdIn - The jobLabel to set.