| <!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>ManagementService (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="ManagementService (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":9,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":9,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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/management/ManagementException.html" title="class in org.apache.geode.management"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/management/ManagerMXBean.html" title="interface in org.apache.geode.management"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/management/ManagementService.html" target="_top">Frames</a></li> |
| <li><a href="ManagementService.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.geode.management</div> |
| <h2 title="Class ManagementService" class="title">Class ManagementService</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.geode.management.ManagementService</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">ManagementService</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Interface to the GemFire management service for a single Cache.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#ManagementService--">ManagementService</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#addMembershipListener-org.apache.geode.management.membership.MembershipListener-">addMembershipListener</a></span>(<a href="../../../../org/apache/geode/management/membership/MembershipListener.html" title="interface in org.apache.geode.management.membership">MembershipListener</a> listener)</code> |
| <div class="block">Registers a listener that receives call backs when a member joins or leaves the distributed |
| system.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract <T> void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#federate-javax.management.ObjectName-java.lang.Class-boolean-">federate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> objectName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> interfaceClass, |
| boolean notificationEmitter)</code> |
| <div class="block">Adds a bean to the list of those being federated, meaning that it's state will be periodically |
| pushed to managing members.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getAsyncEventQueueMBeanName-org.apache.geode.distributed.DistributedMember-java.lang.String-">getAsyncEventQueueMBeanName</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueId)</code> |
| <div class="block">Returns the object name of the AsyncEventQueueMBean representing an asynchronous queue.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getAsyncEventQueueMBeanNames-org.apache.geode.distributed.DistributedMember-">getAsyncEventQueueMBeanNames</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</code> |
| <div class="block">Returns the ids of the async event queues on this member</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getCacheServerMBeanName-int-org.apache.geode.distributed.DistributedMember-">getCacheServerMBeanName</a></span>(int serverPort, |
| <a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</code> |
| <div class="block">Returns the object name of the CacheServerMBean representing a cache server.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getDiskStoreMBeanName-org.apache.geode.distributed.DistributedMember-java.lang.String-">getDiskStoreMBeanName</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> diskName)</code> |
| <div class="block">Returns the object name of the DiskStoreMBean representing a disk store.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getDistributedLockServiceMBeanName-java.lang.String-">getDistributedLockServiceMBeanName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lockService)</code> |
| <div class="block">Returns the object name of the DistributedLockServiceMBean representing a lock service.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/DistributedLockServiceMXBean.html" title="interface in org.apache.geode.management">DistributedLockServiceMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getDistributedLockServiceMXBean-java.lang.String-">getDistributedLockServiceMXBean</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lockServiceName)</code> |
| <div class="block">Returns a LockServiceMXBean for managing and monitoring a lock service from a system wide |
| perspective.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getDistributedRegionMBeanName-java.lang.String-">getDistributedRegionMBeanName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> regionName)</code> |
| <div class="block">Returns the object name of the DistributedRegionMBean representing a region.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/DistributedRegionMXBean.html" title="interface in org.apache.geode.management">DistributedRegionMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getDistributedRegionMXBean-java.lang.String-">getDistributedRegionMXBean</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> regionPath)</code> |
| <div class="block">Returns a DistributedRegionMXBean for managing and monitoring a region from a system wide |
| perspective.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getDistributedSystemMBeanName--">getDistributedSystemMBeanName</a></span>()</code> |
| <div class="block">Returns the object name of the DistributedSystemMBean representing a distributed system.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html" title="interface in org.apache.geode.management">DistributedSystemMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getDistributedSystemMXBean--">getDistributedSystemMXBean</a></span>()</code> |
| <div class="block">Returns the DistributedSystemMXBean for managing and monitoring the distributed system as a |
| whole.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/geode/management/ManagementService.html" title="class in org.apache.geode.management">ManagementService</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getExistingManagementService-org.apache.geode.cache.Cache-">getExistingManagementService</a></span>(<a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> cache)</code> |
| <div class="block">Returns the existing instance of the management service for a cache.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getGatewayReceiverMBeanName-org.apache.geode.distributed.DistributedMember-">getGatewayReceiverMBeanName</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</code> |
| <div class="block">Returns the object name of the GatewayReceiverMBean representing a gateway receiver.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getGatewaySenderMBeanName-org.apache.geode.distributed.DistributedMember-java.lang.String-">getGatewaySenderMBeanName</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> gatwaySenderId)</code> |
| <div class="block">Returns the object name of the GatewaySenderMBean representing a gateway sender.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>abstract long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getLastUpdateTime-javax.management.ObjectName-">getLastUpdateTime</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> objectName)</code> |
| <div class="block">Returns the last updated time of the remote MBean as reported by Sysem.currentTimeMillis().</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/AsyncEventQueueMXBean.html" title="interface in org.apache.geode.management">AsyncEventQueueMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getLocalAsyncEventQueueMXBean-java.lang.String-">getLocalAsyncEventQueueMXBean</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueId)</code> |
| <div class="block">Returns a AsyncEventQueueMXBean for managing and monitoring an asynchronous queue.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/CacheServerMXBean.html" title="interface in org.apache.geode.management">CacheServerMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getLocalCacheServerMXBean-int-">getLocalCacheServerMXBean</a></span>(int serverPort)</code> |
| <div class="block">Returns a CacheServerMXBean for managing and monitoring a cache server.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/DiskStoreMXBean.html" title="interface in org.apache.geode.management">DiskStoreMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getLocalDiskStoreMBean-java.lang.String-">getLocalDiskStoreMBean</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> diskStoreName)</code> |
| <div class="block">Returns a DiskStoreMXBean for managing and monitoring a disk store.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html" title="interface in org.apache.geode.management">GatewayReceiverMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getLocalGatewayReceiverMXBean--">getLocalGatewayReceiverMXBean</a></span>()</code> |
| <div class="block">Returns the GatewayReceiverMXBean for managing and monitoring the gateway receiver.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html" title="interface in org.apache.geode.management">GatewaySenderMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getLocalGatewaySenderMXBean-java.lang.String-">getLocalGatewaySenderMXBean</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> senderId)</code> |
| <div class="block">Returns a GatewaySenderMXBean for managing and monitoring a gateway sender.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/LocatorMXBean.html" title="interface in org.apache.geode.management">LocatorMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getLocalLocatorMXBean--">getLocalLocatorMXBean</a></span>()</code> |
| <div class="block">Returns the LocatorMXBean for managing and monitoring the locator.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/LockServiceMXBean.html" title="interface in org.apache.geode.management">LockServiceMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getLocalLockServiceMBean-java.lang.String-">getLocalLockServiceMBean</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lockServiceName)</code> |
| <div class="block">Returns a LockServiceMXBean for managing and monitoring a lock service.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/RegionMXBean.html" title="interface in org.apache.geode.management">RegionMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getLocalRegionMBean-java.lang.String-">getLocalRegionMBean</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> regionPath)</code> |
| <div class="block">Returns a RegionMXBbean for managing and monitoring a Region.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getLocatorMBeanName-org.apache.geode.distributed.DistributedMember-">getLocatorMBeanName</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</code> |
| <div class="block">Returns the object name of the LocatorMBean representing a locator.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getLockServiceMBeanName-org.apache.geode.distributed.DistributedMember-java.lang.String-">getLockServiceMBeanName</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lockServiceName)</code> |
| <div class="block">Returns the object name of the LockServiceMBean representing a lock service.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/geode/management/ManagementService.html" title="class in org.apache.geode.management">ManagementService</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getManagementService-org.apache.geode.cache.Cache-">getManagementService</a></span>(<a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> cache)</code> |
| <div class="block">Returns a newly created or the existing instance of the management service for a cache.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getManagerMBeanName--">getManagerMBeanName</a></span>()</code> |
| <div class="block">Returns the object name of the ManagerMBean representing a manager.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/ManagerMXBean.html" title="interface in org.apache.geode.management">ManagerMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getManagerMXBean--">getManagerMXBean</a></span>()</code> |
| <div class="block">Returns the ManagerMXBean for the management service.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>abstract <T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getMBeanInstance-javax.management.ObjectName-java.lang.Class-">getMBeanInstance</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> objectName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> interfaceClass)</code> |
| <div class="block">Returns an instance of an MBean.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getMemberMBeanName-org.apache.geode.distributed.DistributedMember-">getMemberMBeanName</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</code> |
| <div class="block">Returns the object name of the MemberMBean representing a distributed member.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/geode/management/MemberMXBean.html" title="interface in org.apache.geode.management">MemberMXBean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getMemberMXBean--">getMemberMXBean</a></span>()</code> |
| <div class="block">Returns the MemberMXBean for managing and monitoring the local member.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#getRegionMBeanName-org.apache.geode.distributed.DistributedMember-java.lang.String-">getRegionMBeanName</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> regionPath)</code> |
| <div class="block">Returns the object name of the RegionMBean representing a region.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#isManager--">isManager</a></span>()</code> |
| <div class="block">Returns whether this member is running the management service.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#queryMBeanNames-org.apache.geode.distributed.DistributedMember-">queryMBeanNames</a></span>(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</code> |
| <div class="block">Returns the object names for all MBeans associated with a member.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#registerMBean-java.lang.Object-javax.management.ObjectName-">registerMBean</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> objectName)</code> |
| <div class="block">Registers an MBean in the GemFire domain.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#removeMembershipListener-org.apache.geode.management.membership.MembershipListener-">removeMembershipListener</a></span>(<a href="../../../../org/apache/geode/management/membership/MembershipListener.html" title="interface in org.apache.geode.management.membership">MembershipListener</a> listener)</code> |
| <div class="block">Unregisters a membership listener</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#startManager--">startManager</a></span>()</code> |
| <div class="block">Starts the management service on this member.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#stopManager--">stopManager</a></span>()</code> |
| <div class="block">Stops the management service running on this member.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/ManagementService.html#unregisterMBean-javax.management.ObjectName-">unregisterMBean</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> objectName)</code> |
| <div class="block">Unregisters an MBean.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ManagementService--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ManagementService</h4> |
| <pre>public ManagementService()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getManagementService-org.apache.geode.cache.Cache-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagementService</h4> |
| <pre>public static <a href="../../../../org/apache/geode/management/ManagementService.html" title="class in org.apache.geode.management">ManagementService</a> getManagementService(<a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> cache)</pre> |
| <div class="block">Returns a newly created or the existing instance of the management service for a cache.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cache</code> - Cache for which to get the management service.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a newly created or the existing instance of the management service for a cache</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExistingManagementService-org.apache.geode.cache.Cache-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExistingManagementService</h4> |
| <pre>public static <a href="../../../../org/apache/geode/management/ManagementService.html" title="class in org.apache.geode.management">ManagementService</a> getExistingManagementService(<a href="../../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">Cache</a> cache)</pre> |
| <div class="block">Returns the existing instance of the management service for a cache.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cache</code> - Cache for which to get the management service.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The existing management service if one exists, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isManager</h4> |
| <pre>public abstract boolean isManager()</pre> |
| <div class="block">Returns whether this member is running the management service.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if this member is running the management service, false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startManager</h4> |
| <pre>public abstract void startManager()</pre> |
| <div class="block">Starts the management service on this member.</div> |
| </li> |
| </ul> |
| <a name="stopManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopManager</h4> |
| <pre>public abstract void stopManager()</pre> |
| <div class="block">Stops the management service running on this member.</div> |
| </li> |
| </ul> |
| <a name="registerMBean-java.lang.Object-javax.management.ObjectName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerMBean</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> registerMBean(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> objectName)</pre> |
| <div class="block">Registers an MBean in the GemFire domain. Any other domain specified as part of the object will |
| be ignored.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - MBean to register.</dd> |
| <dd><code>objectName</code> - Object name of the MBean to register.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Object name, which may have been modified to use the GemFire domain.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unregisterMBean-javax.management.ObjectName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unregisterMBean</h4> |
| <pre>public abstract void unregisterMBean(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> objectName)</pre> |
| <div class="block">Unregisters an MBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>objectName</code> - Object name of the MBean to unregister.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="federate-javax.management.ObjectName-java.lang.Class-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>federate</h4> |
| <pre>public abstract <T> void federate(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> objectName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> interfaceClass, |
| boolean notificationEmitter)</pre> |
| <div class="block">Adds a bean to the list of those being federated, meaning that it's state will be periodically |
| pushed to managing members. It's possible to simply register MBeans in the GemFire domain |
| without calling federate if the developer doesn't need their state to be shared amongst |
| members. Note that Dynamic MBeans are not supported by this service. |
| |
| <pre> |
| Example Usage: |
| |
| <code>CustomMXBean bean = new CustomMBean(); |
| ObjectName beanName = ObjectName.getInstance("DefualtDomain:type=CustomType"); |
| ObjectName gemfireBeanName = service.registerMBean(customMBean, customMBeanName); |
| service.federate(gemfireBeanName, CustomMXBean.class, true);</code> |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of MBean</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>objectName</code> - Object name of the MBean.</dd> |
| <dd><code>interfaceClass</code> - Interface which this MBean exposes.</dd> |
| <dd><code>notificationEmitter</code> - True if the MBean is a notification emitter.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMemberMXBean--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMemberMXBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/MemberMXBean.html" title="interface in org.apache.geode.management">MemberMXBean</a> getMemberMXBean()</pre> |
| <div class="block">Returns the MemberMXBean for managing and monitoring the local member.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the MemberMXBean for managing and monitoring the local member</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocalRegionMBean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalRegionMBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/RegionMXBean.html" title="interface in org.apache.geode.management">RegionMXBean</a> getLocalRegionMBean(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> regionPath)</pre> |
| <div class="block">Returns a RegionMXBbean for managing and monitoring a Region.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regionPath</code> - Path of the region.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A RegionMXBean if the region exists, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocalLockServiceMBean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalLockServiceMBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/LockServiceMXBean.html" title="interface in org.apache.geode.management">LockServiceMXBean</a> getLocalLockServiceMBean(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lockServiceName)</pre> |
| <div class="block">Returns a LockServiceMXBean for managing and monitoring a lock service.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lockServiceName</code> - Name of the lock service.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A LockServiceMXBean if the lock service exists, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocalDiskStoreMBean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalDiskStoreMBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/DiskStoreMXBean.html" title="interface in org.apache.geode.management">DiskStoreMXBean</a> getLocalDiskStoreMBean(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> diskStoreName)</pre> |
| <div class="block">Returns a DiskStoreMXBean for managing and monitoring a disk store.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>diskStoreName</code> - Name of the disk store.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A DiskStoreMXBean if the disk store exists, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocalCacheServerMXBean-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalCacheServerMXBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/CacheServerMXBean.html" title="interface in org.apache.geode.management">CacheServerMXBean</a> getLocalCacheServerMXBean(int serverPort)</pre> |
| <div class="block">Returns a CacheServerMXBean for managing and monitoring a cache server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serverPort</code> - Port on which the cache server is listening.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A CacheServerMXBean if the cache server is found, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDistributedSystemMXBean--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDistributedSystemMXBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html" title="interface in org.apache.geode.management">DistributedSystemMXBean</a> getDistributedSystemMXBean()</pre> |
| <div class="block">Returns the DistributedSystemMXBean for managing and monitoring the distributed system as a |
| whole.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A DistributedSystemMXBean if one is found, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getManagerMXBean--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagerMXBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/ManagerMXBean.html" title="interface in org.apache.geode.management">ManagerMXBean</a> getManagerMXBean()</pre> |
| <div class="block">Returns the ManagerMXBean for the management service.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A ManagerMXBean if one is found, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDistributedRegionMXBean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDistributedRegionMXBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/DistributedRegionMXBean.html" title="interface in org.apache.geode.management">DistributedRegionMXBean</a> getDistributedRegionMXBean(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> regionPath)</pre> |
| <div class="block">Returns a DistributedRegionMXBean for managing and monitoring a region from a system wide |
| perspective.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regionPath</code> - Path of the Region.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A DistributedRegionMXBean if the region exists, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDistributedLockServiceMXBean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDistributedLockServiceMXBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/DistributedLockServiceMXBean.html" title="interface in org.apache.geode.management">DistributedLockServiceMXBean</a> getDistributedLockServiceMXBean(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lockServiceName)</pre> |
| <div class="block">Returns a LockServiceMXBean for managing and monitoring a lock service from a system wide |
| perspective.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lockServiceName</code> - Name of the LockService.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A DistributedLockServiceMXBean if the lock service exists, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocalGatewayReceiverMXBean--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalGatewayReceiverMXBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html" title="interface in org.apache.geode.management">GatewayReceiverMXBean</a> getLocalGatewayReceiverMXBean()</pre> |
| <div class="block">Returns the GatewayReceiverMXBean for managing and monitoring the gateway receiver.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A GatewayReceiverMXBean if one is found, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocalGatewaySenderMXBean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalGatewaySenderMXBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html" title="interface in org.apache.geode.management">GatewaySenderMXBean</a> getLocalGatewaySenderMXBean(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> senderId)</pre> |
| <div class="block">Returns a GatewaySenderMXBean for managing and monitoring a gateway sender.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>senderId</code> - ID of the gateway sender.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A GatewaySenderMXBean if the gateway sender is found, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocalAsyncEventQueueMXBean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalAsyncEventQueueMXBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/AsyncEventQueueMXBean.html" title="interface in org.apache.geode.management">AsyncEventQueueMXBean</a> getLocalAsyncEventQueueMXBean(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueId)</pre> |
| <div class="block">Returns a AsyncEventQueueMXBean for managing and monitoring an asynchronous queue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queueId</code> - ID of the asynchronous queue.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An AsyncEventQueueMXBean if the asynchronous queue is found, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocalLocatorMXBean--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalLocatorMXBean</h4> |
| <pre>public abstract <a href="../../../../org/apache/geode/management/LocatorMXBean.html" title="interface in org.apache.geode.management">LocatorMXBean</a> getLocalLocatorMXBean()</pre> |
| <div class="block">Returns the LocatorMXBean for managing and monitoring the locator.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A LocatorMXBean if the locator is found, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="queryMBeanNames-org.apache.geode.distributed.DistributedMember-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryMBeanNames</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>> queryMBeanNames(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</pre> |
| <div class="block">Returns the object names for all MBeans associated with a member.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>member</code> - Member for which to find MBeans.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object names for all MBeans associated with a member</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAsyncEventQueueMBeanNames-org.apache.geode.distributed.DistributedMember-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAsyncEventQueueMBeanNames</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>> getAsyncEventQueueMBeanNames(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</pre> |
| <div class="block">Returns the ids of the async event queues on this member</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>member</code> - Member for which to find MBeans.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ids of the async event queues on this member</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMBeanInstance-javax.management.ObjectName-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMBeanInstance</h4> |
| <pre>public abstract <T> T getMBeanInstance(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> objectName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> interfaceClass)</pre> |
| <div class="block">Returns an instance of an MBean. This is a reference to the MBean instance and not a |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectInstance.html?is-external=true" title="class or interface in javax.management"><code>ObjectInstance</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of MBean</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>objectName</code> - Object name of the MBean.</dd> |
| <dd><code>interfaceClass</code> - Interface which this MBean exposes.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance of an MBean</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</a></code> - if the MBean does not implement the given interface.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastUpdateTime-javax.management.ObjectName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastUpdateTime</h4> |
| <pre>public abstract long getLastUpdateTime(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> objectName)</pre> |
| <div class="block">Returns the last updated time of the remote MBean as reported by Sysem.currentTimeMillis().</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>objectName</code> - Object name of the MBean.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Last updated time or 0 if the MBean is local or the management service is not running |
| on this member.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMemberMBeanName-org.apache.geode.distributed.DistributedMember-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMemberMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getMemberMBeanName(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</pre> |
| <div class="block">Returns the object name of the MemberMBean representing a distributed member. This is a utility |
| method for generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>member</code> - Distributed member used to generate the object name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the MemberMBean representing a distributed member</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRegionMBeanName-org.apache.geode.distributed.DistributedMember-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getRegionMBeanName(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> regionPath)</pre> |
| <div class="block">Returns the object name of the RegionMBean representing a region. This is a utility method for |
| generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>member</code> - Distributed member used to generate the object name.</dd> |
| <dd><code>regionPath</code> - Path of the region.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the RegionMBean representing a region</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDiskStoreMBeanName-org.apache.geode.distributed.DistributedMember-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiskStoreMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getDiskStoreMBeanName(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> diskName)</pre> |
| <div class="block">Returns the object name of the DiskStoreMBean representing a disk store. This is a utility |
| method for generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>member</code> - Distributed member used to generate the object name.</dd> |
| <dd><code>diskName</code> - Name of the disk store.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the DiskStoreMBean representing a disk store</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheServerMBeanName-int-org.apache.geode.distributed.DistributedMember-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheServerMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getCacheServerMBeanName(int serverPort, |
| <a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</pre> |
| <div class="block">Returns the object name of the CacheServerMBean representing a cache server. This is a utility |
| method for generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>member</code> - Distributed member used to generate the object name.</dd> |
| <dd><code>serverPort</code> - Port on which the cache server is listening.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the CacheServerMBean representing a cache server</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLockServiceMBeanName-org.apache.geode.distributed.DistributedMember-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockServiceMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getLockServiceMBeanName(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lockServiceName)</pre> |
| <div class="block">Returns the object name of the LockServiceMBean representing a lock service. This is a utility |
| method for generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>member</code> - Distributed member used to generate the object name.</dd> |
| <dd><code>lockServiceName</code> - Name of the lock service.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the LockServiceMBean representing a lock service</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGatewayReceiverMBeanName-org.apache.geode.distributed.DistributedMember-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGatewayReceiverMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getGatewayReceiverMBeanName(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</pre> |
| <div class="block">Returns the object name of the GatewayReceiverMBean representing a gateway receiver. This is a |
| utility method for generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>member</code> - Distributed member used to generate the object name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the GatewayReceiverMBean representing a gateway receiver</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGatewaySenderMBeanName-org.apache.geode.distributed.DistributedMember-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGatewaySenderMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getGatewaySenderMBeanName(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> gatwaySenderId)</pre> |
| <div class="block">Returns the object name of the GatewaySenderMBean representing a gateway sender. This is a |
| utility method for generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>member</code> - Distributed member used to generate the object name.</dd> |
| <dd><code>gatwaySenderId</code> - ID of the gateway sender.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the GatewaySenderMBean representing a gateway sender</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAsyncEventQueueMBeanName-org.apache.geode.distributed.DistributedMember-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAsyncEventQueueMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getAsyncEventQueueMBeanName(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueId)</pre> |
| <div class="block">Returns the object name of the AsyncEventQueueMBean representing an asynchronous queue. This is |
| a utility method for generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>member</code> - Distributed member used to generate the object name.</dd> |
| <dd><code>queueId</code> - ID of the asynchronous queue.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the AsyncEventQueueMBean representing an asynchronous queue</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDistributedRegionMBeanName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDistributedRegionMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getDistributedRegionMBeanName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> regionName)</pre> |
| <div class="block">Returns the object name of the DistributedRegionMBean representing a region. This is a utility |
| method for generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regionName</code> - Name of the region.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the DistributedRegionMBean representing a region</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDistributedLockServiceMBeanName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDistributedLockServiceMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getDistributedLockServiceMBeanName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lockService)</pre> |
| <div class="block">Returns the object name of the DistributedLockServiceMBean representing a lock service. This is |
| a utility method for generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lockService</code> - Name of the lock service.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the DistributedLockServiceMBean representing a lock service</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDistributedSystemMBeanName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDistributedSystemMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getDistributedSystemMBeanName()</pre> |
| <div class="block">Returns the object name of the DistributedSystemMBean representing a distributed system. |
| This is a utility method for generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the DistributedSystemMBean representing a distributed system</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getManagerMBeanName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagerMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getManagerMBeanName()</pre> |
| <div class="block">Returns the object name of the ManagerMBean representing a manager. This is a utility method |
| for generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the ManagerMBean representing a manager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocatorMBeanName-org.apache.geode.distributed.DistributedMember-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocatorMBeanName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a> getLocatorMBeanName(<a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed">DistributedMember</a> member)</pre> |
| <div class="block">Returns the object name of the LocatorMBean representing a locator. This is a utility method |
| for generating an object name and it does not register an MBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>member</code> - Distributed member used to generate the object name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object name of the LocatorMBean representing a locator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addMembershipListener-org.apache.geode.management.membership.MembershipListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMembershipListener</h4> |
| <pre>public abstract void addMembershipListener(<a href="../../../../org/apache/geode/management/membership/MembershipListener.html" title="interface in org.apache.geode.management.membership">MembershipListener</a> listener)</pre> |
| <div class="block">Registers a listener that receives call backs when a member joins or leaves the distributed |
| system.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the membership listener to register</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeMembershipListener-org.apache.geode.management.membership.MembershipListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>removeMembershipListener</h4> |
| <pre>public abstract void removeMembershipListener(<a href="../../../../org/apache/geode/management/membership/MembershipListener.html" title="interface in org.apache.geode.management.membership">MembershipListener</a> listener)</pre> |
| <div class="block">Unregisters a membership listener</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the membership listener to unregister</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/management/ManagementService.html#addMembershipListener-org.apache.geode.management.membership.MembershipListener-"><code>addMembershipListener(org.apache.geode.management.membership.MembershipListener)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= 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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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/management/ManagementException.html" title="class in org.apache.geode.management"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/management/ManagerMXBean.html" title="interface in org.apache.geode.management"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/management/ManagementService.html" target="_top">Frames</a></li> |
| <li><a href="ManagementService.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |