org.jppf.management

Interface JPPFDriverAdminMBean

All Superinterfaces:

JPPFAdminMBean, Serializable

All Known Implementing Classes:

JMXDriverConnectionWrapper

public interface JPPFDriverAdminMBean
extends JPPFAdminMBean

MBean interface for the management of a JPPF driver.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MBEAN_NAME Name of the driver's admin MBean.

Fields inherited from interface org.jppf.management.JPPFAdminMBean

DRIVER_MBEAN_NAME, DRIVER_SUFFIX, NODE_MBEAN_NAME, NODE_SUFFIX

Method Summary

Methods

Modifier and Type	Method and Description
String	changeLoadBalancerSettings(String algorithm, Map<Object,Object> parameters) Change the bundle size tuning settings.
Collection<JPPFManagementInfo>	idleNodesInformation() Request the JMX connection information for all the idle nodes attached to the server.
LoadBalancingInformation	loadBalancerInformation() Obtain the current load-balancing settings.
Integer	matchingNodes(ExecutionPolicy policy) Compute the number of nodes that would match the specified execution policy.
Integer	nbIdleNodes() Get the number of nodes currently idle.
Integer	nbNodes() Get the number of nodes attached to the driver.
Collection<JPPFManagementInfo>	nodesInformation() Request the JMX connection information for all the nodes attached to the server.
void	resetStatistics() Reset this server's statistics.
String	restartShutdown(Long shutdownDelay, Long restartDelay) Perform a shutdown or restart of the server.
JPPFStats	statistics() Get the latest statistics snapshot from the JPPF driver.
void	toggleActiveState(NodeSelector selector) Toggle the activate state of the specified nodes.

Methods inherited from interface org.jppf.management.JPPFAdminMBean

systemInformation

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

Name of the driver's admin MBean.

See Also:

Constant Field Values

Method Detail

statistics

JPPFStats statistics()
                     throws Exception

Get the latest statistics snapshot from the JPPF driver.

Returns:

a JPPFStats instance.

Throws:

Exception - if any error occurs.

nbNodes

Integer nbNodes()
                throws Exception

Get the number of nodes attached to the driver.

Returns:

the number of nodes.

Throws:

Exception - if any error occurs.

nodesInformation

Collection<JPPFManagementInfo> nodesInformation()
                                                throws Exception

Request the JMX connection information for all the nodes attached to the server.

Returns:

a collection of NodeManagementInfo instances.

Throws:

Exception - if any error occurs.

restartShutdown

String restartShutdown(Long shutdownDelay,
                     Long restartDelay)
                       throws Exception

Perform a shutdown or restart of the server.

Parameters:

shutdownDelay - the delay before shutting down the server, once the command is received.

restartDelay - the delay before restarting, once the server is shutdown. If it is < 0, no restart occurs.

Returns:

an acknowledgement message.

Throws:

Exception - if any error occurs.

changeLoadBalancerSettings

String changeLoadBalancerSettings(String algorithm,
                                Map<Object,Object> parameters)
                                  throws Exception

Change the bundle size tuning settings.

Parameters:

algorithm - the name opf the load-balancing algorithm to set.

parameters - the algorithm's parameters.

Returns:

an acknowledgement or error message.

Throws:

Exception - if an error occurred while updating the settings.

loadBalancerInformation

LoadBalancingInformation loadBalancerInformation()
                                                 throws Exception

Obtain the current load-balancing settings.

Returns:

an instance of LoadBalancingInformation.

Throws:

Exception - if an error occurred while fetching the settings.

resetStatistics

void resetStatistics()
                     throws Exception

Reset this server's statistics. This method triggers a reset() event via the JPPFDriverStatsManager instance.

Throws:

Exception - if any error occurs.

matchingNodes

Integer matchingNodes(ExecutionPolicy policy)
                      throws Exception

Compute the number of nodes that would match the specified execution policy.

Parameters:

policy - the execution policy to check against the nodes.

Returns:

the number of nodes that match the execution policy, or 0 if no node matches it.

Throws:

Exception - if any error occurs.

nbIdleNodes

Integer nbIdleNodes()
                    throws Exception

Get the number of nodes currently idle.

Returns:

the number of idle nodes.

Throws:

Exception - if any error occurs.

idleNodesInformation

Collection<JPPFManagementInfo> idleNodesInformation()
                                                    throws Exception

Request the JMX connection information for all the idle nodes attached to the server.

Returns:

a collection of NodeManagementInfo instances.

Throws:

Exception - if any error occurs.

toggleActiveState

void toggleActiveState(NodeSelector selector)
                       throws Exception

Toggle the activate state of the specified nodes. Nodes in 'active' state will be deactivated, nodes in 'inactive' state will be activated.

Parameters:

selector - determines which nodes will be activated or deactivated.

Throws:

Exception - if any error occurs.