Package org.apache.ignite.mxbean

Interface IgniteMXBean

  • @MXBeanDescription("MBean that provides access to Kernal information.")
public interface IgniteMXBean
    This interface defines JMX view on kernal.

    • Method Detail

      • getFullVersion

        @Deprecated
@MXBeanDescription("String presentation of the Ignite version.")
String getFullVersion()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.fullVersion" instead.
        Gets string presentation of the version.
        Returns:
        String presentation of the version.

      • getCopyright

        @Deprecated
@MXBeanDescription("Copyright statement for Ignite product.")
String getCopyright()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.copyright" instead.
        Gets copyright statement for Ignite product.
        Returns:
        Copyright statement for Ignite product.

      • getStartTimestampFormatted

        @Deprecated
@MXBeanDescription("Start timestamp of the kernal.")
String getStartTimestampFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.startTimestampFormatted" instead.
        Gets string presentation of the kernal start timestamp.
        Returns:
        String presentation of the kernal start timestamp.

      • isRebalanceEnabled

        @Deprecated
@MXBeanDescription("Rebalance enabled flag.")
boolean isRebalanceEnabled()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.isRebalanceEnabled" instead.
        Gets rebalance enabled flag.
        Returns:
        Rebalance enabled flag.

      • rebalanceEnabled

        @MXBeanParametersDescriptions({"Enable cache partitions rebalance on node.","Disable cache partitions rebalance on node."})
void rebalanceEnabled​(boolean rebalanceEnabled)
        Enable or disable cache partition rebalance per node.
        Parameters:
        rebalanceEnabled - If true then set rebalance to enabled state.

      • getUpTimeFormatted

        @Deprecated
@MXBeanDescription("String presentation of up-time for the kernal.")
String getUpTimeFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.uptimeFormatted" instead.
        Gets string presentation of up-time for the kernal.
        Returns:
        String presentation of up-time for the kernal.

      • getStartTimestamp

        @Deprecated
@MXBeanDescription("Start timestamp of the kernal.")
long getStartTimestamp()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.startTimestamp" instead.
        Get start timestamp of the kernal.
        Returns:
        Start timestamp of the kernal.

      • getLongJVMPausesCount

        @Deprecated
@MXBeanDescription("Long JVM pauses count.")
long getLongJVMPausesCount()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.longJVMPausesCount" instead.
        Gets long JVM pauses count.
        Returns:
        Long JVM pauses count.

      • getLongJVMPausesTotalDuration

        @Deprecated
@MXBeanDescription("Long JVM pauses total duration.")
long getLongJVMPausesTotalDuration()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.longJVMPausesTotalDuration" instead.
        Gets long JVM pauses total duration.
        Returns:
        Long JVM pauses total duration.

      • getUserAttributesFormatted

        @Deprecated
@MXBeanDescription("Collection of formatted user-defined attributes added to this node.")
List<String> getUserAttributesFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.userAttributesFormatted" instead.
        Gets a list 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. SPIs may also add node attributes that are used for SPI implementation.

        Returns:
        User defined attributes for this node.

      • getGridLoggerFormatted

        @Deprecated
@MXBeanDescription("Formatted instance of logger that is in grid.")
String getGridLoggerFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.gridLoggerFormatted" instead.
        Gets a formatted instance of logger that is in grid.
        Returns:
        Logger that is used in grid.

      • getExecutorServiceFormatted

        @Deprecated
@MXBeanDescription("Formatted instance of fully configured thread pool that is used in grid.")
String getExecutorServiceFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.executorServiceFormatted" instead.
        Gets a formatted instance of fully configured thread pool that is used in grid.
        Returns:
        Thread pool implementation that is used in grid.

      • getMBeanServerFormatted

        @Deprecated
@MXBeanDescription("Formatted instance of MBean server instance.")
String getMBeanServerFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.mBeanServerFormatted" instead.
        Gets a formatted instance of MBean server instance.
        Returns:
        MBean server instance.

      • getLocalNodeId

        @Deprecated
@MXBeanDescription("Unique identifier for this node within grid.")
UUID getLocalNodeId()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.localNodeId" instead.
        Unique identifier for this node within grid.
        Returns:
        Unique identifier for this node within grid.

      • isPeerClassLoadingEnabled

        @Deprecated
@MXBeanDescription("Whether or not peer class loading (a.k.a. P2P class loading) is enabled.")
boolean isPeerClassLoadingEnabled()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.isPeerClassLoadingEnabled" instead.
        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

        @Deprecated
@MXBeanDescription("String representation of lifecycle beans.")
List<String> getLifecycleBeansFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.lifecycleBeansFormatted" instead.
        Gets toString() representation of of lifecycle beans configured with Ignite.
        Returns:
        toString() representation of all lifecycle beans configured with Ignite.

      • removeCheckpoint

        @MXBeanDescription("This method allows manually remove the checkpoint with given key. Return true if specified checkpoint was indeed removed, false otherwise.")
boolean removeCheckpoint​(@MXBeanParameter(name="key",description="Checkpoint key to remove.")
                         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

        @MXBeanDescription("Pings node with given node ID to see whether it is alive. Returns whether or not node is alive.")
boolean pingNode​(@MXBeanParameter(name="nodeId",description="String presentation of node ID. See java.util.UUID class for details.")
                 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.

      • active

        @Deprecated
@MXBeanDescription("Checks Ignite grid is active or is not active.")
boolean active()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.active" instead.
        Checks if Ignite grid is active. If Ignite grid is not active return False.
        Returns:
        True if grid is active. False If grid is not active.

      • undeployTaskFromGrid

        @MXBeanDescription("Makes the best attempt to undeploy a task from the whole grid.")
void undeployTaskFromGrid​(@MXBeanParameter(name="taskName",description="Name of the task to undeploy.")
                          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 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.

        Parameters:
        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.
        Throws:
        JMException - Thrown if undeploy failed.

      • executeTask

        @MXBeanDescription("A shortcut method that executes given task assuming single String argument and String return type. Returns Task return value (assumed of String type).")
String executeTask​(@MXBeanParameter(name="taskName",description="Name of the task to execute.")
                   String taskName,
                   @MXBeanParameter(name="arg",description="Single task execution argument (can be null).")
                   String arg)
            throws JMException
        A shortcut method that executes given task assuming single java.lang.String argument and java.lang.String return type.
        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).
        Throws:
        JMException - Thrown in case when execution failed.

      • pingNodeByAddress

        @MXBeanDescription("Pings node with given host name to see if it is alive. Returns whether or not node is alive.")
boolean pingNodeByAddress​(@MXBeanParameter(name="host",description="Host name or IP address of the node to ping.")
                          String host)
                   throws JMException
        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.
        Throws:
        JMException - When ping failed.

      • getDiscoverySpiFormatted

        @Deprecated
@MXBeanDescription("Formatted instance of configured discovery SPI implementation.")
String getDiscoverySpiFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.discoverySpiFormatted" instead.
        Gets a formatted instance of configured discovery SPI implementation.
        Returns:
        Grid discovery SPI implementation.

      • getCommunicationSpiFormatted

        @Deprecated
@MXBeanDescription("Formatted instance of fully configured SPI communication implementation.")
String getCommunicationSpiFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.communicationSpiFormatted" instead.
        Gets a formatted instance of fully configured SPI communication implementation.
        Returns:
        Grid communication SPI implementation.

      • getDeploymentSpiFormatted

        @Deprecated
@MXBeanDescription("Formatted instance of fully configured deployment SPI implementation.")
String getDeploymentSpiFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.deploymentSpiFormatted" instead.
        Gets a formatted instance of fully configured deployment SPI implementation.
        Returns:
        Grid deployment SPI implementation.

      • getCheckpointSpiFormatted

        @Deprecated
@MXBeanDescription("Formatted instance of configured checkpoint SPI implementation.")
String getCheckpointSpiFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.checkpointSpiFormatted" instead.
        Gets a formatted instance of configured checkpoint SPI implementation.
        Returns:
        Grid checkpoint SPI implementation.

      • getCollisionSpiFormatted

        @Deprecated
@MXBeanDescription("Formatted instance of configured collision SPI implementations.")
String getCollisionSpiFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.collisionSpiFormatted" instead.
        Gets a formatted instance of configured collision SPI implementations.
        Returns:
        Grid collision SPI implementations.

      • getEventStorageSpiFormatted

        @Deprecated
@MXBeanDescription("Formatted instance of fully configured event SPI implementation.")
String getEventStorageSpiFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.eventStorageSpiFormatted" instead.
        Gets a formatted instance of fully configured event SPI implementation.
        Returns:
        Grid event SPI implementation.

      • getFailoverSpiFormatted

        @Deprecated
@MXBeanDescription("Formatted instance of fully configured failover SPI implementations.")
String getFailoverSpiFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.failoverSpiFormatted" instead.
        Gets a formatted instance of fully configured failover SPI implementations.
        Returns:
        Grid failover SPI implementations.

      • getLoadBalancingSpiFormatted

        @Deprecated
@MXBeanDescription("Formatted instance of fully configured load balancing SPI implementations.")
String getLoadBalancingSpiFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.loadBalancingSpiFormatted" instead.
        Gets a formatted instance of fully configured load balancing SPI implementations.
        Returns:
        Grid load balancing SPI implementations.

      • getInstanceName

        @Deprecated
@MXBeanDescription("Optional kernal instance name.")
String getInstanceName()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.InstanceName" instead.
        Gets optional kernal instance name. It can be null.
        Returns:
        Optional kernal instance name.

      • printLastErrors

        @MXBeanDescription("Prints last suppressed errors.")
void printLastErrors()
        Prints errors.

      • dumpDebugInfo

        @MXBeanDescription("Dumps debug information for the current node.")
void dumpDebugInfo()
        Dumps debug information for the current node.

      • getCurrentCoordinatorFormatted

        @Deprecated
@MXBeanDescription("Formatted properties of current coordinator.")
String getCurrentCoordinatorFormatted()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.currentCoordinatorFormatted" instead.
        Gets a formatted properties of current coordinator.
        Returns:
        String representation of current coordinator node.

      • isNodeInBaseline

        @Deprecated
@MXBeanDescription("Baseline node flag.")
boolean isNodeInBaseline()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.isNodeInBaseline" instead.
        Gets a flag whether local node is in baseline. Returns false if baseline topology is not established.
        Returns:
        Return a baseline flag.

      • clearNodeLocalMap

        @MXBeanDescription("Clears local node map.")
void clearNodeLocalMap()
        Clears node local map.

      • clusterState

        @MXBeanDescription("Changes current cluster state.")
void clusterState​(@MXBeanParameter(name="state",description="New cluster state.")
                  String state,
                  @MXBeanParameter(name="forceDeactivation",description="If true, cluster deactivation will be forced.")
                  boolean forceDeactivation)
           throws JMException
        Changes current cluster state.

        NOTE: Deactivation clears in-memory caches (without persistence) including the system caches.

        Parameters:
        state - String representation of new cluster state.
        forceDeactivation - If true, cluster deactivation will be forced.
        Throws:
        JMException - if deactivation is forbidden or stopped.

      • lastClusterStateChangeTime

        @Deprecated
@MXBeanDescription("Unix time of last cluster state change operation.")
long lastClusterStateChangeTime()
        Deprecated.
        Check the ReadOnlyMetricRegistry with "name=ignite.lastClusterStateChangeTime" instead.
        Gets last cluster state change operation.
        Returns:
        Unix time of last cluster state change operation.