org.jppf.client.monitoring.jobs

Class JobMonitor

java.lang.Object

org.jppf.client.monitoring.topology.TopologyListenerAdapter

org.jppf.client.monitoring.jobs.JobMonitor

All Implemented Interfaces:

AutoCloseable, EventListener, JobMonitoringHandler, TopologyListener

public class JobMonitor
extends TopologyListenerAdapter
implements JobMonitoringHandler

This class provides a representation of the jobs and corresponding node dispatches executing in a JPPF grid.

Since:

5.1

Constructor Summary

Constructors

Constructor and Description
JobMonitor(JobMonitorUpdateMode updateMode, long period, TopologyManager topologyManager, JobMonitoringListener... listeners) Initialize this job manager with the specified topology manager and event mode.
JobMonitor(TopologyManager topologyManager, JobMonitoringListener... listeners) Initialize this job manager with the specified topology manager in IMMEDIATE_NOTFICATIONS mode.

Method Summary

Modifier and Type	Method and Description
void	addJobMonitoringListener(JobMonitoringListener listener) Add a listener to the events emitted by this job monitor.
void	close()
List<JobDispatch>	getAllJobDispatches(String jobUuid) Get the dispatches of the specified job accrosss the entire topology.
List<JobDriver>	getDriversForJob(String jobUuid) Get the drivers to which a job was submitted, either in parallel from the same client, or from one driver to another in a multi-driver topology.
JobDriver	getJobDriver(String driverUuid) Get the driver with the specified uuid.
List<JobDriver>	getJobDrivers() Get the drivers monitored by this job monitor.
TopologyManager	getTopologyManager() Get the topology manager associated with this job monitor.
void	removeJobMonitoringListener(JobMonitoringListener listener) Remove a listener to the events emitted by this job monitor.

Methods inherited from class org.jppf.client.monitoring.topology.TopologyListenerAdapter

driverAdded, driverRemoved, driverUpdated, nodeAdded, nodeRemoved, nodeUpdated

Methods inherited from class java.lang.Object

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

Constructor Detail

JobMonitor

public JobMonitor(TopologyManager topologyManager,
                  JobMonitoringListener... listeners)

Initialize this job manager with the specified topology manager in IMMEDIATE_NOTFICATIONS mode.

Parameters:

topologyManager - the topology manager to use.

listeners - optional listeners that can be registered immediately with this job monitor.

JobMonitor

public JobMonitor(JobMonitorUpdateMode updateMode,
                  long period,
                  TopologyManager topologyManager,
                  JobMonitoringListener... listeners)

Initialize this job manager with the specified topology manager and event mode.

Parameters:

updateMode - the update mode which determines how job monitoring events are generated.

period - the interval between publications of updates. This is not used in IMMEDIATE_NOTFICATIONS mode.

topologyManager - the topology manager to use.

listeners - optional listeners that can be registered immediately with this job monitor.

Method Detail

getTopologyManager

public TopologyManager getTopologyManager()

Get the topology manager associated with this job monitor.

Returns:

a TopologyManager object.

getJobDriver

public JobDriver getJobDriver(String driverUuid)

Get the driver with the specified uuid.

Parameters:

driverUuid - the uuid of the driver to retrieve.

Returns:

a JobDriver object, or null if there si no such driver.

getJobDrivers

public List<JobDriver> getJobDrivers()

Get the drivers monitored by this job monitor.

Returns:

a list of JobDriver objects.

getDriversForJob

public List<JobDriver> getDriversForJob(String jobUuid)

Get the drivers to which a job was submitted, either in parallel from the same client, or from one driver to another in a multi-driver topology.

Parameters:

jobUuid - the uuid of the job for which to find the drivers.

Returns:

a list of JobDriver instances, possibly empty.

getAllJobDispatches

public List<JobDispatch> getAllJobDispatches(String jobUuid)

Get the dispatches of the specified job accrosss the entire topology. This will return a list of dispatches where the nodes may be attached to more than one server.

Parameters:

jobUuid - the uuid of the job for which to find the dispatches.

Returns:

a list of JobDispatch instances, possibly empty.

addJobMonitoringListener

public void addJobMonitoringListener(JobMonitoringListener listener)

Add a listener to the events emitted by this job monitor.

Parameters:

listener - the listener to add.

removeJobMonitoringListener

public void removeJobMonitoringListener(JobMonitoringListener listener)

Remove a listener to the events emitted by this job monitor.

Parameters:

listener - the listener to remove.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface JobMonitoringHandler