org.jppf.management
Interface JPPFNodeAdminMBean

All Superinterfaces:

JPPFAdminMBean, Serializable

All Known Implementing Classes:

JMXNodeConnectionWrapper, JPPFNodeAdmin

public interface JPPFNodeAdminMBean
extends JPPFAdminMBean

Exposed interface of the JPPF node management bean.

Author:

Laurent Cohen

Field Summary

Fields inherited from interface org.jppf.management.JPPFAdminMBean

DRIVER_MBEAN_NAME, DRIVER_SUFFIX, NODE_MBEAN_NAME, NODE_SUFFIX

Method Summary

void	cancelJob(String jobId, Boolean requeue) Cancel the job with the specified id.
void	cancelTask(String id) Cancel the execution of the tasks with the specified id.
Serializable	notification() Get the latest task notification from the node.
void	resetTaskCounter() Reset the node's executed tasks counter to zero.
void	restart() Restart the node.
void	restartTask(String id) Restart the execution of the tasks with the specified id.
void	setTaskCounter(Integer n) Reset the node's executed tasks counter to the specified value.
void	shutdown() Shutdown the node.
JPPFNodeState	state() Get the latest state information from the node.
JPPFSystemInformation	systemInformation() Get detailed information about the node's JVM properties, environment variables and runtime information such as memory usage and available processors.
void	updateConfiguration(Map<Object,Object> config, Boolean reconnect) Update the configuration properties of the node.
void	updateThreadPoolSize(Integer size) Set the size of the node's thread pool.
void	updateThreadsPriority(Integer newPriority) Update the priority of all execution threads.

Method Detail

state

JPPFNodeState state()
                    throws Exception

Get the latest state information from the node.

Returns:

a JPPFNodeState information.

Throws:

Exception - if any error occurs.

notification

Serializable notification()
                          throws Exception

Get the latest task notification from the node.

Returns:

the notification as a Serializable object.

Throws:

Exception - if any error occurs.

cancelTask

void cancelTask(String id)
                throws Exception

Cancel the execution of the tasks with the specified id.

Parameters:

id - the id of the tasks to cancel.

Throws:

Exception - if any error occurs.

restartTask

void restartTask(String id)
                 throws Exception

Restart the execution of the tasks with the specified id.
The task(s) will be restarted even if their execution has already completed.

Parameters:

id - the id of the task or tasks to restart.

Throws:

Exception - if any error occurs.

updateThreadPoolSize

void updateThreadPoolSize(Integer size)
                          throws Exception

Set the size of the node's thread pool.

Parameters:

size - the size as an int.

Throws:

Exception - if any error occurs.

updateThreadsPriority

void updateThreadsPriority(Integer newPriority)
                           throws Exception

Update the priority of all execution threads.

Parameters:

newPriority - the new priority to set.

Throws:

Exception - if an error is raised when invoking the node mbean.

systemInformation

JPPFSystemInformation systemInformation()
                                        throws Exception

Get detailed information about the node's JVM properties, environment variables and runtime information such as memory usage and available processors.

Returns:

a JPPFSystemInformation instance.

Throws:

Exception - if any error occurs.

restart

void restart()
             throws Exception

Restart the node.

Throws:

Exception - if any error occurs.

shutdown

void shutdown()
              throws Exception

Shutdown the node.

Throws:

Exception - if any error occurs.

resetTaskCounter

void resetTaskCounter()
                      throws Exception

Reset the node's executed tasks counter to zero.

Throws:

Exception - if any error occurs.

setTaskCounter

void setTaskCounter(Integer n)
                    throws Exception

Reset the node's executed tasks counter to the specified value.

Parameters:

n - the number to set the task counter to.

Throws:

Exception - if any error occurs.

updateConfiguration

void updateConfiguration(Map<Object,Object> config,
                         Boolean reconnect)
                         throws Exception

Update the configuration properties of the node.

Parameters:

config - the set of properties to update.

reconnect - - specifies whether the node should reconnect ot the driver after updating the properties.

Throws:

Exception - if any error occurs.

cancelJob

void cancelJob(String jobId,
               Boolean requeue)
               throws Exception

Cancel the job with the specified id.

Parameters:

jobId - the id of the job to cancel.

requeue - true if the job should be requeued on the server side, false otherwise.

Throws:

Exception - if any error occurs.