Package com.levigo.jadice.server.core

Interface JobExecutionContext

All Known Implementing Classes:

JMSJobExecutionContext

public interface JobExecutionContext

The JobExecutionContext is the abstraction layer which bundles all actions that the server can trigger on the client side part of a Job and the communication layer which transports these actions.

This is primarily JMS but other technologies could implement this interface as well.

Since:

jadice server 5.5.0.0

Method Summary

Modifier and Type	Method	Description
void	announceSubPipelineCreation(Node parent, Set<? extends Node> createdNodes)	Notify the client that a SubPipeline has been created on the server side
Job	getClientJob()
ServerJob	getServerJob()
void	init(ServerJob serverJob)	Initializes this JobExecutionContext with the ServerJob that belongs to the client side Job
void	notifyJobLaunchFailed(org.jadice.util.log.qualified.MessageID message, Throwable th)	Notify the client that an error occurred while launching this job
void	sendLogMessage(NodeWorker<?> worker, org.jadice.util.log.qualified.QualifiedLogEvent event)	Send a log message to the client.
void	sendLogMessage(NodeWorker<?> worker, org.jadice.util.log.qualified.QualifiedLogEvent event, org.jadice.util.log.Level level)	Send a log message to the client with a specific log Level
void	sendStateUpdate(Job.State state)	Notify the client that the Job Job.State has changed
void	shutdown()	Shuts down this context and close the connection to the client.

Method Detail

getClientJob

Job getClientJob()

Returns:

The Job which is being executed in this context.

getServerJob

ServerJob getServerJob()
                throws IllegalStateException

Returns:

the ServerJob which is being executed in this context.

Throws:

IllegalStateException - if this method is called before init.

init

void init(ServerJob serverJob)
   throws JobException

Initializes this JobExecutionContext with the ServerJob that belongs to the client side Job

Parameters:

serverJob - The ServerJob that will perform the work

Throws:

JobException - if an error occurred while initializing this context.

notifyJobLaunchFailed

void notifyJobLaunchFailed(org.jadice.util.log.qualified.MessageID message,
                           Throwable th)

Notify the client that an error occurred while launching this job

Parameters:

message - The MessageID of the error that prevents the successful job launching

th - (optional) The Exception that has occurred

sendStateUpdate

void sendStateUpdate(Job.State state)

Notify the client that the Job Job.State has changed

Parameters:

state - the new state

See Also:

Job.getState()

sendLogMessage

void sendLogMessage(NodeWorker<?> worker,
                    org.jadice.util.log.qualified.QualifiedLogEvent event)

Send a log message to the client.

Parameters:

worker - The NodeWorker that caused that event

event - The event itself

sendLogMessage

void sendLogMessage(NodeWorker<?> worker,
                    org.jadice.util.log.qualified.QualifiedLogEvent event,
                    org.jadice.util.log.Level level)

Send a log message to the client with a specific log Level

Parameters:

worker - The NodeWorker that caused that event

event - The event itself

level - The Level of that event

announceSubPipelineCreation

void announceSubPipelineCreation(Node parent,
                                 Set<? extends Node> createdNodes)

Notify the client that a SubPipeline has been created on the server side

Parameters:

parent - The Node that is responsible for the new sub pipeline

createdNodes - The Nodes which build the sub pipeline

shutdown

void shutdown()

Shuts down this context and close the connection to the client.