com.whizzosoftware.hobson.api.action.job

Class Job

java.lang.Object

com.whizzosoftware.hobson.api.action.job.Job

All Implemented Interfaces:

ActionLifecycleContext, JobInfo

public class Job
extends java.lang.Object
implements JobInfo, ActionLifecycleContext

A Job provides information about and control of an Action execution's lifecycle. This information includes its start time, current status, status messages, etc.

Author:

Dan Noguerol

Constructor Summary

Constructors

Constructor and Description
Job(Action action, long timeoutInterval, long createTime) Constructor.

Method Summary

Modifier and Type	Method and Description
void	complete()
void	complete(java.lang.String statusMsg)
void	fail(java.lang.String statusMsg)
java.lang.Long	getCompletionTime()
java.lang.String	getId()
java.lang.Long	getStartTime()
JobStatus	getStatus() Returns the current status of the job.
java.util.List<java.lang.String>	getStatusMessages() Returns status messages associated with the job.
boolean	hasExceededTimeout(long now)
boolean	isAssociatedWithPlugin(PluginContext ctx)
boolean	isComplete()
boolean	isInProgress()
boolean	isOlderThanAnHour(long currentTime)
Future	message(java.lang.String name, java.lang.Object prop) Sends a message to the job which its associated Action can process.
Future	start() Starts the job.
Future	stop() Stops this job.
void	timeout() Flag the job as timed out.
void	update(java.lang.String statusMsg)

Methods inherited from class java.lang.Object

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

Constructor Detail

Job

public Job(Action action,
           long timeoutInterval,
           long createTime)

Constructor.

Parameters:

action - the action associated with this job

timeoutInterval - the maximum interval the job is allowed to run before being considered timed out

createTime - the time the job was created

Method Detail

getId

public java.lang.String getId()

getStartTime

public java.lang.Long getStartTime()

hasExceededTimeout

public boolean hasExceededTimeout(long now)

getCompletionTime

public java.lang.Long getCompletionTime()

isAssociatedWithPlugin

public boolean isAssociatedWithPlugin(PluginContext ctx)

isComplete

public boolean isComplete()

isInProgress

public boolean isInProgress()

isOlderThanAnHour

public boolean isOlderThanAnHour(long currentTime)

message

public Future message(java.lang.String name,
                      java.lang.Object prop)

Sends a message to the job which its associated Action can process.

Parameters:

name - the message name

prop - a property object associated with the message

Returns:

a Future representing the success of the message being added.

start

public Future start()

Starts the job.

Returns:

a Future representing the completion of the job Action's onStartup method.

stop

public Future stop()

Stops this job.

Returns:

a Future representing the success of the job being stopped.

timeout

public void timeout()

Flag the job as timed out.

getStatus

public JobStatus getStatus()

Description copied from interface: JobInfo

Returns the current status of the job.

Specified by:

getStatus in interface JobInfo

Returns:

a JobStatus instance

getStatusMessages

public java.util.List<java.lang.String> getStatusMessages()

Description copied from interface: JobInfo

Returns status messages associated with the job.

Specified by:

getStatusMessages in interface JobInfo

Returns:

An ordered (oldest first) list of status messages

complete

public void complete()

Specified by:

complete in interface ActionLifecycleContext

complete

public void complete(java.lang.String statusMsg)

Specified by:

complete in interface ActionLifecycleContext

fail

public void fail(java.lang.String statusMsg)

Specified by:

fail in interface ActionLifecycleContext

update

public void update(java.lang.String statusMsg)

Specified by:

update in interface ActionLifecycleContext