| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.geode.management (Apache Geode 1.15.1)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.geode.management (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/lang/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/geode/management/api/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/management/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.geode.management</h1> |
| <div class="docSummary"> |
| <div class="block">A set of APIs for retrieving information and statistics for GemFire components as well as controlling the startup, shutdown and runtime of those components.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/AsyncEventQueueMXBean.html" title="interface in org.apache.geode.management">AsyncEventQueueMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to an <a href="../../../../org/apache/geode/cache/asyncqueue/AsyncEventQueue.html" title="interface in org.apache.geode.cache.asyncqueue"><code>AsyncEventQueue</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/BackupStatus.html" title="interface in org.apache.geode.management">BackupStatus</a></td> |
| <td class="colLast"> |
| <div class="block">The status of a backup operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/CacheServerMXBean.html" title="interface in org.apache.geode.management">CacheServerMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to information and management functionality for a <a href="../../../../org/apache/geode/cache/server/CacheServer.html" title="interface in org.apache.geode.cache.server"><code>CacheServer</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/DiskBackupStatus.html" title="interface in org.apache.geode.management">DiskBackupStatus</a></td> |
| <td class="colLast"> |
| <div class="block">Composite data type used to distribute the status of disk backup operations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html" title="interface in org.apache.geode.management">DiskStoreMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to information and management functionality for a <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/DistributedLockServiceMXBean.html" title="interface in org.apache.geode.management">DistributedLockServiceMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to information for a named instance of <a href="../../../../org/apache/geode/distributed/DistributedLockService.html" title="class in org.apache.geode.distributed"><code>DistributedLockService</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/DistributedRegionMXBean.html" title="interface in org.apache.geode.management">DistributedRegionMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to information and management functionality for a <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html" title="interface in org.apache.geode.management">DistributedSystemMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to information and management operations for a |
| <a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed"><code>DistributedSystem</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html" title="interface in org.apache.geode.management">GatewayReceiverMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to information and management functionality for a |
| <a href="../../../../org/apache/geode/cache/wan/GatewayReceiver.html" title="interface in org.apache.geode.cache.wan"><code>GatewayReceiver</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html" title="interface in org.apache.geode.management">GatewaySenderMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to information and management functionality for a |
| <a href="../../../../org/apache/geode/cache/wan/GatewaySender.html" title="interface in org.apache.geode.cache.wan"><code>GatewaySender</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/JMXNotificationType.html" title="interface in org.apache.geode.management">JMXNotificationType</a></td> |
| <td class="colLast"> |
| <div class="block">Enumerated type for JMX notification types emitted by GemFire management system.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/JMXNotificationUserData.html" title="interface in org.apache.geode.management">JMXNotificationUserData</a></td> |
| <td class="colLast"> |
| <div class="block">This interface acts as UserData section of JMX notifications of type "system.alert".</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/LocatorMXBean.html" title="interface in org.apache.geode.management">LocatorMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to information and management functionality for a <a href="../../../../org/apache/geode/distributed/Locator.html" title="class in org.apache.geode.distributed"><code>Locator</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/LockServiceMXBean.html" title="interface in org.apache.geode.management">LockServiceMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to information and management functionality for a |
| <code>DLockService</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/ManagerMXBean.html" title="interface in org.apache.geode.management">ManagerMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to information and management functionality for a <code>Manager</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/MemberMXBean.html" title="interface in org.apache.geode.management">MemberMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to information and management functionality for a |
| <a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed"><code>DistributedMember</code></a> of the GemFire distributed system.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/RegionMXBean.html" title="interface in org.apache.geode.management">RegionMXBean</a></td> |
| <td class="colLast"> |
| <div class="block">MBean that provides access to information and management functionality for a local |
| <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/ClientHealthStatus.html" title="class in org.apache.geode.management">ClientHealthStatus</a></td> |
| <td class="colLast"> |
| <div class="block">Composite data type used to distribute statistics which can be used to determine the health of a |
| cache client.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/ClientQueueDetail.html" title="class in org.apache.geode.management">ClientQueueDetail</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/DiskBackupResult.html" title="class in org.apache.geode.management">DiskBackupResult</a></td> |
| <td class="colLast"> |
| <div class="block">Composite data type used to distribute the results of a disk backup operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/DiskMetrics.html" title="class in org.apache.geode.management">DiskMetrics</a></td> |
| <td class="colLast"> |
| <div class="block">Composite data type used to distribute metrics for a <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/EvictionAttributesData.html" title="class in org.apache.geode.management">EvictionAttributesData</a></td> |
| <td class="colLast"> |
| <div class="block">Composite data type used to distribute the eviction attributes for a <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/FixedPartitionAttributesData.html" title="class in org.apache.geode.management">FixedPartitionAttributesData</a></td> |
| <td class="colLast"> |
| <div class="block">Composite date type used to distribute the fixed partition attributes for a <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/GemFireProperties.html" title="class in org.apache.geode.management">GemFireProperties</a></td> |
| <td class="colLast"> |
| <div class="block">Composite Data type to be used by member to depict gemfire properties in key value manner</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/JVMMetrics.html" title="class in org.apache.geode.management">JVMMetrics</a></td> |
| <td class="colLast"> |
| <div class="block">Composite data type used to distribute metrics for the JVM running a GemFire member.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/ManagementService.html" title="class in org.apache.geode.management">ManagementService</a></td> |
| <td class="colLast"> |
| <div class="block">Interface to the GemFire management service for a single Cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/MembershipAttributesData.html" title="class in org.apache.geode.management">MembershipAttributesData</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">this API is scheduled to be removed</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/NetworkMetrics.html" title="class in org.apache.geode.management">NetworkMetrics</a></td> |
| <td class="colLast"> |
| <div class="block">Composite data type used to distribute network related metrics for a member.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/OSMetrics.html" title="class in org.apache.geode.management">OSMetrics</a></td> |
| <td class="colLast"> |
| <div class="block">Composite data type used to distribute metrics for the operating system hosting a member of the |
| distributed system.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/PartitionAttributesData.html" title="class in org.apache.geode.management">PartitionAttributesData</a></td> |
| <td class="colLast"> |
| <div class="block">Composite date type used to distribute attributes for a <code>PartitionedRegion</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/PersistentMemberDetails.html" title="class in org.apache.geode.management">PersistentMemberDetails</a></td> |
| <td class="colLast"> |
| <div class="block">Composite data type used to distribute attributes for the missing disk store of a persistent |
| member.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/RegionAttributesData.html" title="class in org.apache.geode.management">RegionAttributesData</a></td> |
| <td class="colLast"> |
| <div class="block">Composite data type used to distribute attributes for a <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/ServerLoadData.html" title="class in org.apache.geode.management">ServerLoadData</a></td> |
| <td class="colLast"> |
| <div class="block">Composite data type used to distribute server load information.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/AlreadyRunningException.html" title="class in org.apache.geode.management">AlreadyRunningException</a></td> |
| <td class="colLast"> |
| <div class="block">Indicates that a request to start a management service failed because it was already running.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/DependenciesNotFoundException.html" title="class in org.apache.geode.management">DependenciesNotFoundException</a></td> |
| <td class="colLast"> |
| <div class="block">Indicates that required dependencies were not found in the ClassPath.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/management/ManagementException.html" title="class in org.apache.geode.management">ManagementException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>ManagementException</code> is a general exception that may be thrown when any |
| administration or monitoring operation on a GemFire component fails.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.geode.management Description">Package org.apache.geode.management Description</h2> |
| <div class="block"><p>A set of APIs for retrieving information and statistics for GemFire components as well as controlling the startup, shutdown and runtime of those components. |
| These APIs make use of the Java Management Extension (JMX) framework in order provide a standard interface to this management and monitoring functionality. |
| Therefore, off-the-shelf products (such as the JDK's JConsole) may make use of these APIs in order to adapt control of the GemFire product to fit into existing network operation centers.</p></div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/lang/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/geode/management/api/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/management/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
