org.jppf.server.job.management
Interface DriverJobManagementMBean

All Superinterfaces:

NotificationBroadcaster, NotificationEmitter

All Known Implementing Classes:

DriverJobManagement

public interface DriverJobManagementMBean
extends NotificationEmitter

This is the job management MBean interface.

Author:

Laurent Cohen

Field Summary

static String

MBEAN_NAME The name under which this MBean is registered with the MBean server.

Method Summary

void	cancelJob(String jobId) Cancel the job with the specified id.
String[]	getAllJobIds() Get the set of ids for all the jobs currently queued or executing.
JobInformation	getJobInformation(String jobId) Get an object describing the job with the specified id.
NodeJobInformation[]	getNodeInformation(String jobId) Get a list of objects describing the nodes to which the whole or part of a job was dispatched.
void	resumeJob(String jobId) Resume the job with the specified id.
void	suspendJob(String jobId, Boolean requeue) Suspend the job with the specified id.
void	updateMaxNodes(String jobId, Integer maxNodes) Update the maximum number of nodes a job can run on.

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

The name under which this MBean is registered with the MBean server.

See Also:

Constant Field Values

Method Detail

cancelJob

void cancelJob(String jobId)
               throws Exception

Cancel the job with the specified id.

Parameters:

jobId - the id of the job to cancel.

Throws:

Exception - if any error occurs.

suspendJob

void suspendJob(String jobId,
                Boolean requeue)
                throws Exception

Suspend the job with the specified id.

Parameters:

jobId - the id of the job to suspend.

requeue - true if the sub-jobs running on each node should be canceled and requeued, false if they should be left to execute until completion.

Throws:

Exception - if any error occurs.

resumeJob

void resumeJob(String jobId)
               throws Exception

Resume the job with the specified id.

Parameters:

jobId - the id of the job to resume.

Throws:

Exception - if any error occurs.

updateMaxNodes

void updateMaxNodes(String jobId,
                    Integer maxNodes)
                    throws Exception

Update the maximum number of nodes a job can run on.

Parameters:

jobId - the id of the job to update.

maxNodes - the new maximum number of nodes for the job.

Throws:

Exception - if any error occurs.

getAllJobIds

String[] getAllJobIds()
                      throws Exception

Get the set of ids for all the jobs currently queued or executing.

Returns:

an array of ids as strings.

Throws:

Exception - if any error occurs.

getJobInformation

JobInformation getJobInformation(String jobId)
                                 throws Exception

Get an object describing the job with the specified id.

Parameters:

jobId - the id of the job to get information about.

Returns:

an instance of JobInformation.

Throws:

Exception - if any error occurs.

getNodeInformation

NodeJobInformation[] getNodeInformation(String jobId)
                                        throws Exception

Get a list of objects describing the nodes to which the whole or part of a job was dispatched.

Parameters:

jobId - the id of the job for which to find node information.

Returns:

an array of NodeManagementInfo, JobInformation instances.

Throws:

Exception - if any error occurs.