Google Git
Sign in
apache / geode-site / fc25d29c7053eb6dc81bcd70f2b22d855a2be473 / . / releases / latest / javadoc / org / apache / geode / admin / jmx / Agent.html
blob: adcf4c8c60c45eb9b274c159deaf7e2ad1ea7722 [file] [log] [blame]
<!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>Agent (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="Agent (Apache Geode 1.15.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":38,"i1":38,"i2":38,"i3":38,"i4":38,"i5":38,"i6":38,"i7":38,"i8":38,"i9":38,"i10":38,"i11":38};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/geode/admin/jmx/AgentConfig.html" title="interface in org.apache.geode.admin.jmx"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/geode/admin/jmx/Agent.html" target="_top">Frames</a></li>
<li><a href="Agent.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.admin.jmx</div>
<h2 title="Interface Agent" class="title">Interface Agent</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<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>
</div>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public interface <span class="typeNameLabel">Agent</span></pre>
<div class="block">A server component that provides administration-related information about a GemFire distributed
system via the Java Management Extension JMX API. When a JMX <code>Agent</code> is created, it
registers an MBean that represents <a href="../../../../../org/apache/geode/admin/jmx/Agent.html#getObjectName--"><code>itself</code></a>. Click
<A href="doc-files/mbeans-descriptions.html">here</A> for a description of the attributes,
operations, and notifications of this and other GemFire JMX MBeans.
<P>
The GemFire JMX Agent currently supports three JMX "adapters" through which clients can access
the GemFire management beans: an "HTTP adapter" that allows a web browser client to view and
modify management beans via HTTP or HTTPS, an "RMI adapter" that allows Java programs to access
management beans using Remote Method Invocation, and an "SNMP adapter" that allows SNMP to access
management beans. Information about configuring these adapters can be found in
<a href="../../../../../org/apache/geode/admin/jmx/AgentConfig.html" title="interface in org.apache.geode.admin.jmx"><code>AgentConfig</code></a>.
<P>
In most distributed caching architectures, JMX administration agents are run in their own
processes. A stand-alone JMX agent is managed using the <code>agent</code> command line utility:
<PRE>
$ agent start
</PRE>
This class allows a GemFire application VM to host a JMX management agent. Architectures with
"co-located" JMX agents reduce the number of overall proceses required. However, hosting a JMX
management agent in the same VM as a GemFire application is not generally recommended because it
adds extra burden to an application VM and in the event that the application VM exits the
administration information will no longer be available.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/geode/admin/jmx/AgentConfig.html" title="interface in org.apache.geode.admin.jmx"><code>AgentConfig</code></a>,
<a href="../../../../../org/apache/geode/admin/jmx/AgentFactory.html" title="class in org.apache.geode.admin.jmx"><code>AgentFactory</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/admin/jmx/Agent.html#JNDI_NAME">JNDI_NAME</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Lookup name for RMIConnector when rmi-registry-enabled is true</div>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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><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/admin/jmx/Agent.html#connectToSystem--">connectToSystem</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Connects to the distributed system described by this <code>Agent</code>'s configuration.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/admin/jmx/Agent.html#disconnectFromSystem--">disconnectFromSystem</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Disconnects this agent from the distributed system and unregisters the management beans that
provided information about it.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/admin/jmx/AgentConfig.html" title="interface in org.apache.geode.admin.jmx">AgentConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/admin/jmx/Agent.html#getConfig--">getConfig</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the configuration object for this JMX Agent.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/admin/AdminDistributedSystem.html" title="interface in org.apache.geode.admin">AdminDistributedSystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/admin/jmx/Agent.html#getDistributedSystem--">getDistributedSystem</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the <code>AdminDistributedSystem</code> that underlies this JMX <code>Agent</code> or
<code>null</code> is this agent is not <a href="../../../../../org/apache/geode/admin/jmx/Agent.html#isConnected--">connected</a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/LogWriter.html" title="interface in org.apache.geode">LogWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/admin/jmx/Agent.html#getLogWriter--">getLogWriter</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the <code>LogWriter</code> used for logging information.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanServer.html?is-external=true" title="class or interface in javax.management">MBeanServer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/admin/jmx/Agent.html#getMBeanServer--">getMBeanServer</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the JMX <code>MBeanServer</code> with which GemFire MBeans are registered or
<code>null</code> if this <code>Agent</code> is not started.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><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/admin/jmx/Agent.html#getObjectName--">getObjectName</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the <code>ObjectName</code> of the JMX management bean that represents this agent or
<code>null</code> if this <code>Agent</code> has not been started.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/admin/jmx/Agent.html#isConnected--">isConnected</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns whether or not this JMX <code>Agent</code> is currently providing information about a
distributed system.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><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/admin/jmx/Agent.html#manageDistributedSystem--">manageDistributedSystem</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the object name of the JMX MBean that represents the distributed system administered by
this <code>Agent</code> or <code>null</code> if this <code>Agent</code> has not
<a href="../../../../../org/apache/geode/admin/jmx/Agent.html#connectToSystem--">connected</a> to the distributed system.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/admin/jmx/Agent.html#saveProperties--">saveProperties</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Saves the configuration for this <code>Agent</code> to the file specified by @link
AgentConfig#getPropertyFile.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/admin/jmx/Agent.html#start--">start</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Starts this JMX Agent and its associated adapters.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/admin/jmx/Agent.html#stop--">stop</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block"><a href="../../../../../org/apache/geode/admin/jmx/Agent.html#disconnectFromSystem--">Disconnects</a> from the distributed system and stops this JMX
Agent and all of its associated adapters.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="JNDI_NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JNDI_NAME</h4>
<pre>static final&nbsp;<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> JNDI_NAME</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Lookup name for RMIConnector when rmi-registry-enabled is true</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.geode.admin.jmx.Agent.JNDI_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre><a href="../../../../../org/apache/geode/admin/jmx/AgentConfig.html" title="interface in org.apache.geode.admin.jmx">AgentConfig</a>&nbsp;getConfig()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the configuration object for this JMX Agent.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configuration object for this JMX Agent</dd>
</dl>
</li>
</ul>
<a name="start--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>void&nbsp;start()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Starts this JMX Agent and its associated adapters. This method does not
<a href="../../../../../org/apache/geode/admin/jmx/Agent.html#connectToSystem--">connect</a> to the distributed system.</div>
</li>
</ul>
<a name="getMBeanServer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMBeanServer</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MBeanServer.html?is-external=true" title="class or interface in javax.management">MBeanServer</a>&nbsp;getMBeanServer()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the JMX <code>MBeanServer</code> with which GemFire MBeans are registered or
<code>null</code> if this <code>Agent</code> is not started.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the JMX <code>MBeanServer</code> with which GemFire MBeans are registered</dd>
</dl>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>void&nbsp;stop()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block"><a href="../../../../../org/apache/geode/admin/jmx/Agent.html#disconnectFromSystem--">Disconnects</a> from the distributed system and stops this JMX
Agent and all of its associated adapters.</div>
</li>
</ul>
<a name="getObjectName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectName</h4>
<pre><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>&nbsp;getObjectName()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the <code>ObjectName</code> of the JMX management bean that represents this agent or
<code>null</code> if this <code>Agent</code> has not been started.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>ObjectName</code> of the JMX management bean that represents this agent</dd>
</dl>
</li>
</ul>
<a name="isConnected--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConnected</h4>
<pre>boolean&nbsp;isConnected()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns whether or not this JMX <code>Agent</code> is currently providing information about a
distributed system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether or not this JMX <code>Agent</code> is currently providing information about a
distributed system.</dd>
</dl>
</li>
</ul>
<a name="connectToSystem--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectToSystem</h4>
<pre><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>&nbsp;connectToSystem()
throws <a href="../../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MalformedObjectNameException.html?is-external=true" title="class or interface in javax.management">MalformedObjectNameException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Connects to the distributed system described by this <code>Agent</code>'s configuration.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The object name of the system that the <code>Agent</code> is now connected to.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/geode/admin/AdminException.html" title="class in org.apache.geode.admin">AdminException</a></code> - if an exception is encountered while connecting</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MalformedObjectNameException.html?is-external=true" title="class or interface in javax.management">MalformedObjectNameException</a></code> - if the format of an MBean name specified in the
configuration does not correspond to a valid ObjectName</dd>
</dl>
</li>
</ul>
<a name="getDistributedSystem--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDistributedSystem</h4>
<pre><a href="../../../../../org/apache/geode/admin/AdminDistributedSystem.html" title="interface in org.apache.geode.admin">AdminDistributedSystem</a>&nbsp;getDistributedSystem()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the <code>AdminDistributedSystem</code> that underlies this JMX <code>Agent</code> or
<code>null</code> is this agent is not <a href="../../../../../org/apache/geode/admin/jmx/Agent.html#isConnected--">connected</a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>AdminDistributedSystem</code> that underlies this JMX <code>Agent</code></dd>
</dl>
</li>
</ul>
<a name="manageDistributedSystem--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>manageDistributedSystem</h4>
<pre><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>&nbsp;manageDistributedSystem()
throws <a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MalformedObjectNameException.html?is-external=true" title="class or interface in javax.management">MalformedObjectNameException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the object name of the JMX MBean that represents the distributed system administered by
this <code>Agent</code> or <code>null</code> if this <code>Agent</code> has not
<a href="../../../../../org/apache/geode/admin/jmx/Agent.html#connectToSystem--">connected</a> to the distributed system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object name of the JMX MBean that represents the distributed system administered by
this <code>Agent</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/MalformedObjectNameException.html?is-external=true" title="class or interface in javax.management">MalformedObjectNameException</a></code> - if the format of the JMX MBean name does not correspond to
a valid ObjectName</dd>
</dl>
</li>
</ul>
<a name="disconnectFromSystem--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disconnectFromSystem</h4>
<pre>void&nbsp;disconnectFromSystem()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Disconnects this agent from the distributed system and unregisters the management beans that
provided information about it. However, this agent's adapters are not stopped and it is
possible to reconfigure this <code>Agent</code> to connect to another distributed system.</div>
</li>
</ul>
<a name="saveProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveProperties</h4>
<pre>void&nbsp;saveProperties()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Saves the configuration for this <code>Agent</code> to the file specified by @link
AgentConfig#getPropertyFile.</div>
</li>
</ul>
<a name="getLogWriter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLogWriter</h4>
<pre><a href="../../../../../org/apache/geode/LogWriter.html" title="interface in org.apache.geode">LogWriter</a>&nbsp;getLogWriter()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the <code>LogWriter</code> used for logging information.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>LogWriter</code> used for logging information</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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/geode/admin/jmx/AgentConfig.html" title="interface in org.apache.geode.admin.jmx"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/geode/admin/jmx/Agent.html" target="_top">Frames</a></li>
<li><a href="Agent.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>