org.gridgain.grid
Interface GridKernalMBean

@Apache20LicenseCompatible
@GridMBeanDescription(value="MBean that provides access to Kernal information.")
public interface GridKernalMBean

This interface defines JMX view on kernal.



See Also:

Documentation
Email Support
Online Forums
Issue Tracking

Author: 2005-2008 Copyright © GridGain Systems. All Rights Reserved. ver. 2.1.0

	Nikita Ivanov, GridGain Systems nivanov@gridgain.com
	Dmitriy Setrakyan, GridGain Systems dsetrakyan@gridgain.com
	Alexander Magdenko, GridGain Systems amagdenko@gridgain.com
	Boris Suchodoev, GridGain Systems bsuchodoev@gridgain.com
	Denis Kharlamov, GridGain Systems dkharlamov@gridgain.com
	close

Method Summary

String	executeTask(String taskName, String arg) A shortcut method that executes given task assuming single java.lang.String argument and java.lang.String return type.
String	getCheckpointSpiFormatted() Gets a formatted instance of configured checkpoint SPI implementation.
String	getCollisionSpiFormatted() Gets a formatted instance of configured collision SPI implementation.
String	getCommunicationSpiFormatted() Gets a formatted instance of fully configured SPI communication implementation.
String	getCopyright() Gets copyright statement for GridGain product.
String	getDeploymentSpiFormatted() Gets a formatted instance of fully configured deployment SPI implementation.
String	getDiscoverySpiFormatted() Gets a formatted instance of configured discovery SPI implementation.
String	getEventStorageSpiFormatted() Gets a formatted instance of fully configured event SPI implementation.
String	getExecutorServiceFormatted() Gets a formatted instance of fully configured thread pool that is used in grid.
String	getFailoverSpiFormatted() Gets a formatted instance of fully configured failover SPI implementation.
String	getGridGainHome() Gets GridGain installation home folder.
String	getGridLoggerFormatted() Gets a formatted instance of logger that is in grid.
String	getInstanceName() Gets optional kernal instance name.
String	getJdkInformation() Gets JDK information.
String	getLicenseFilePath() Gets file path of the license.
Collection<String>	getLifecycleBeansFormatted() Gets toString() representation of of lifecycle beans configured with GridGain.
String	getLoadBalancingSpiFormatted() Gets a formatted instance of fully configured load balancing SPI implementation.
UUID	getLocalNodeId() Unique identifier for this node within grid.
String	getMBeanServerFormatted() Gets a formatted instance of MBean server instance.
String	getMetricsSpiFormatted() Gets a formatted instance of fully configured local metrics SPI implementation.
String	getOsInformation() Gets OS information.
String	getOsUser() Gets OS user.
long	getStartTimestamp() Get start timestamp of the kernal.
String	getStartTimestampFormatted() Gets string presentation of the kernal start timestamp.
String	getTopologySpiFormatted() Gets a formatted instance of fully configured topology SPI implementation.
String	getTracingSpiFormatted() Gets a formatted instance of fully configured tracing SPI implementation.
long	getUpTime() Gets up-time of the kernal.
String	getUpTimeFormatted() Gets string presentation of up-time for the kernal.
Collection<String>	getUserAttributesFormatted() Gets a collection of formatted user-defined attributes added to this node.
String	getVersion() Gets string presentation of the version.
String	getVmName() Gets VM name.
boolean	isPeerClassLoadingEnabled() Returns true if peer class loading is enabled, false otherwise.
boolean	pingNode(String nodeId) Pings node with given node ID to see whether it is alive.
boolean	pingNodeByAddress(String host) Pings node with given host name to see if it is alive.
boolean	removeCheckpoint(String key) This method allows manually remove the checkpoint with given key.
void	undeployTaskFromGrid(String taskName) Makes the best attempt to undeploy a task from the whole grid.

Method Detail

getLicenseFilePath

@GridMBeanDescription(value="File path of the license.")
String getLicenseFilePath()

Gets file path of the license.

Returns:

File path of the license.

getVersion

@GridMBeanDescription(value="String presentation of the GridGain version.")
String getVersion()

Gets string presentation of the version.

Returns:

String presentation of the version.

getCopyright

@GridMBeanDescription(value="Copyright statement for GridGain product.")
String getCopyright()

Gets copyright statement for GridGain product.

Returns:

Copyright statement for GridGain product.

getStartTimestampFormatted

@GridMBeanDescription(value="String presentation of the kernal start timestamp.")
String getStartTimestampFormatted()

Gets string presentation of the kernal start timestamp.

Returns:

String presentation of the kernal start timestamp.

getUpTimeFormatted

@GridMBeanDescription(value="String presentation of up-time for the kernal.")
String getUpTimeFormatted()

Gets string presentation of up-time for the kernal.

Returns:

String presentation of up-time for the kernal.

getStartTimestamp

@GridMBeanDescription(value="Start timestamp of the kernal.")
long getStartTimestamp()

Get start timestamp of the kernal.

Returns:

Start timestamp of the kernal.

getUpTime

@GridMBeanDescription(value="Up-time of the kernal.")
long getUpTime()

Gets up-time of the kernal.

Returns:

Up-time of the kernal.

getUserAttributesFormatted

@GridMBeanDescription(value="Collection of formatted user-defined attributes added to this node.")
Collection<String> getUserAttributesFormatted()

Gets a collection of formatted user-defined attributes added to this node.

Note that grid will add all System properties and environment properties to grid node attributes also. SPI's may also add node attributes that are used for SPI implementation.

Returns:

User defined attributes for this node.

getGridLoggerFormatted

@GridMBeanDescription(value="Formatted instance of logger that is in grid.")
String getGridLoggerFormatted()

Gets a formatted instance of logger that is in grid.

Returns:

Logger that is used in grid.

getExecutorServiceFormatted

@GridMBeanDescription(value="Formatted instance of fully configured thread pool that is used in grid.")
String getExecutorServiceFormatted()

Gets a formatted instance of fully configured thread pool that is used in grid.

Returns:

Thread pool implementation that is used in grid.

getGridGainHome

@GridMBeanDescription(value="GridGain installation home folder.")
String getGridGainHome()

Gets GridGain installation home folder.

Returns:

GridGain installation home.

getMBeanServerFormatted

@GridMBeanDescription(value="Formatted instance of MBean server instance.")
String getMBeanServerFormatted()

Gets a formatted instance of MBean server instance.

Returns:

MBean server instance.

getLocalNodeId

@GridMBeanDescription(value="Unique identifier for this node within grid.")
UUID getLocalNodeId()

Unique identifier for this node within grid.

Returns:

Unique identifier for this node within grid.

isPeerClassLoadingEnabled

@GridMBeanDescription(value="Whether or not peer class loading (a.k.a. P2P class loading) is enabled.")
boolean isPeerClassLoadingEnabled()

Returns true if peer class loading is enabled, false otherwise. Default value is true.

When peer class loading is enabled and task is not deployed on local node, local node will try to load classes from the node that initiated task execution. This way, a task can be physically deployed only on one node and then internally penetrate to all other nodes.

Returns:

true if peer class loading is enabled, false otherwise.

getLifecycleBeansFormatted

@GridMBeanDescription(value="String representation of lifecycle beans.")
Collection<String> getLifecycleBeansFormatted()

Gets toString() representation of of lifecycle beans configured with GridGain.

Returns:

toString() representation of all lifecycle beans configured with GridGain.

removeCheckpoint

@GridMBeanDescription(value="This method allows manually remove the checkpoint with given key. Return true if specified checkpoint was indeed removed, false otherwise.")
@GridMBeanParametersNames(value="key")
@GridMBeanParametersDescriptions(value="Checkpoint key to remove.")
boolean removeCheckpoint(String key)

This method allows manually remove the checkpoint with given key.

Parameters:

key - Checkpoint key.

Returns:

true if specified checkpoint was indeed removed, false otherwise.

pingNode

@GridMBeanDescription(value="Pings node with given node ID to see whether it is alive. Returns whether or not node is alive.")
@GridMBeanParametersNames(value="nodeId")
@GridMBeanParametersDescriptions(value="String presentation of node ID. See java.util.UUID class for details.")
boolean pingNode(String nodeId)

Pings node with given node ID to see whether it is alive.

Parameters:

nodeId - String presentation of node ID. See UUID.fromString(String) for details on string formatting.

Returns:

Whether or not node is alive.

undeployTaskFromGrid

@GridMBeanDescription(value="Makes the best attempt to undeploy a task from the whole grid.")
@GridMBeanParametersNames(value="taskName")
@GridMBeanParametersDescriptions(value="Name of the task to undeploy.")
void undeployTaskFromGrid(String taskName)
                          throws JMException

Makes the best attempt to undeploy a task from the whole grid. Note that this method returns immediately and does not wait until the task will actually be undeployed on every node.

Note that GridGain maintains internal versions for grid tasks in case of redeployment. This method will attempt to undeploy all versions on the grid task with given name.

Throws:

JMException - Thrown if undeploy failed.

Parameters:

taskName - Name of the task to undeploy. If task class has GridTaskName annotation, then task was deployed under a name specified within annotation. Otherwise, full class name should be used as task's name.

executeTask

@GridMBeanDescription(value="A shortcut method that executes given task assuming single String argument and String return type. Returns Task return value (assumed of String type).")
@GridMBeanParametersNames(value={"taskName","arg"})
@GridMBeanParametersDescriptions(value={"Name of the task to execute.","Single task execution argument (can be null)."})
String executeTask(String taskName,
                                                                                                 String arg)
                   throws JMException

A shortcut method that executes given task assuming single java.lang.String argument and java.lang.String return type.

Throws:

JMException - Thrown in case when execution failed.

Parameters:

taskName - Name of the task to execute.

arg - Single task execution argument (can be null).

Returns:

Task return value (assumed of java.lang.String type).

pingNodeByAddress

@GridMBeanDescription(value="Pings node with given host name to see if it is alive. Returns whether or not node is alive.")
@GridMBeanParametersNames(value="host")
@GridMBeanParametersDescriptions(value="Host name or IP address of the node to ping.")
boolean pingNodeByAddress(String host)

Pings node with given host name to see if it is alive.

Parameters:

host - Host name or IP address of the node to ping.

Returns:

Whether or not node is alive.

getDiscoverySpiFormatted

@GridMBeanDescription(value="Formatted instance of configured discovery SPI implementation.")
String getDiscoverySpiFormatted()

Gets a formatted instance of configured discovery SPI implementation.

Returns:

Grid discovery SPI implementation.

getCommunicationSpiFormatted

@GridMBeanDescription(value="Formatted instance of fully configured SPI communication implementation.")
String getCommunicationSpiFormatted()

Gets a formatted instance of fully configured SPI communication implementation.

Returns:

Grid communication SPI implementation.

getDeploymentSpiFormatted

@GridMBeanDescription(value="Formatted instance of fully configured deployment SPI implementation.")
String getDeploymentSpiFormatted()

Gets a formatted instance of fully configured deployment SPI implementation.

Returns:

Grid deployment SPI implementation.

getCheckpointSpiFormatted

@GridMBeanDescription(value="Formatted instance of configured checkpoint SPI implementation.")
String getCheckpointSpiFormatted()

Gets a formatted instance of configured checkpoint SPI implementation.

Returns:

Grid checkpoint SPI implementation.

getCollisionSpiFormatted

@GridMBeanDescription(value="Formatted instance of configured collision SPI implementation.")
String getCollisionSpiFormatted()

Gets a formatted instance of configured collision SPI implementation.

Returns:

Grid collision SPI implementation.

getEventStorageSpiFormatted

@GridMBeanDescription(value="Formatted instance of fully configured event SPI implementation.")
String getEventStorageSpiFormatted()

Gets a formatted instance of fully configured event SPI implementation.

Returns:

Grid event SPI implementation.

getFailoverSpiFormatted

@GridMBeanDescription(value="Formatted instance of fully configured failover SPI implementation.")
String getFailoverSpiFormatted()

Gets a formatted instance of fully configured failover SPI implementation.

Returns:

Grid failover SPI implementation.

getLoadBalancingSpiFormatted

@GridMBeanDescription(value="Formatted instance of fully configured load balancing SPI implementation.")
String getLoadBalancingSpiFormatted()

Gets a formatted instance of fully configured load balancing SPI implementation.

Returns:

Grid load balancing SPI implementation.

getTopologySpiFormatted

@GridMBeanDescription(value="Formatted instance of fully configured topology SPI implementation.")
String getTopologySpiFormatted()

Gets a formatted instance of fully configured topology SPI implementation.

Returns:

Grid topology SPI implementation.

getMetricsSpiFormatted

@GridMBeanDescription(value="Formatted instance of fully configured local metrics SPI implementation.")
String getMetricsSpiFormatted()

Gets a formatted instance of fully configured local metrics SPI implementation.

Returns:

Grid local metrics SPI implementation.

getTracingSpiFormatted

@GridMBeanDescription(value="Formatted instance of fully configured tracing SPI implementation.")
String getTracingSpiFormatted()

Gets a formatted instance of fully configured tracing SPI implementation.

Returns:

Grid tracing SPI implementation.

getOsInformation

@GridMBeanDescription(value="OS information.")
String getOsInformation()

Gets OS information.

Returns:

OS information.

getJdkInformation

@GridMBeanDescription(value="JDK information.")
String getJdkInformation()

Gets JDK information.

Returns:

JDK information.

getOsUser

@GridMBeanDescription(value="OS user name.")
String getOsUser()

Gets OS user.

Returns:

OS user name.

getVmName

@GridMBeanDescription(value="VM name.")
String getVmName()

Gets VM name.

Returns:

VM name.

getInstanceName

@GridMBeanDescription(value="Optional kernal instance name.")
String getInstanceName()

Gets optional kernal instance name. It can be null.

Returns:

Optional kernal instance name.