Google Git
Sign in
apache / geode-site / fc25d29c7053eb6dc81bcd70f2b22d855a2be473 / . / releases / latest / javadoc / org / apache / geode / admin / GemFireHealth.html
blob: f39ab99acb25c3fcb7941dcee388ee32be87ff0a [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>GemFireHealth (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="GemFireHealth (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};
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><a href="../../../../org/apache/geode/admin/DistributionLocatorConfig.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/admin/GemFireHealth.html" target="_top">Frames</a></li>
<li><a href="GemFireHealth.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><a href="#nested.class.summary">Nested</a>&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</div>
<h2 title="Interface GemFireHealth" class="title">Interface GemFireHealth</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">GemFireHealth</span></pre>
<div class="block">Provides information about the aggregate health of the members of a GemFire distributed system
("components"). The <a href="../../../../org/apache/geode/admin/GemFireHealth.html#getHealth--"><code>getHealth</code></a> method provides an indication of the overall
health. Health is expressed as one of three levels: <a href="../../../../org/apache/geode/admin/GemFireHealth.html#GOOD_HEALTH"><code>GOOD_HEALTH</code></a>,
<a href="../../../../org/apache/geode/admin/GemFireHealth.html#OKAY_HEALTH"><code>OKAY_HEALTH</code></a>, and <a href="../../../../org/apache/geode/admin/GemFireHealth.html#POOR_HEALTH"><code>POOR_HEALTH</code></a>. The <a href="../../../../org/apache/geode/admin/GemFireHealth.html#getDiagnosis--"><code>getDiagnosis</code></a> method provides a more detailed explanation of the cause of ill health.
<P>
The aggregate health of the GemFire component is evaluated
<a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html#setHealthEvaluationInterval-int-">every so often</a> and if certain
criteria are met, then the overall health of the component changes accordingly. If any of the
components is in <code>OKAY_HEALTH</code>, then the overall health is <code>OKAY_HEALTH</code>.
If any of the components is in <code>POOR_HEALTH</code>, then the overall health is
<code>POOR_HEALTH</code>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 3.5</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin">GemFireHealth.Health</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">An enumerated type for the health of GemFire.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== 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="../../../../org/apache/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin">GemFireHealth.Health</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealth.html#GOOD_HEALTH">GOOD_HEALTH</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">An indicator that the GemFire components are healthy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin">GemFireHealth.Health</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealth.html#OKAY_HEALTH">OKAY_HEALTH</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">An indicator that one or more GemFire components is slightly unhealthy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin">GemFireHealth.Health</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealth.html#POOR_HEALTH">POOR_HEALTH</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">An indicator that one or more GemFire components is unhealthy.</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealth.html#close--">close</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Closes this health monitor and releases all resources associated with it.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html" title="interface in org.apache.geode.admin">GemFireHealthConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealth.html#getDefaultGemFireHealthConfig--">getDefaultGemFireHealthConfig</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the <code>GemFireHealthConfig</code> for GemFire components whose configurations are
not overridden on a per-host basis.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><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/GemFireHealth.html#getDiagnosis--">getDiagnosis</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns a message that provides a description of the cause of a component's ill health.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/admin/DistributedSystemHealthConfig.html" title="interface in org.apache.geode.admin">DistributedSystemHealthConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealth.html#getDistributedSystemHealthConfig--">getDistributedSystemHealthConfig</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the configuration for determining the health of the distributed system itself.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html" title="interface in org.apache.geode.admin">GemFireHealthConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealth.html#getGemFireHealthConfig-java.lang.String-">getGemFireHealthConfig</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>&nbsp;hostName)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the <code>GemFireHealthConfig</code> for GemFire components that reside on a given
host.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin">GemFireHealth.Health</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealth.html#getHealth--">getHealth</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns an indicator of the overall health of the GemFire components.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealth.html#isClosed--">isClosed</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns whether or not this <code>GemFireHealth</code> is <a href="../../../../org/apache/geode/admin/GemFireHealth.html#close--">closed</a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealth.html#resetHealth--">resetHealth</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Resets the overall health of the GemFire components to <a href="../../../../org/apache/geode/admin/GemFireHealth.html#GOOD_HEALTH"><code>GOOD_HEALTH</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealth.html#setDefaultGemFireHealthConfig-org.apache.geode.admin.GemFireHealthConfig-">setDefaultGemFireHealthConfig</a></span>(<a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html" title="interface in org.apache.geode.admin">GemFireHealthConfig</a>&nbsp;config)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Sets the <code>GemFireHealthConfig</code> for GemFire components whose configurations are not
overridden on a per-host basis.</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/GemFireHealth.html#setDistributedSystemHealthConfig-org.apache.geode.admin.DistributedSystemHealthConfig-">setDistributedSystemHealthConfig</a></span>(<a href="../../../../org/apache/geode/admin/DistributedSystemHealthConfig.html" title="interface in org.apache.geode.admin">DistributedSystemHealthConfig</a>&nbsp;config)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Sets the configuration for determining the health of the distributed system itself.</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/GemFireHealth.html#setGemFireHealthConfig-java.lang.String-org.apache.geode.admin.GemFireHealthConfig-">setGemFireHealthConfig</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>&nbsp;hostName,
<a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html" title="interface in org.apache.geode.admin">GemFireHealthConfig</a>&nbsp;config)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Sets the <code>GemFireHealthConfig</code> for GemFire components that reside on a given host.</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="GOOD_HEALTH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GOOD_HEALTH</h4>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
static final&nbsp;<a href="../../../../org/apache/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin">GemFireHealth.Health</a> GOOD_HEALTH</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">An indicator that the GemFire components are healthy.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/admin/GemFireHealth.html#getHealth--"><code>getHealth()</code></a></dd>
</dl>
</li>
</ul>
<a name="OKAY_HEALTH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OKAY_HEALTH</h4>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
static final&nbsp;<a href="../../../../org/apache/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin">GemFireHealth.Health</a> OKAY_HEALTH</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">An indicator that one or more GemFire components is slightly unhealthy. The problem may or may
not require configuration changes and may not necessarily lead to poorer component health.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/admin/GemFireHealth.html#getHealth--"><code>getHealth()</code></a></dd>
</dl>
</li>
</ul>
<a name="POOR_HEALTH">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>POOR_HEALTH</h4>
<pre><a href="../../../../org/apache/geode/annotations/Immutable.html" title="annotation in org.apache.geode.annotations">@Immutable</a>
static final&nbsp;<a href="../../../../org/apache/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin">GemFireHealth.Health</a> POOR_HEALTH</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">An indicator that one or more GemFire components is unhealthy. While it may be possible for the
components to recover on their own, it is likely that they will have to be restarted.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/admin/GemFireHealth.html#getHealth--"><code>getHealth()</code></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="getHealth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHealth</h4>
<pre><a href="../../../../org/apache/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin">GemFireHealth.Health</a>&nbsp;getHealth()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns an indicator of the overall health of the GemFire components.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an indicator of the overall health of the GemFire components</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/geode/admin/GemFireHealth.html#GOOD_HEALTH"><code>GOOD_HEALTH</code></a>,
<a href="../../../../org/apache/geode/admin/GemFireHealth.html#OKAY_HEALTH"><code>OKAY_HEALTH</code></a>,
<a href="../../../../org/apache/geode/admin/GemFireHealth.html#POOR_HEALTH"><code>POOR_HEALTH</code></a></dd>
</dl>
</li>
</ul>
<a name="resetHealth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetHealth</h4>
<pre>void&nbsp;resetHealth()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Resets the overall health of the GemFire components to <a href="../../../../org/apache/geode/admin/GemFireHealth.html#GOOD_HEALTH"><code>GOOD_HEALTH</code></a>. This operation
should be invoked when the operator has determined that warnings about the components's health
do not need to be regarded.</div>
</li>
</ul>
<a name="getDiagnosis--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiagnosis</h4>
<pre><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>&nbsp;getDiagnosis()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns a message that provides a description of the cause of a component's ill health.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a message that provides a description of the cause of a component's ill health</dd>
</dl>
</li>
</ul>
<a name="getDistributedSystemHealthConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDistributedSystemHealthConfig</h4>
<pre><a href="../../../../org/apache/geode/admin/DistributedSystemHealthConfig.html" title="interface in org.apache.geode.admin">DistributedSystemHealthConfig</a>&nbsp;getDistributedSystemHealthConfig()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the configuration for determining the health of the distributed system itself.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configuration for determining the health of the distributed system itself</dd>
</dl>
</li>
</ul>
<a name="setDistributedSystemHealthConfig-org.apache.geode.admin.DistributedSystemHealthConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDistributedSystemHealthConfig</h4>
<pre>void&nbsp;setDistributedSystemHealthConfig(<a href="../../../../org/apache/geode/admin/DistributedSystemHealthConfig.html" title="interface in org.apache.geode.admin">DistributedSystemHealthConfig</a>&nbsp;config)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Sets the configuration for determining the health of the distributed system itself.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - the configuration for determining the health of the distributed system itself</dd>
</dl>
</li>
</ul>
<a name="getDefaultGemFireHealthConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultGemFireHealthConfig</h4>
<pre><a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html" title="interface in org.apache.geode.admin">GemFireHealthConfig</a>&nbsp;getDefaultGemFireHealthConfig()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the <code>GemFireHealthConfig</code> for GemFire components whose configurations are
not overridden on a per-host basis. Note that changes made to the returned
<code>GemFireHealthConfig</code> will not take effect until
<a href="../../../../org/apache/geode/admin/GemFireHealth.html#setDefaultGemFireHealthConfig-org.apache.geode.admin.GemFireHealthConfig-"><code>setDefaultGemFireHealthConfig(org.apache.geode.admin.GemFireHealthConfig)</code></a> is invoked.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>GemFireHealthConfig</code> for GemFire components whose configurations are
not overridden on a per-host basis</dd>
</dl>
</li>
</ul>
<a name="setDefaultGemFireHealthConfig-org.apache.geode.admin.GemFireHealthConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultGemFireHealthConfig</h4>
<pre>void&nbsp;setDefaultGemFireHealthConfig(<a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html" title="interface in org.apache.geode.admin">GemFireHealthConfig</a>&nbsp;config)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Sets the <code>GemFireHealthConfig</code> for GemFire components whose configurations are not
overridden on a per-host basis.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - the <code>GemFireHealthConfig</code> for GemFire components whose configurations
are not overridden on a per-host basis</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If <code>config</code> specifies the config for a host</dd>
</dl>
</li>
</ul>
<a name="getGemFireHealthConfig-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGemFireHealthConfig</h4>
<pre><a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html" title="interface in org.apache.geode.admin">GemFireHealthConfig</a>&nbsp;getGemFireHealthConfig(<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>&nbsp;hostName)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the <code>GemFireHealthConfig</code> for GemFire components that reside on a given
host. This configuration will override the <a href="../../../../org/apache/geode/admin/GemFireHealth.html#getDefaultGemFireHealthConfig--">default</a>
configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hostName</code> - The <a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true#getCanonicalHostName--" title="class or interface in java.net">canonical</a> name of
the host.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>GemFireHealthConfig</code> for GemFire components that reside on a given
host</dd>
</dl>
</li>
</ul>
<a name="setGemFireHealthConfig-java.lang.String-org.apache.geode.admin.GemFireHealthConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGemFireHealthConfig</h4>
<pre>void&nbsp;setGemFireHealthConfig(<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>&nbsp;hostName,
<a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html" title="interface in org.apache.geode.admin">GemFireHealthConfig</a>&nbsp;config)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Sets the <code>GemFireHealthConfig</code> for GemFire components that reside on a given host.
This configuration will override the <a href="../../../../org/apache/geode/admin/GemFireHealth.html#getDefaultGemFireHealthConfig--">default</a>
configuration. Note that changes made to the returned <code>GemFireHealthConfig</code> will not
take effect until <a href="../../../../org/apache/geode/admin/GemFireHealth.html#setDefaultGemFireHealthConfig-org.apache.geode.admin.GemFireHealthConfig-"><code>setDefaultGemFireHealthConfig(org.apache.geode.admin.GemFireHealthConfig)</code></a> is invoked.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hostName</code> - The <a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true#getCanonicalHostName--" title="class or interface in java.net">canonical</a> name of
the host.</dd>
<dd><code>config</code> - the <code>GemFireHealthConfig</code> to set</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If host <code>hostName</code> does not exist or if there are
no GemFire components running on that host or if <code>config</code> does not configure
host <code>hostName</code>.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Closes this health monitor and releases all resources associated with it.</div>
</li>
</ul>
<a name="isClosed--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isClosed</h4>
<pre>boolean&nbsp;isClosed()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns whether or not this <code>GemFireHealth</code> is <a href="../../../../org/apache/geode/admin/GemFireHealth.html#close--">closed</a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this <code>GemFireHealth</code> is <a href="../../../../org/apache/geode/admin/GemFireHealth.html#close--">closed</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/admin/DistributionLocatorConfig.html" title="interface in org.apache.geode.admin"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/admin/GemFireHealth.html" target="_top">Frames</a></li>
<li><a href="GemFireHealth.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><a href="#nested.class.summary">Nested</a>&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>