com.persistit

Class Management.TaskStatus

java.lang.Object

com.persistit.Management.AcquisitionTimeBase

com.persistit.Management.TaskStatus

All Implemented Interfaces:

Serializable

Enclosing interface:

Management

public static class Management.TaskStatus
extends Management.AcquisitionTimeBase
implements Serializable

Structure that describes the current status of a long-running utility task. See Management.queryTaskStatus(long, boolean, boolean) for further information.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
TaskStatus()
TaskStatus(long taskId, String description, String owner, int state, String stateName, long startTime, long finishTime, long expirationTime, String statusSummary, String statusDetail, String[] newMessages, String lastException)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Tests whether the supplied object is a TaskStatus with the same taskId is this one.
String	getDescription() Return a description of this task
long	getExpirationTime() System time at which this task is scheduled to be stopped if it has not finished yet.
long	getFinishTime() System time at which this task ended, whether normal or abnormally, or zero if the task has not ended yet.
String	getLastException() The most recent Exception thrown by this task.
String[]	getMessages() Messages that have been posted by this task.
String	getOwner() Return the owner (hostname and/or username) of the initiator of this task
long	getStartTime() System time at which this task was started, or zero if never started.
int	getState() Return the state code for this task.
String	getStateString() Return the name of the state this task is in.
String	getStatusDetail() A more detailed description of the current status of the task.
String	getStatusSummary() A short (under 40 character) readable String summarizing the current status.
long	getTaskId() Return the unique taskID for this task
String	toString()
String	toString(boolean details)

Methods inherited from class com.persistit.Management.AcquisitionTimeBase

getAcquisitionTime, setAcquisitionTime

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

TaskStatus

public TaskStatus()

TaskStatus

@ConstructorProperties(value={"taskId","description","owner","state","stateName","startTime","finishTime","expirationTime","statusSummary","statusDetail","newMessages","lastException"})
public TaskStatus(long taskId,
                                                                                                                                                                                                            String description,
                                                                                                                                                                                                            String owner,
                                                                                                                                                                                                            int state,
                                                                                                                                                                                                            String stateName,
                                                                                                                                                                                                            long startTime,
                                                                                                                                                                                                            long finishTime,
                                                                                                                                                                                                            long expirationTime,
                                                                                                                                                                                                            String statusSummary,
                                                                                                                                                                                                            String statusDetail,
                                                                                                                                                                                                            String[] newMessages,
                                                                                                                                                                                                            String lastException)

Method Detail

getTaskId

public long getTaskId()

Return the unique taskID for this task

Returns:

the unique taskID

getDescription

public String getDescription()

Return a description of this task

Returns:

the description

getOwner

public String getOwner()

Return the owner (hostname and/or username) of the initiator of this task

Returns:

the owner

getState

public int getState()

Return the state code for this task. This is one of

• Task.STATE_NOT_STARTED
• Task.STATE_RUNNING
• Task.STATE_SUSPENDED
• Task.STATE_DONE
• Task.STATE_FAILED
• Task.STATE_ENDED
• Task.STATE_EXPIRED

Returns:

The state

getStateString

public String getStateString()

Return the name of the state this task is in. One of "notStarted", "running", "done", "suspended", "failed", "ended", or "expired".

Returns:

A readable name of the task's current state

getStatusSummary

public String getStatusSummary()

A short (under 40 character) readable String summarizing the current status.

Returns:

A short readable status

getStatusDetail

public String getStatusDetail()

A more detailed description of the current status of the task.

Returns:

Detailed status description

getMessages

public String[] getMessages()

Messages that have been posted by this task.

Returns:

The messages

getStartTime

public long getStartTime()

System time at which this task was started, or zero if never started.

Returns:

The time

getFinishTime

public long getFinishTime()

System time at which this task ended, whether normal or abnormally, or zero if the task has not ended yet.

Returns:

The time

getExpirationTime

public long getExpirationTime()

System time at which this task is scheduled to be stopped if it has not finished yet.

Returns:

The time

getLastException

public String getLastException()

The most recent Exception thrown by this task.

Returns:

Most recently thrown Exception by this task

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean details)

equals

public boolean equals(Object object)

Tests whether the supplied object is a TaskStatus with the same taskId is this one.

Overrides:

equals in class Object

Returns:

true if equal, otherwise false