JMX Components (Infinispan Distribution 5.2.23.Final API)

JMX Components available

Activation (Component that handles activating entries that have been passivated to a CacheStore by loading them into memory.)
Cache (Component that represents an individual cache instance.)
CacheLoader (Component that handles loading entries from a CacheStore into memory.)
CacheManager (Component that acts as a manager, factory and container for caches in the system.)
CacheStore (Component that handles storing of entries to a CacheStore from memory.)
DeadlockDetectingLockManager (Information about the number of deadlocks that were detected)
DistributionManager (Component that handles distribution of content across a cluster)
Interpreter (Interpreter component which executes CLI operations)
Invalidation (Component responsible for invalidating entries on remote caches when entries are written to locally.)
JmxStatsCommandInterceptor
LocalTopologyManager (Controls the cache membership and state transfer)
LockManager (Manager that handles MVCC locks for entries)
MassIndexer (Component that rebuilds the index from the cached data)
Passivation (Component that handles passivating entries to a CacheStore on eviction.)
RecoveryAdmin (Exposes tooling for handling transaction recovery.)
RollingUpgradeManager (This component handles the control hooks to handle migrating data from one version of Infinispan to another)
RpcManager (Manages all remote calls to remote cache instances in the cluster.)
StateTransferManager (Component that handles state transfer)
StateTransferManager
Statistics (General statistics such as timings, hit/miss ratio, etc.)
Transactions (Component that manages the cache's participation in JTA transactions.)
Transport (Transport component manages read and write operations to/from server.)
XSiteAdmin (Exposes tooling for handling backing up data to remote sites.)

Component Activation (Class org.infinispan.eviction.ActivationManagerImpl)
Component that handles activating entries that have been passivated to a CacheStore by loading them into memory.

Attributes

Name	Description	Type	Writable
`Activations`	Number of activation events	`String`	false
`statisticsEnabled`	Enables or disables the gathering of statistics by this component	`boolean`	true

Operations

Name	Description	Signature
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`

Component Cache (Class org.infinispan.CacheImpl)
Component that represents an individual cache instance.

Attributes

Name	Description	Type	Writable
`CacheName`	Returns the cache name	`String`	false
`CacheStatus`	Returns the cache status	`String`	false
`ConfigurationAsXmlString`	Returns the cache configuration as XML string	`String`	false

Operations

Name	Description	Signature
`clear`	Clears the cache	`void clear()`
`start`	Starts the cache.	`void start()`
`stop`	Stops the cache.	`void stop()`

Component CacheLoader (Class org.infinispan.interceptors.CacheLoaderInterceptor)
Component that handles loading entries from a CacheStore into memory.

Attributes

Name	Description	Type	Writable
`CacheLoaderLoads`	Number of entries loaded from cache store	`long`	false
`CacheLoaderMisses`	Number of entries that did not exist in cache store	`long`	false
`CacheLoaders`	Returns a collection of cache loader types which configured and enabled	`Collection`	false

Operations

Name	Description	Signature
`disableCacheLoader`	Disable all cache loaders of a given type, where type is a fully qualified class name of the cache loader to disable	`void disableCacheLoader(String p0)`
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`

Component CacheManager (Class org.infinispan.manager.DefaultCacheManager)
Component that acts as a manager, factory and container for caches in the system.

Attributes

Name	Description	Type	Writable
`CacheManagerStatus`	The status of the cache manager instance.	`String`	false
`ClusterMembers`	List of members in the cluster	`String`	false
`ClusterName`	Cluster name	`String`	false
`ClusterSize`	Size of the cluster in number of nodes	`int`	false
`CreatedCacheCount`	The total number of created caches, including the default cache.	`String`	false
`DefinedCacheCount`	The total number of defined caches, excluding the default cache.	`String`	false
`DefinedCacheNames`	The defined cache names and their statuses. The default cache is not included in this representation.	`String`	false
`Name`	The name of this cache manager	`String`	false
`NodeAddress`	The network address associated with this instance	`String`	false
`PhysicalAddresses`	The physical network addresses associated with this instance	`String`	false
`RunningCacheCount`	The total number of running caches, including the default cache.	`String`	false
`Version`	Infinispan version.	`String`	false

Operations

Name	Description	Signature
`startCache`	Starts the default cache associated with this cache manager	`void startCache()`
`startCache`	Starts a named cache from this cache manager	`void startCache(String p0)`

Component CacheStore (Class org.infinispan.interceptors.CacheStoreInterceptor)
Component that handles storing of entries to a CacheStore from memory.

Attributes

Name	Description	Type	Writable
`CacheLoaderStores`	number of cache loader stores	`long`	false

Operations

Name	Description	Signature
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`

Component DeadlockDetectingLockManager (Class org.infinispan.util.concurrent.locks.DeadlockDetectingLockManager)
Information about the number of deadlocks that were detected

Attributes

Name	Description	Type	Writable
`DetectedLocalDeadlocks`	Number of local transaction that were roll backed due to deadlocks	`long`	false
`DetectedRemoteDeadlocks`	Number of remote transaction that were roll backed due to deadlocks	`long`	false
`LocallyInterruptedTransactions`	Number of locally originated transactions that were interrupted as a deadlock situation was detected	`long`	false
`OverlapWithNotDeadlockAwareLockOwners`	Number of situations when we try to determine a deadlock and the other lock owner is NOT a transaction. In this scenario we cannot run the deadlock detection mechanism	`long`	false
`TotalNumberOfDetectedDeadlocks`	Total number of local detected deadlocks	`long`	false

Operations

Name	Description	Signature
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`

Component DistributionManager (Class org.infinispan.distribution.DistributionManagerImpl)
Component that handles distribution of content across a cluster

Operations

Name	Description	Signature
`isAffectedByRehash`	Determines whether a given key is affected by an ongoing rehash, if any.	`boolean isAffectedByRehash(Object p0)`
`isLocatedLocally`	Tells you whether a given key is local to this instance of the cache. Only works with String keys.	`boolean isLocatedLocally(String p0)`
`locateKey`	Locates an object in a cluster. Only works with String keys.	`List locateKey(String p0)`

Component Interpreter (Class org.infinispan.cli.interpreter.Interpreter)
Interpreter component which executes CLI operations

Attributes

Name	Description	Type	Writable
`CacheNames`	Retrieves a list of caches for the cache manager	`String`	false

Operations

Name	Description	Signature
`createSessionId`	Creates a new interpreter session	`String createSessionId(String p0)`
`execute`	Parses and executes IspnQL statements	`Map execute(String p0, String p1)`

Component Invalidation (Class org.infinispan.interceptors.InvalidationInterceptor)
Component responsible for invalidating entries on remote caches when entries are written to locally.

Attributes

Name	Description	Type	Writable
`Invalidations`	Number of invalidations	`long`	false
`StatisticsEnabled`		`boolean`	true

Operations

Name	Description	Signature
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`

Component JmxStatsCommandInterceptor (Class org.infinispan.interceptors.base.JmxStatsCommandInterceptor)

Attributes

Name	Description	Type	Writable
`statisticsEnabled`	Enables or disables the gathering of statistics by this component	`boolean`	true

Operations

Name	Description	Signature
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`

Component LocalTopologyManager (Class org.infinispan.topology.LocalTopologyManagerImpl)
Controls the cache membership and state transfer

Attributes

Name	Description	Type	Writable
`RebalancingEnabled`	Rebalancing enabled	`boolean`	true

Component LockManager (Class org.infinispan.util.concurrent.locks.LockManagerImpl)
Manager that handles MVCC locks for entries

Attributes

Name	Description	Type	Writable
`ConcurrencyLevel`	The concurrency level that the MVCC Lock Manager has been configured with.	`int`	false
`NumberOfLocksAvailable`	The number of exclusive locks that are available.	`int`	false
`NumberOfLocksHeld`	The number of exclusive locks that are held.	`int`	false

Component MassIndexer (Class org.infinispan.query.MassIndexer)
Component that rebuilds the index from the cached data

Operations

Name	Description	Signature
`start`	Starts rebuilding the index	`void start()`

Component Passivation (Class org.infinispan.interceptors.PassivationInterceptor)
Component that handles passivating entries to a CacheStore on eviction.

Attributes

Name	Description	Type	Writable
`Passivations`	Number of passivation events	`String`	false

Operations

Name	Description	Signature
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`

Component RecoveryAdmin (Class org.infinispan.transaction.xa.recovery.RecoveryAdminOperations)
Exposes tooling for handling transaction recovery.

Operations

Name	Description	Signature
`forceCommit`	Forces the commit of an in-doubt transaction	`String forceCommit(long p0)`
`forceCommit`	Forces the commit of an in-doubt transaction	`String forceCommit(int p0, byte p1, byte p2)`
`forceRollback`	Forces the rollback of an in-doubt transaction	`String forceRollback(long p0)`
`forceRollback`	Forces the rollback of an in-doubt transaction	`String forceRollback(int p0, byte p1, byte p2)`
`forget`	Removes recovery info for the given transaction.	`String forget(int p0, byte p1, byte p2)`
`forget`	Removes recovery info for the given transaction.	`String forget(long p0)`
`showInDoubtTransactions`	Shows all the prepared transactions for which the originating node crashed	`String showInDoubtTransactions()`

Component RollingUpgradeManager (Class org.infinispan.upgrade.RollingUpgradeManager)
This component handles the control hooks to handle migrating data from one version of Infinispan to another

Operations

Name	Description	Signature
`disconnectSource`	Disconnects the target cluster from the source cluster according to the specified migrator	`void disconnectSource(String p0)`
`recordKnownGlobalKeyset`	Dumps the global known keyset to a well-known key for retrieval by the upgrade process	`void recordKnownGlobalKeyset()`
`synchronizeData`	Synchronizes data from the old cluster to this using the specified migrator	`long synchronizeData(String p0)`

Component RpcManager (Class org.infinispan.remoting.rpc.RpcManagerImpl)
Manages all remote calls to remote cache instances in the cluster.

Attributes

Name	Description	Type	Writable
`AverageReplicationTime`	The average time spent in the transport layer, in milliseconds	`long`	false
`CommittedViewAsString`	Retrieves the committed view.	`String`	false
`PendingViewAsString`	Retrieves the pending view.	`String`	false
`ReplicationCount`	Number of successful replications	`long`	false
`ReplicationFailures`	Number of failed replications	`long`	false
`StatisticsEnabled`	Statistics enabled	`boolean`	true
`SuccessRatio`	Successful replications as a ratio of total replications	`String`	false
`SuccessRatioFloatingPoint`	Successful replications as a ratio of total replications in numeric double format	`double`	false

Operations

Name	Description	Signature
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`
`setStatisticsEnabled`		`void setStatisticsEnabled(boolean p0)`

Component `StateTransferManager` (Class `org.infinispan.statetransfer.StateTransferManagerImpl`) Component that handles state transfer

Component StateTransferManager (Class org.infinispan.statetransfer.StateTransferManager)

Attributes

Name	Description	Type	Writable
`JoinComplete`	If true, the node has successfully joined the grid and is considered to hold state. If false, the join process is still in progress.	`boolean`	false
`StateTransferInProgress`	Checks whether there is a pending inbound state transfer on this cluster member.	`boolean`	false

Component Statistics (Class org.infinispan.interceptors.CacheMgmtInterceptor)
General statistics such as timings, hit/miss ratio, etc.

Attributes

Name	Description	Type	Writable
`AverageReadTime`	Average number of milliseconds for a read operation on the cache	`long`	false
`AverageWriteTime`	Average number of milliseconds for a write operation in the cache	`long`	false
`ElapsedTime`	Number of seconds since cache started	`long`	false
`Evictions`	Number of cache eviction operations	`long`	false
`HitRatio`	Percentage hit/(hit+miss) ratio for the cache	`double`	false
`Hits`	Number of cache attribute hits	`long`	false
`Misses`	Number of cache attribute misses	`long`	false
`NumberOfEntries`	Number of entries currently in the cache	`int`	false
`ReadWriteRatio`	read/writes ratio for the cache	`double`	false
`RemoveHits`	Number of cache removal hits	`long`	false
`RemoveMisses`	Number of cache removals where keys were not found	`long`	false
`Stores`	number of cache attribute put operations	`long`	false
`TimeSinceReset`	Number of seconds since the cache statistics were last reset	`long`	false

Operations

Name	Description	Signature
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`

Component Transactions (Class org.infinispan.interceptors.TxInterceptor)
Component that manages the cache's participation in JTA transactions.

Attributes

Name	Description	Type	Writable
`Commits`	Number of transaction commits performed since last reset	`long`	false
`Prepares`	Number of transaction prepares performed since last reset	`long`	false
`Rollbacks`	Number of transaction rollbacks performed since last reset	`long`	false
`StatisticsEnabled`		`boolean`	true

Operations

Name	Description	Signature
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`
`setStatisticsEnabled`		`void setStatisticsEnabled(boolean p0)`

Component Transport (Class org.infinispan.server.core.transport.Transport)
Transport component manages read and write operations to/from server.

Attributes

Name	Description	Type	Writable
`HostName`	Returns the host to which the transport binds.	`String`	false
`IdleTimeout`	Returns the idle timeout.	`String`	false
`NumberOfGlobalConnections`	Returns a count of active connections in the cluster. This operation will make remote calls to aggregate results, so latency might have an impact on the speed of calculation of this attribute.	`Integer`	false
`NumberOfLocalConnections`	Returns a count of active connections this server.	`Integer`	false
`NumberWorkerThreads`	Returns the number of worker threads.	`String`	false
`Port`	Returns the port to which the transport binds.	`String`	false
`ReceiveBufferSize`	Returns the receive buffer size.	`String`	false
`SendBufferSize`	Returns the send buffer size.	`String`	false
`TcpNoDelay`	Returns whether TCP no delay was configured or not.	`String`	false
`TotalBytesRead`	Returns the total number of bytes read by the server from clients which includes both protocol and user information.	`String`	false
`TotalBytesWritten`	Returns the total number of bytes written by the server back to clients which includes both protocol and user information.	`String`	false

Component XSiteAdmin (Class org.infinispan.xsite.XSiteAdminOperations)
Exposes tooling for handling backing up data to remote sites.

Operations

Name	Description	Signature
`amendTakeOffline`	Amends the values for 'TakeOffline' functionality on all the nodes in the cluster.	`String amendTakeOffline(String p0, int p1, long p2)`
`bringSiteOnline`	Brings the given site back online on all the cluster.	`String bringSiteOnline(String p0)`
`getTakeOfflineAfterFailures`	Returns the value of the 'afterFailures' for the 'TakeOffline' functionality.	`String getTakeOfflineAfterFailures(String p0)`
`getTakeOfflineMinTimeToWait`	Returns the value of the 'minTimeToWait' for the 'TakeOffline' functionality.	`String getTakeOfflineMinTimeToWait(String p0)`
`setTakeOfflineAfterFailures`	Amends the values for 'afterFailures' for the 'TakeOffline' functionality on all the nodes in the cluster.	`String setTakeOfflineAfterFailures(String p0, int p1)`
`setTakeOfflineMinTimeToWait`	Amends the values for 'minTimeToWait' for the 'TakeOffline' functionality on all the nodes in the cluster.	`String setTakeOfflineMinTimeToWait(String p0, long p1)`
`siteStatus`	Check whether the given backup site is offline or not.	`String siteStatus(String p0)`
`status`	Returns the the status(offline/online) of all the configured backup sites.	`String status()`
`takeSiteOffline`	Takes this site offline in all nodes in the cluster.	`String takeSiteOffline(String p0)`