| <!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.admin (Apache Geode 1.15.0)</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.admin (Apache Geode 1.15.0)"; |
| } |
| } |
| 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/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/geode/admin/jmx/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/admin/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.admin</h1> |
| <div class="docSummary"> |
| <div class="block">Provides an API for administering various GemFire components such |
| as a GemFire distributed |
| system, and processes that host GemFire Caches.</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/admin/AdminDistributedSystem.html" title="interface in org.apache.geode.admin">AdminDistributedSystem</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/Alert.html" title="interface in org.apache.geode.admin">Alert</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/AlertListener.html" title="interface in org.apache.geode.admin">AlertListener</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/BackupStatus.html" title="interface in org.apache.geode.admin">BackupStatus</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/CacheHealthConfig.html" title="interface in org.apache.geode.admin">CacheHealthConfig</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/CacheServer.html" title="interface in org.apache.geode.admin">CacheServer</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 5.7 use <a href="../../../../org/apache/geode/admin/CacheVm.html" title="interface in org.apache.geode.admin"><code>CacheVm</code></a> instead.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/CacheServerConfig.html" title="interface in org.apache.geode.admin">CacheServerConfig</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 5.7 use <a href="../../../../org/apache/geode/admin/CacheVmConfig.html" title="interface in org.apache.geode.admin"><code>CacheVmConfig</code></a> instead.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/CacheVm.html" title="interface in org.apache.geode.admin">CacheVm</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/CacheVmConfig.html" title="interface in org.apache.geode.admin">CacheVmConfig</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/ConfigurationParameter.html" title="interface in org.apache.geode.admin">ConfigurationParameter</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/DistributedSystemConfig.html" title="interface in org.apache.geode.admin">DistributedSystemConfig</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/DistributedSystemConfig.ConfigListener.html" title="interface in org.apache.geode.admin">DistributedSystemConfig.ConfigListener</a></td> |
| <td class="colLast"> |
| <div class="block">A listener whose callback methods are invoked when this config changes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/DistributedSystemHealthConfig.html" title="interface in org.apache.geode.admin">DistributedSystemHealthConfig</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/DistributionLocator.html" title="interface in org.apache.geode.admin">DistributionLocator</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/DistributionLocatorConfig.html" title="interface in org.apache.geode.admin">DistributionLocatorConfig</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/GemFireHealth.html" title="interface in org.apache.geode.admin">GemFireHealth</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html" title="interface in org.apache.geode.admin">GemFireHealthConfig</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/ManagedEntity.html" title="interface in org.apache.geode.admin">ManagedEntity</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/ManagedEntityConfig.html" title="interface in org.apache.geode.admin">ManagedEntityConfig</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/MemberHealthConfig.html" title="interface in org.apache.geode.admin">MemberHealthConfig</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/Statistic.html" title="interface in org.apache.geode.admin">Statistic</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/StatisticResource.html" title="interface in org.apache.geode.admin">StatisticResource</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/SystemMember.html" title="interface in org.apache.geode.admin">SystemMember</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/SystemMemberBridgeServer.html" title="interface in org.apache.geode.admin">SystemMemberBridgeServer</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 5.7 use <a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html" title="interface in org.apache.geode.admin"><code>SystemMemberCacheServer</code></a> instead.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/SystemMemberCache.html" title="interface in org.apache.geode.admin">SystemMemberCache</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/SystemMemberCacheEvent.html" title="interface in org.apache.geode.admin">SystemMemberCacheEvent</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/SystemMemberCacheListener.html" title="interface in org.apache.geode.admin">SystemMemberCacheListener</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/SystemMemberCacheServer.html" title="interface in org.apache.geode.admin">SystemMemberCacheServer</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/SystemMemberRegion.html" title="interface in org.apache.geode.admin">SystemMemberRegion</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/SystemMemberRegionEvent.html" title="interface in org.apache.geode.admin">SystemMemberRegionEvent</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/SystemMembershipEvent.html" title="interface in org.apache.geode.admin">SystemMembershipEvent</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/SystemMembershipListener.html" title="interface in org.apache.geode.admin">SystemMembershipListener</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></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/admin/AdminConfig.html" title="class in org.apache.geode.admin">AdminConfig</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/AdminConfig.Entry.html" title="class in org.apache.geode.admin">AdminConfig.Entry</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/AdminDistributedSystemFactory.html" title="class in org.apache.geode.admin">AdminDistributedSystemFactory</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/AlertLevel.html" title="class in org.apache.geode.admin">AlertLevel</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin">GemFireHealth.Health</a></td> |
| <td class="colLast"> |
| <div class="block">An enumerated type for the health of GemFire.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/GemFireMemberStatus.html" title="class in org.apache.geode.admin">GemFireMemberStatus</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/RegionSubRegionSnapshot.html" title="class in org.apache.geode.admin">RegionSubRegionSnapshot</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/SystemMemberType.html" title="class in org.apache.geode.admin">SystemMemberType</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></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/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/AdminXmlException.html" title="class in org.apache.geode.admin">AdminXmlException</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/CacheDoesNotExistException.html" title="class in org.apache.geode.admin">CacheDoesNotExistException</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/OperationCancelledException.html" title="class in org.apache.geode.admin">OperationCancelledException</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/RegionNotFoundException.html" title="class in org.apache.geode.admin">RegionNotFoundException</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/RuntimeAdminException.html" title="class in org.apache.geode.admin">RuntimeAdminException</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/geode/admin/UnmodifiableConfigurationException.html" title="class in org.apache.geode.admin">UnmodifiableConfigurationException</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href= |
| "../../../../org/apache/geode/management/package-summary.html">management</a></code> |
| package instead</span></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.geode.admin Description">Package org.apache.geode.admin Description</h2> |
| <div class="block"><P>Provides an API for administering various GemFire components such |
| as a GemFire distributed |
| system, and processes that host GemFire Caches.</P> |
| |
| <H3>Administration of a GemFire Distributed System</H3> |
| |
| The Admin API provides interfaces for administrative control, |
| monitoring, and custom management of a GemFire system. |
| <P> |
| The <a href="../../../../org/apache/geode/admin/AdminDistributedSystemFactory.html" title="class in org.apache.geode.admin"><code>AdminDistributedSystemFactory</code></a> |
| is the starting point. It creates an instance of |
| <code>AdminDistributedSystem</code> that administers the distributed |
| system to which a VM is <a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">connected</a>. |
| <P> |
| <pre><code> |
| DistributedSystem connection = DistributedSystem.connect(new Properties()); |
| AdminDistributedSystem system = |
| AdminDistributedSystemFactory.getDistributedSystem(connection); |
| system.connect(new File("admin.log"), "info"); |
| </code></pre> |
| <P> |
| This <a href="../../../../org/apache/geode/admin/AdminDistributedSystem.html" title="interface in org.apache.geode.admin"><code>AdminDistributedSystem</code></a> |
| interface exposes methods for such tasks as connecting to the system, |
| merging system logs, getting administrative interfaces to |
| applications that host GemFire Caches. |
| |
| <H3>Monitoring the Health of GemFire</H3> |
| |
| <P>The <a href="../../../../org/apache/geode/admin/GemFireHealth.html" title="interface in org.apache.geode.admin"><code>GemFireHealth</code></a> interface |
| allows the overall health of GemFire to be monitored. |
| <code>GemFireHealth</code> monitors the behavior the members of a |
| distributed system namely |
| application VMs that may host <a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache"><code>cache</code></a> instances. There are three levels of health: <a href="../../../../org/apache/geode/admin/GemFireHealth.html#GOOD_HEALTH">good health</a> that |
| indicates that all GemFire components are behaving reasonably, |
| <a href="../../../../org/apache/geode/admin/GemFireHealth.html#OKAY_HEALTH">okay |
| health</a> that indicates that one or more GemFire components is slightly |
| unhealthy and may need some attention, and <a href="../../../../org/apache/geode/admin/GemFireHealth.html#POOR_HEALTH">poor health</a> that |
| indicates that a GemFire component is unhealthy and needs immediate |
| attention.</P> |
| |
| <P>Because each GemFire application has its own definition of what it |
| means to be "healthy", the metrics that are used to determine health |
| are configurable. <a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html" title="interface in org.apache.geode.admin"><code>GemFireHealthConfig</code></a> provides methods for |
| configuring how the health of <a href="../../../../org/apache/geode/admin/DistributedSystemHealthConfig.html" title="interface in org.apache.geode.admin">the |
| distributed system</a>, |
| <a href="../../../../org/apache/geode/admin/CacheHealthConfig.html" title="interface in org.apache.geode.admin">members that |
| host Cache instances</a>, and <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html" title="interface in org.apache.geode.admin">individual members</a> of |
| the distributed system. <code>GemFireHealthConfig</code> also allows |
| you to configure how often GemFire's health is evaluated.</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/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/geode/admin/jmx/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/admin/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> |
