Package com.levigo.jadice.server.jms.core

Class JMSJobExecutionContext

java.lang.Object

com.levigo.jadice.server.jms.core.JMSJobExecutionContext

All Implemented Interfaces:

JobExecutionContext, com.levigo.jadice.server.jms.shared.internal.MessageProcessor, com.levigo.jadice.server.shared.watchdog.internal.WatchdogListener

public class JMSJobExecutionContext
extends Object
implements JobExecutionContext, com.levigo.jadice.server.shared.watchdog.internal.WatchdogListener, com.levigo.jadice.server.jms.shared.internal.MessageProcessor

The JMS specific implementation of a JMSJobExecutionContext

Since:

jadice server 5.5.0.0

Constructor Summary

Constructors

Constructor

Description

JMSJobExecutionContext(com.levigo.jadice.server.client.internal.DefaultJobInternalImpl clientJob, JobScheduler scheduler, JMSRequestEndpoint requestEndpoint, StreamTransportFactory transport, javax.jms.Message initMessage, javax.jms.QueueConnection queueConnection, javax.jms.QueueSession session, com.levigo.jadice.server.jms.shared.internal.MessageDispatcher messageDispatcher, javax.jms.Queue rxQueue, javax.jms.Queue txQueue, String correlationId)

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
boolean	bark(long delay, TimeUnit unit, String watchdogID)	A WatchdogTimer barks.
Job	getClientJob()
String	getCorrelationId()
javax.jms.Message	getInitMessage()
com.levigo.jadice.server.jms.shared.internal.MessageDispatcher	getMessageDispatcher()
javax.jms.QueueSender	getQueueSender()
javax.jms.Queue	getRxQueue()
ServerJob	getServerJob()
javax.jms.QueueSession	getSession()
javax.jms.Queue	getTxQueue()
void	init(ServerJob serverJob)	Initializes this JobExecutionContext with the ServerJob that belongs to the client side Job
void	messageReceived(javax.jms.Message message, com.levigo.jadice.server.jms.shared.internal.ServerMessage.MessageType type)	Receive notification about a message of the given type.
void	notifyJobLaunchFailed(org.jadice.util.log.qualified.MessageID messageID, Throwable cause)	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

JMSJobExecutionContext

public JMSJobExecutionContext(com.levigo.jadice.server.client.internal.DefaultJobInternalImpl clientJob,
                              JobScheduler scheduler,
                              JMSRequestEndpoint requestEndpoint,
                              StreamTransportFactory transport,
                              javax.jms.Message initMessage,
                              javax.jms.QueueConnection queueConnection,
                              javax.jms.QueueSession session,
                              com.levigo.jadice.server.jms.shared.internal.MessageDispatcher messageDispatcher,
                              javax.jms.Queue rxQueue,
                              javax.jms.Queue txQueue,
                              String correlationId)
                       throws javax.jms.JMSException

Throws:

javax.jms.JMSException

Method Detail

getClientJob

public Job getClientJob()

Specified by:

getClientJob in interface JobExecutionContext

Returns:

The Job which is being executed in this context.

getServerJob

public ServerJob getServerJob()
                       throws IllegalStateException

Specified by:

getServerJob in interface JobExecutionContext

Returns:

the ServerJob which is being executed in this context.

Throws:

IllegalStateException - if this method is called before init.

getMessageDispatcher

public com.levigo.jadice.server.jms.shared.internal.MessageDispatcher getMessageDispatcher()

getRxQueue

public javax.jms.Queue getRxQueue()

getTxQueue

public javax.jms.Queue getTxQueue()

getCorrelationId

public String getCorrelationId()

getInitMessage

public javax.jms.Message getInitMessage()

getSession

public javax.jms.QueueSession getSession()

init

public void init(ServerJob serverJob)
          throws JobException

Description copied from interface: JobExecutionContext

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

Specified by:

init in interface JobExecutionContext

Parameters:

serverJob - The ServerJob that will perform the work

Throws:

JobException - if an error occurred while initializing this context.

sendLogMessage

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

Description copied from interface: JobExecutionContext

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

Specified by:

sendLogMessage in interface JobExecutionContext

Parameters:

worker - The NodeWorker that caused that event

event - The event itself

level - The Level of that event

sendLogMessage

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

Description copied from interface: JobExecutionContext

Send a log message to the client.

Specified by:

sendLogMessage in interface JobExecutionContext

Parameters:

worker - The NodeWorker that caused that event

event - The event itself

getQueueSender

public javax.jms.QueueSender getQueueSender()

sendStateUpdate

public void sendStateUpdate(Job.State state)

Description copied from interface: JobExecutionContext

Notify the client that the Job Job.State has changed

Specified by:

sendStateUpdate in interface JobExecutionContext

Parameters:

state - the new state

See Also:

Job.getState()

announceSubPipelineCreation

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

Description copied from interface: JobExecutionContext

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

Specified by:

announceSubPipelineCreation in interface JobExecutionContext

Parameters:

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

createdNodes - The Nodes which build the sub pipeline

shutdown

public void shutdown()

Description copied from interface: JobExecutionContext

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

Specified by:

shutdown in interface JobExecutionContext

bark

public boolean bark(long delay,
                    TimeUnit unit,
                    String watchdogID)

Description copied from interface: com.levigo.jadice.server.shared.watchdog.internal.WatchdogListener

A WatchdogTimer barks.

Specified by:

bark in interface com.levigo.jadice.server.shared.watchdog.internal.WatchdogListener

watchdogID - TODO

Returns:

true, to instruct the watchdog to bark again (after the prescribed delay) as if nothing had happened, false to make it stop barking.

messageReceived

public void messageReceived(javax.jms.Message message,
                            com.levigo.jadice.server.jms.shared.internal.ServerMessage.MessageType type)

Description copied from interface: com.levigo.jadice.server.jms.shared.internal.MessageProcessor

Receive notification about a message of the given type.

Specified by:

messageReceived in interface com.levigo.jadice.server.jms.shared.internal.MessageProcessor

notifyJobLaunchFailed

public void notifyJobLaunchFailed(org.jadice.util.log.qualified.MessageID messageID,
                                  Throwable cause)

Description copied from interface: JobExecutionContext

Notify the client that an error occurred while launching this job

Specified by:

notifyJobLaunchFailed in interface JobExecutionContext

Parameters:

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

cause - (optional) The Exception that has occurred