http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html new file mode 100644 index 0000000..caeeb8c --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html @@ -0,0 +1,333 @@ +<!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 (1.8.0_45) on Fri Mar 11 16:13:07 PST 2016 --> +<title>DistributedSystemHealthConfig (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<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="DistributedSystemHealthConfig (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":38,"i1":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="../../../../com/gemstone/gemfire/admin/DistributedSystemConfig.ConfigListener.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/admin/DistributionLocator.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html" target="_top">Frames</a></li> +<li><a href="DistributedSystemHealthConfig.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><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </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">com.gemstone.gemfire.admin</div> +<h2 title="Interface DistributedSystemHealthConfig" class="title">Interface DistributedSystemHealthConfig</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href="../../../../com/gemstone/gemfire/management/package-summary.html">management</a></code> package instead</span></div> +</div> +<br> +<pre>public interface <span class="typeNameLabel">DistributedSystemHealthConfig</span></pre> +<div class="block">Provides configuration information relating to the health of an + entire GemFire distributed system. + + <P> + + If any of the following criteria is + true, then the distributed system is considered to be in + <a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#OKAY_HEALTH"><code>OKAY_HEALTH</code></a>. + + <UL> + + </UL> + + If any of the following criteria is true, then the distributed + system is considered to be in <a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#POOR_HEALTH"><code>POOR_HEALTH</code></a>. + + <UL> + + <LI>Too many application members <a href="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html#getMaxDepartedApplications--">unexpectedly leave</a> the distributed + system.</LI> + + <LI>Too many application members <a href="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html#getMaxDepartedApplications--">unexpectedly leave</a> the distributed + system.</LI> + + </UL></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>3.5</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"> </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 long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html#DEFAULT_MAX_DEPARTED_APPLICATIONS">DEFAULT_MAX_DEPARTED_APPLICATIONS</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">The default maximum number of application members that can + unexceptedly leave a healthy the distributed system.</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"> </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="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html#getMaxDepartedApplications--">getMaxDepartedApplications</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the maximum number of application members that can + unexceptedly leave a healthy the distributed system.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html#setMaxDepartedApplications-long-">setMaxDepartedApplications</a></span>(long maxDepartedApplications)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the maximum number of application members that can + unexceptedly leave a healthy the distributed system.</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="DEFAULT_MAX_DEPARTED_APPLICATIONS"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DEFAULT_MAX_DEPARTED_APPLICATIONS</h4> +<pre>static final long DEFAULT_MAX_DEPARTED_APPLICATIONS</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">The default maximum number of application members that can + unexceptedly leave a healthy the distributed system.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#com.gemstone.gemfire.admin.DistributedSystemHealthConfig.DEFAULT_MAX_DEPARTED_APPLICATIONS">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="getMaxDepartedApplications--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxDepartedApplications</h4> +<pre>long getMaxDepartedApplications()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the maximum number of application members that can + unexceptedly leave a healthy the distributed system.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html#DEFAULT_MAX_DEPARTED_APPLICATIONS"><code>DEFAULT_MAX_DEPARTED_APPLICATIONS</code></a></dd> +</dl> +</li> +</ul> +<a name="setMaxDepartedApplications-long-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setMaxDepartedApplications</h4> +<pre>void setMaxDepartedApplications(long maxDepartedApplications)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the maximum number of application members that can + unexceptedly leave a healthy the distributed system.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html#getMaxDepartedApplications--"><code>getMaxDepartedApplications()</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="../../../../com/gemstone/gemfire/admin/DistributedSystemConfig.ConfigListener.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/admin/DistributionLocator.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html" target="_top">Frames</a></li> +<li><a href="DistributedSystemHealthConfig.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><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/DistributionLocator.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/DistributionLocator.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/DistributionLocator.html new file mode 100644 index 0000000..95173cf --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/DistributionLocator.html @@ -0,0 +1,271 @@ +<!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 (1.8.0_45) on Fri Mar 11 16:13:07 PST 2016 --> +<title>DistributionLocator (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<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="DistributionLocator (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":38,"i1":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="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/admin/DistributionLocator.html" target="_top">Frames</a></li> +<li><a href="DistributionLocator.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.gemstone.gemfire.admin</div> +<h2 title="Interface DistributionLocator" class="title">Interface DistributionLocator</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/gemstone/gemfire/admin/ManagedEntity.html" title="interface in com.gemstone.gemfire.admin">ManagedEntity</a></dd> +</dl> +<hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href="../../../../com/gemstone/gemfire/management/package-summary.html">management</a></code> package instead</span></div> +</div> +<br> +<pre>public interface <span class="typeNameLabel">DistributionLocator</span> +extends <a href="../../../../com/gemstone/gemfire/admin/ManagedEntity.html" title="interface in com.gemstone.gemfire.admin">ManagedEntity</a></pre> +<div class="block">Represents a single distribution locator server, of which a + distributed system may use zero or many. The distributed system + will be configured to use either multicast discovery or locator + service.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>3.5</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html" title="interface in com.gemstone.gemfire.admin"><code>DistributionLocatorConfig</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="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="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><a href="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html" title="interface in com.gemstone.gemfire.admin">DistributionLocatorConfig</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/DistributionLocator.html#getConfig--">getConfig</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the configuration object for this distribution locator.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/DistributionLocator.html#getId--">getId</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the identity name for this locator.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.admin.ManagedEntity"> +<!-- --> +</a> +<h3>Methods inherited from interface com.gemstone.gemfire.admin.<a href="../../../../com/gemstone/gemfire/admin/ManagedEntity.html" title="interface in com.gemstone.gemfire.admin">ManagedEntity</a></h3> +<code><a href="../../../../com/gemstone/gemfire/admin/ManagedEntity.html#getLog--">getLog</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntity.html#isRunning--">isRunning</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntity.html#start--">start</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntity.html#stop--">stop</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntity.html#waitToStart-long-">waitToStart</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntity.html#waitToStop-long-">waitToStop</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getId</h4> +<pre>java.lang.String getId()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the identity name for this locator.</div> +</li> +</ul> +<a name="getConfig--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getConfig</h4> +<pre><a href="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html" title="interface in com.gemstone.gemfire.admin">DistributionLocatorConfig</a> getConfig()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the configuration object for this distribution locator.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>4.0</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="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/admin/DistributionLocator.html" target="_top">Frames</a></li> +<li><a href="DistributionLocator.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/DistributionLocatorConfig.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/DistributionLocatorConfig.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/DistributionLocatorConfig.html new file mode 100644 index 0000000..8452549 --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/DistributionLocatorConfig.html @@ -0,0 +1,374 @@ +<!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 (1.8.0_45) on Fri Mar 11 16:13:07 PST 2016 --> +<title>DistributionLocatorConfig (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<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="DistributionLocatorConfig (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":38,"i1":38,"i2":38,"i3":38,"i4":38,"i5":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="../../../../com/gemstone/gemfire/admin/DistributionLocator.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/admin/DistributionLocatorConfig.html" target="_top">Frames</a></li> +<li><a href="DistributionLocatorConfig.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.gemstone.gemfire.admin</div> +<h2 title="Interface DistributionLocatorConfig" class="title">Interface DistributionLocatorConfig</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd>java.lang.Cloneable, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntityConfig.html" title="interface in com.gemstone.gemfire.admin">ManagedEntityConfig</a></dd> +</dl> +<hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href="../../../../com/gemstone/gemfire/management/package-summary.html">management</a></code> package instead</span></div> +</div> +<br> +<pre>public interface <span class="typeNameLabel">DistributionLocatorConfig</span> +extends <a href="../../../../com/gemstone/gemfire/admin/ManagedEntityConfig.html" title="interface in com.gemstone.gemfire.admin">ManagedEntityConfig</a></pre> +<div class="block">Describes the configuration of a <a href="../../../../com/gemstone/gemfire/admin/DistributionLocator.html" title="interface in com.gemstone.gemfire.admin"><code>DistributionLocator</code></a> + managed by the GemFire administration APIs. + + <P> + + A <code>DistributionLocatorConfig</code> can be modified using a + number of mutator methods until the + <code>DistributionLocator</code> configured by this object is + <a href="../../../../com/gemstone/gemfire/admin/ManagedEntity.html#start--">started</a>. After that, + attempts to modify most attributes in the + <code>DistributionLocatorConfig</code> will result in an <code>IllegalStateException</code> being thrown. If you wish to use the same + <code>DistributionLocatorConfig</code> to configure another + <code>DistributionLocator</code>s, a copy of the + <code>DistributionLocatorConfig</code> object can be made by + invoking the <code>Object.clone()</code> method.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>4.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/admin/AdminDistributedSystem.html#addDistributionLocator--"><code>AdminDistributedSystem.addDistributionLocator()</code></a>, +<a href="../../../../com/gemstone/gemfire/distributed/Locator.html" title="class in com.gemstone.gemfire.distributed"><code>Locator</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="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="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html#getBindAddress--">getBindAddress</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the address to which the distribution locator's port is + (or will be) bound.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.util.Properties</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html#getDistributedSystemProperties--">getDistributedSystemProperties</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Retrieves the properties used to configure the locator's + DistributedSystem.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html#getPort--">getPort</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the port on which ths distribution locator listens for + members to connect.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html#setBindAddress-java.lang.String-">setBindAddress</a></span>(java.lang.String bindAddress)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the address to which the distribution locator's port is + (or will be) bound.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html#setDistributedSystemProperties-java.util.Properties-">setDistributedSystemProperties</a></span>(java.util.Properties props)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the properties used to configure the locator's + DistributedSystem.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html#setPort-int-">setPort</a></span>(int port)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the port on which the distribution locator listens for + members to connect.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.admin.ManagedEntityConfig"> +<!-- --> +</a> +<h3>Methods inherited from interface com.gemstone.gemfire.admin.<a href="../../../../com/gemstone/gemfire/admin/ManagedEntityConfig.html" title="interface in com.gemstone.gemfire.admin">ManagedEntityConfig</a></h3> +<code><a href="../../../../com/gemstone/gemfire/admin/ManagedEntityConfig.html#clone--">clone</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntityConfig.html#getHost--">getHost</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntityConfig.html#getProductDirectory--">getProductDirectory</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntityConfig.html#getRemoteCommand--">getRemoteCommand</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntityConfig.html#getWorkingDirectory--">getWorkingDirectory</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntityConfig.html#setHost-java.lang.String-">setHost</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntityConfig.html#setProductDirectory-java.lang.String-">setProductDirectory</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntityConfig.html#setRemoteCommand-java.lang.String-">setRemoteCommand</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntityCo nfig.html#setWorkingDirectory-java.lang.String-">setWorkingDirectory</a>, <a href="../../../../com/gemstone/gemfire/admin/ManagedEntityConfig.html#validate--">validate</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPort--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPort</h4> +<pre>int getPort()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the port on which ths distribution locator listens for + members to connect. There is no default locator port, so a + non-default port must be specified.</div> +</li> +</ul> +<a name="setPort-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPort</h4> +<pre>void setPort(int port)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the port on which the distribution locator listens for + members to connect.</div> +</li> +</ul> +<a name="getBindAddress--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBindAddress</h4> +<pre>java.lang.String getBindAddress()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the address to which the distribution locator's port is + (or will be) bound. By default, the bind address is + <code>null</code> meaning that the port will be bound to all + network addresses on the host.</div> +</li> +</ul> +<a name="setBindAddress-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBindAddress</h4> +<pre>void setBindAddress(java.lang.String bindAddress)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the address to which the distribution locator's port is + (or will be) bound.</div> +</li> +</ul> +<a name="setDistributedSystemProperties-java.util.Properties-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDistributedSystemProperties</h4> +<pre>void setDistributedSystemProperties(java.util.Properties props)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the properties used to configure the locator's + DistributedSystem.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>5.0</dd> +</dl> +</li> +</ul> +<a name="getDistributedSystemProperties--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDistributedSystemProperties</h4> +<pre>java.util.Properties getDistributedSystemProperties()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Retrieves the properties used to configure the locator's + DistributedSystem.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>5.0</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="../../../../com/gemstone/gemfire/admin/DistributionLocator.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/admin/DistributionLocatorConfig.html" target="_top">Frames</a></li> +<li><a href="DistributionLocatorConfig.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/GemFireHealth.Health.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/GemFireHealth.Health.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/GemFireHealth.Health.html new file mode 100644 index 0000000..6b309fa --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/GemFireHealth.Health.html @@ -0,0 +1,310 @@ +<!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 (1.8.0_45) on Fri Mar 11 16:13:07 PST 2016 --> +<title>GemFireHealth.Health (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<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.Health (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="../../../../com/gemstone/gemfire/admin/GemFireHealth.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/admin/GemFireHealthConfig.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/admin/GemFireHealth.Health.html" target="_top">Frames</a></li> +<li><a href="GemFireHealth.Health.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">com.gemstone.gemfire.admin</div> +<h2 title="Class GemFireHealth.Health" class="title">Class GemFireHealth.Health</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.admin.GemFireHealth.Health</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html" title="interface in com.gemstone.gemfire.admin">GemFireHealth</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">GemFireHealth.Health</span> +extends java.lang.Object +implements java.io.Serializable</pre> +<div class="block">An enumerated type for the health of GemFire.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#com.gemstone.gemfire.admin.GemFireHealth.Health">Serialized Form</a></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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html#Health-java.lang.String-">Health</a></span>(java.lang.String healthString)</code> +<div class="block">Creates a new <code>Health</code> with the given string</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html#readResolve--">readResolve</a></span>()</code> +<div class="block">Returns the appropriate canonical instance of + <code>Health</code>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html#toString--">toString</a></span>()</code> </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.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="Health-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Health</h4> +<pre>protected Health(java.lang.String healthString)</pre> +<div class="block">Creates a new <code>Health</code> with the given string</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="readResolve--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readResolve</h4> +<pre>public java.lang.Object readResolve()</pre> +<div class="block">Returns the appropriate canonical instance of + <code>Health</code>.</div> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></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="../../../../com/gemstone/gemfire/admin/GemFireHealth.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/admin/GemFireHealthConfig.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/admin/GemFireHealth.Health.html" target="_top">Frames</a></li> +<li><a href="GemFireHealth.Health.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> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/GemFireHealth.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/GemFireHealth.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/GemFireHealth.html new file mode 100644 index 0000000..5be7eb0 --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/admin/GemFireHealth.html @@ -0,0 +1,602 @@ +<!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 (1.8.0_45) on Fri Mar 11 16:13:07 PST 2016 --> +<title>GemFireHealth (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<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.0.0-incubating.M2-SNAPSHOT)"; + } + } + 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="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html" title="class in com.gemstone.gemfire.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/admin/GemFireHealth.html" target="_top">Frames</a></li> +<li><a href="GemFireHealth.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><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </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">com.gemstone.gemfire.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> +<div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href="../../../../com/gemstone/gemfire/management/package-summary.html">management</a></code> package instead</span></div> +</div> +<br> +<pre>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="../../../../com/gemstone/gemfire/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="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#GOOD_HEALTH"><code>GOOD_HEALTH</code></a>, <a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#OKAY_HEALTH"><code>OKAY_HEALTH</code></a>, and <a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#POOR_HEALTH"><code>POOR_HEALTH</code></a>. The <a href="../../../../com/gemstone/gemfire/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="../../../../com/gemstone/gemfire/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>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"> </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 </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html" title="class in com.gemstone.gemfire.admin">GemFireHealth.Health</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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"> </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="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html" title="class in com.gemstone.gemfire.admin">GemFireHealth.Health</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#GOOD_HEALTH">GOOD_HEALTH</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html" title="class in com.gemstone.gemfire.admin">GemFireHealth.Health</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#OKAY_HEALTH">OKAY_HEALTH</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html" title="class in com.gemstone.gemfire.admin">GemFireHealth.Health</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#POOR_HEALTH">POOR_HEALTH</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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"> </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="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#close--">close</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/admin/GemFireHealthConfig.html" title="interface in com.gemstone.gemfire.admin">GemFireHealthConfig</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#getDefaultGemFireHealthConfig--">getDefaultGemFireHealthConfig</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#getDiagnosis--">getDiagnosis</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html" title="interface in com.gemstone.gemfire.admin">DistributedSystemHealthConfig</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#getDistributedSystemHealthConfig--">getDistributedSystemHealthConfig</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/admin/GemFireHealthConfig.html" title="interface in com.gemstone.gemfire.admin">GemFireHealthConfig</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#getGemFireHealthConfig-java.lang.String-">getGemFireHealthConfig</a></span>(java.lang.String hostName)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html" title="class in com.gemstone.gemfire.admin">GemFireHealth.Health</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#getHealth--">getHealth</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#isClosed--">isClosed</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns whether or not this <code>GemFireHealth</code> is + <a href="../../../../com/gemstone/gemfire/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="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#resetHealth--">resetHealth</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Resets the overall health of the GemFire components to <a href="../../../../com/gemstone/gemfire/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="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#setDefaultGemFireHealthConfig-com.gemstone.gemfire.admin.GemFireHealthConfig-">setDefaultGemFireHealthConfig</a></span>(<a href="../../../../com/gemstone/gemfire/admin/GemFireHealthConfig.html" title="interface in com.gemstone.gemfire.admin">GemFireHealthConfig</a> config)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#setDistributedSystemHealthConfig-com.gemstone.gemfire.admin.DistributedSystemHealthConfig-">setDistributedSystemHealthConfig</a></span>(<a href="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html" title="interface in com.gemstone.gemfire.admin">DistributedSystemHealthConfig</a> config)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#setGemFireHealthConfig-java.lang.String-com.gemstone.gemfire.admin.GemFireHealthConfig-">setGemFireHealthConfig</a></span>(java.lang.String hostName, + <a href="../../../../com/gemstone/gemfire/admin/GemFireHealthConfig.html" title="interface in com.gemstone.gemfire.admin">GemFireHealthConfig</a> config)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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>static final <a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html" title="class in com.gemstone.gemfire.admin">GemFireHealth.Health</a> GOOD_HEALTH</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/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>static final <a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html" title="class in com.gemstone.gemfire.admin">GemFireHealth.Health</a> OKAY_HEALTH</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/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>static final <a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html" title="class in com.gemstone.gemfire.admin">GemFireHealth.Health</a> POOR_HEALTH</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/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="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html" title="class in com.gemstone.gemfire.admin">GemFireHealth.Health</a> getHealth()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns an indicator of the overall health of the GemFire + components.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#GOOD_HEALTH"><code>GOOD_HEALTH</code></a>, +<a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#OKAY_HEALTH"><code>OKAY_HEALTH</code></a>, +<a href="../../../../com/gemstone/gemfire/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 resetHealth()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Resets the overall health of the GemFire components to <a href="../../../../com/gemstone/gemfire/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>java.lang.String getDiagnosis()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns a message that provides a description of the cause of a + component's ill health.</div> +</li> +</ul> +<a name="getDistributedSystemHealthConfig--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDistributedSystemHealthConfig</h4> +<pre><a href="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html" title="interface in com.gemstone.gemfire.admin">DistributedSystemHealthConfig</a> getDistributedSystemHealthConfig()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns the configuration for determining the health of the + distributed system itself.</div> +</li> +</ul> +<a name="setDistributedSystemHealthConfig-com.gemstone.gemfire.admin.DistributedSystemHealthConfig-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDistributedSystemHealthConfig</h4> +<pre>void setDistributedSystemHealthConfig(<a href="../../../../com/gemstone/gemfire/admin/DistributedSystemHealthConfig.html" title="interface in com.gemstone.gemfire.admin">DistributedSystemHealthConfig</a> config)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Sets the configuration for determining the health of the + distributed system itself.</div> +</li> +</ul> +<a name="getDefaultGemFireHealthConfig--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultGemFireHealthConfig</h4> +<pre><a href="../../../../com/gemstone/gemfire/admin/GemFireHealthConfig.html" title="interface in com.gemstone.gemfire.admin">GemFireHealthConfig</a> getDefaultGemFireHealthConfig()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#setDefaultGemFireHealthConfig-com.gemstone.gemfire.admin.GemFireHealthConfig-"><code>setDefaultGemFireHealthConfig(com.gemstone.gemfire.admin.GemFireHealthConfig)</code></a> is invoked.</div> +</li> +</ul> +<a name="setDefaultGemFireHealthConfig-com.gemstone.gemfire.admin.GemFireHealthConfig-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultGemFireHealthConfig</h4> +<pre>void setDefaultGemFireHealthConfig(<a href="../../../../com/gemstone/gemfire/admin/GemFireHealthConfig.html" title="interface in com.gemstone.gemfire.admin">GemFireHealthConfig</a> config)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</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="../../../../com/gemstone/gemfire/admin/GemFireHealthConfig.html" title="interface in com.gemstone.gemfire.admin">GemFireHealthConfig</a> getGemFireHealthConfig(java.lang.String hostName)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#getDefaultGemFireHealthConfig--">default</a> + configuration.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>hostName</code> - The canonical name of the host.</dd> +</dl> +</li> +</ul> +<a name="setGemFireHealthConfig-java.lang.String-com.gemstone.gemfire.admin.GemFireHealthConfig-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setGemFireHealthConfig</h4> +<pre>void setGemFireHealthConfig(java.lang.String hostName, + <a href="../../../../com/gemstone/gemfire/admin/GemFireHealthConfig.html" title="interface in com.gemstone.gemfire.admin">GemFireHealthConfig</a> config)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#getDefaultGemFireHealthConfig--">default</a> + configuration. Note that changes made to the returned + <code>GemFireHealthConfig</code> will not take effect until + <a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#setDefaultGemFireHealthConfig-com.gemstone.gemfire.admin.GemFireHealthConfig-"><code>setDefaultGemFireHealthConfig(com.gemstone.gemfire.admin.GemFireHealthConfig)</code></a> is invoked.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>hostName</code> - The canonical name of the host.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</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 close()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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 isClosed()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns whether or not this <code>GemFireHealth</code> is + <a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.html#close--">closed</a>.</div> +</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="../../../../com/gemstone/gemfire/admin/DistributionLocatorConfig.html" title="interface in com.gemstone.gemfire.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/admin/GemFireHealth.Health.html" title="class in com.gemstone.gemfire.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/admin/GemFireHealth.html" target="_top">Frames</a></li> +<li><a href="GemFireHealth.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><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>