@MXBeanDescription(value="MBean that provides access to Kernal information.") public interface IgniteMXBean
Modifier and Type | Method and Description |
---|---|
void |
dumpDebugInfo()
Dumps debug information for the current node.
|
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 implementations.
|
String |
getCommunicationSpiFormatted()
Gets a formatted instance of fully configured SPI communication implementation.
|
String |
getCopyright()
Gets copyright statement for Ignite 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 implementations.
|
String |
getFullVersion()
Gets string presentation of the version.
|
String |
getGridLoggerFormatted()
Gets a formatted instance of logger that is in grid.
|
String |
getIgniteHome()
Gets Ignite installation home folder.
|
String |
getInstanceName()
Gets optional kernal instance name.
|
String |
getJdkInformation()
Gets JDK information.
|
List<String> |
getLifecycleBeansFormatted()
Gets
toString() representation of of lifecycle beans configured
with Ignite. |
String |
getLoadBalancingSpiFormatted()
Gets a formatted instance of fully configured load balancing SPI implementations.
|
UUID |
getLocalNodeId()
Unique identifier for this node within grid.
|
String |
getMBeanServerFormatted()
Gets a formatted instance of MBean server instance.
|
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 |
getSwapSpaceSpiFormatted()
Gets a formatted instance of configured swapspace SPI implementations.
|
long |
getUpTime()
Gets up-time of the kernal.
|
String |
getUpTimeFormatted()
Gets string presentation of up-time for the kernal.
|
List<String> |
getUserAttributesFormatted()
Gets a list of formatted user-defined attributes added to this node.
|
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.
|
void |
printLastErrors()
Prints errors.
|
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.
|
@MXBeanDescription(value="String presentation of the Ignite version.") String getFullVersion()
@MXBeanDescription(value="Copyright statement for Ignite product.") String getCopyright()
@MXBeanDescription(value="String presentation of the kernal start timestamp.") String getStartTimestampFormatted()
@MXBeanDescription(value="String presentation of up-time for the kernal.") String getUpTimeFormatted()
@MXBeanDescription(value="Start timestamp of the kernal.") long getStartTimestamp()
@MXBeanDescription(value="Up-time of the kernal.") long getUpTime()
@MXBeanDescription(value="Collection of formatted user-defined attributes added to this node.") List<String> getUserAttributesFormatted()
Note that grid will add all System properties and environment properties to grid node attributes also. SPIs may also add node attributes that are used for SPI implementation.
@MXBeanDescription(value="Formatted instance of logger that is in grid.") String getGridLoggerFormatted()
@MXBeanDescription(value="Formatted instance of fully configured thread pool that is used in grid.") String getExecutorServiceFormatted()
@MXBeanDescription(value="Ignite installation home folder.") String getIgniteHome()
@MXBeanDescription(value="Formatted instance of MBean server instance.") String getMBeanServerFormatted()
@MXBeanDescription(value="Unique identifier for this node within grid.") UUID getLocalNodeId()
@MXBeanDescription(value="Whether or not peer class loading (a.k.a. P2P class loading) is enabled.") boolean isPeerClassLoadingEnabled()
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.
true
if peer class loading is enabled, false
otherwise.@MXBeanDescription(value="String representation of lifecycle beans.") List<String> getLifecycleBeansFormatted()
toString()
representation of of lifecycle beans configured
with Ignite.toString()
representation of all lifecycle beans configured
with Ignite.@MXBeanDescription(value="This method allows manually remove the checkpoint with given key. Return true if specified checkpoint was indeed removed, false otherwise.") @MXBeanParametersNames(value="key") @MXBeanParametersDescriptions(value="Checkpoint key to remove.") boolean removeCheckpoint(String key)
key
.key
- Checkpoint key.true
if specified checkpoint was indeed removed, false
otherwise.@MXBeanDescription(value="Pings node with given node ID to see whether it is alive. Returns whether or not node is alive.") @MXBeanParametersNames(value="nodeId") @MXBeanParametersDescriptions(value="String presentation of node ID. See java.util.UUID class for details.") boolean pingNode(String nodeId)
nodeId
- String presentation of node ID. See UUID.fromString(String)
for
details on string formatting.@MXBeanDescription(value="Makes the best attempt to undeploy a task from the whole grid.") @MXBeanParametersNames(value="taskName") @MXBeanParametersDescriptions(value="Name of the task to undeploy.") void undeployTaskFromGrid(String taskName) throws JMException
Note that Ignite 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.
taskName
- Name of the task to undeploy. If task class has ComputeTaskName
annotation,
then task was deployed under a name specified within annotation. Otherwise, full
class name should be used as task's name.JMException
- Thrown if undeploy failed.@MXBeanDescription(value="A shortcut method that executes given task assuming single String argument and String return type. Returns Task return value (assumed of String type).") @MXBeanParametersNames(value={"taskName","arg"}) @MXBeanParametersDescriptions(value={"Name of the task to execute.","Single task execution argument (can be null)."}) String executeTask(String taskName, String arg) throws JMException
java.lang.String
argument
and java.lang.String
return type.taskName
- Name of the task to execute.arg
- Single task execution argument (can be null
).java.lang.String
type).JMException
- Thrown in case when execution failed.@MXBeanDescription(value="Pings node with given host name to see if it is alive. Returns whether or not node is alive.") @MXBeanParametersNames(value="host") @MXBeanParametersDescriptions(value="Host name or IP address of the node to ping.") boolean pingNodeByAddress(String host)
host
- Host name or IP address of the node to ping.@MXBeanDescription(value="Formatted instance of configured discovery SPI implementation.") String getDiscoverySpiFormatted()
@MXBeanDescription(value="Formatted instance of fully configured SPI communication implementation.") String getCommunicationSpiFormatted()
@MXBeanDescription(value="Formatted instance of fully configured deployment SPI implementation.") String getDeploymentSpiFormatted()
@MXBeanDescription(value="Formatted instance of configured checkpoint SPI implementation.") String getCheckpointSpiFormatted()
@MXBeanDescription(value="Formatted instance of configured collision SPI implementations.") String getCollisionSpiFormatted()
@MXBeanDescription(value="Formatted instance of configured swapspace SPI implementations.") String getSwapSpaceSpiFormatted()
@MXBeanDescription(value="Formatted instance of fully configured event SPI implementation.") String getEventStorageSpiFormatted()
@MXBeanDescription(value="Formatted instance of fully configured failover SPI implementations.") String getFailoverSpiFormatted()
@MXBeanDescription(value="Formatted instance of fully configured load balancing SPI implementations.") String getLoadBalancingSpiFormatted()
@MXBeanDescription(value="OS information.") String getOsInformation()
@MXBeanDescription(value="JDK information.") String getJdkInformation()
@MXBeanDescription(value="OS user name.") String getOsUser()
@MXBeanDescription(value="VM name.") String getVmName()
@MXBeanDescription(value="Optional kernal instance name.") String getInstanceName()
null
.@MXBeanDescription(value="Prints last suppressed errors.") void printLastErrors()
@MXBeanDescription(value="Dumps debug information for the current node.") void dumpDebugInfo()
Follow @ApacheIgnite
Ignite Fabric : ver. 1.9.0 Release Date : March 2 2017