blob: 5792f133e0ec2700c414935280017d3aef162d3d [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>
<link rel="canonical" href="https://ignite.apache.org/releases/2.10.0/javadoc/org/apache/ignite/IgniteCluster.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<!-- Yandex.Metrika counter -->
<script type="text/javascript" >
(function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)};
m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)})
(window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
ym(72949126, "init", {
clickmap:true,
trackLinks:true,
accurateTrackBounce:true,
webvisor:true
});
</script>
<noscript><div><img src="https://mc.yandex.ru/watch/72949126" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
<!-- /Yandex.Metrika counter -->
<script type='text/javascript'>
window.__lo_site_id = 284467;
(function() {
var wa = document.createElement('script'); wa.type = 'text/javascript'; wa.async = true;
wa.src = 'https://d10lpsik1i8c69.cloudfront.net/w.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(wa, s);
})();
</script>
<!-- Generated by javadoc (1.8.0_261) on Thu Mar 11 02:15:42 MSK 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IgniteCluster (Ignite 2.10.0)</title>
<meta name="date" content="2021-03-11">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-61232409-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-61232409-1');
</script></head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IgniteCluster (Ignite 2.10.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":38,"i1":38,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":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="class-use/IgniteCluster.html">Use</a></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/ignite/IgniteClientDisconnectedException.html" title="class in org.apache.ignite"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/ignite/IgniteCompute.html" title="interface in org.apache.ignite"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/ignite/IgniteCluster.html" target="_top">Frames</a></li>
<li><a href="IgniteCluster.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.ignite</div>
<h2 title="Interface IgniteCluster" class="title">Interface IgniteCluster</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../org/apache/ignite/cluster/ClusterGroup.html" title="interface in org.apache.ignite.cluster">ClusterGroup</a>, <a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html" title="interface in org.apache.ignite.lang">IgniteAsyncSupport</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IgniteCluster</span>
extends <a href="../../../org/apache/ignite/cluster/ClusterGroup.html" title="interface in org.apache.ignite.cluster">ClusterGroup</a>, <a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html" title="interface in org.apache.ignite.lang">IgniteAsyncSupport</a></pre>
<div class="block">Represents whole cluster (all available nodes) and also provides a handle on <a href="../../../org/apache/ignite/IgniteCluster.html#nodeLocalMap--"><code>nodeLocalMap()</code></a> which
provides map-like functionality linked to current grid node. Node-local map is useful for saving shared state
between job executions on the grid. Additionally you can also ping, start, and restart remote nodes, map keys to
caching nodes, and get other useful information about topology.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#MAX_TAG_LENGTH">MAX_TAG_LENGTH</a></span></code>
<div class="block">Maximum length of <a href="../../../org/apache/ignite/IgniteCluster.html#tag--"><code>tag()</code></a> tag.</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#active--">active</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../org/apache/ignite/IgniteCluster.html#state--"><code>state()</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#active-boolean-">active</a></span>(boolean&nbsp;active)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../org/apache/ignite/IgniteCluster.html#state-org.apache.ignite.cluster.ClusterState-"><code>state(ClusterState)</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#baselineAutoAdjustEnabled-boolean-">baselineAutoAdjustEnabled</a></span>(boolean&nbsp;baselineAutoAdjustEnabled)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.apache.ignite.internal.processors.cluster.baseline.autoadjust.BaselineAutoAdjustStatus</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#baselineAutoAdjustStatus--">baselineAutoAdjustStatus</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#baselineAutoAdjustTimeout--">baselineAutoAdjustTimeout</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#baselineAutoAdjustTimeout-long-">baselineAutoAdjustTimeout</a></span>(long&nbsp;baselineAutoAdjustTimeout)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#clearStatistics-java.util.Collection-">clearStatistics</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</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><span class='angle_bracket'>&gt;</span>&nbsp;caches)</code>
<div class="block">Clear statistics for caches cluster wide.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>@Nullable <a href="../../../org/apache/ignite/lang/IgniteFuture.html" title="interface in org.apache.ignite.lang">IgniteFuture</a><span class='angle_bracket'>&lt;</span>?<span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#clientReconnectFuture--">clientReconnectFuture</a></span>()</code>
<div class="block">If local client node disconnected from cluster returns future
that will be completed when client reconnected.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>@Nullable <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="../../../org/apache/ignite/cluster/BaselineNode.html" title="interface in org.apache.ignite.cluster">BaselineNode</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#currentBaselineTopology--">currentBaselineTopology</a></span>()</code>
<div class="block">Gets current baseline topology.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#disableWal-java.lang.String-">disableWal</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;cacheName)</code>
<div class="block">Disables write-ahead logging for specified cache.</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/ignite/IgniteCluster.html#enableStatistics-java.util.Collection-boolean-">enableStatistics</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</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><span class='angle_bracket'>&gt;</span>&nbsp;caches,
boolean&nbsp;enabled)</code>
<div class="block">Enables/disables statistics for caches cluster wide.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#enableWal-java.lang.String-">enableWal</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;cacheName)</code>
<div class="block">Enables write-ahead logging for specified cache.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/ignite/cluster/ClusterGroup.html" title="interface in org.apache.ignite.cluster">ClusterGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#forLocal--">forLocal</a></span>()</code>
<div class="block">Gets a cluster group consisting from the local node.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#id--">id</a></span>()</code>
<div class="block">Cluster ID is a unique identifier automatically generated when cluster starts up for the very first time.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#isBaselineAutoAdjustEnabled--">isBaselineAutoAdjustEnabled</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#isWalEnabled-java.lang.String-">isWalEnabled</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;cacheName)</code>
<div class="block">Checks if write-ahead logging is enabled for specified cache.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#localNode--">localNode</a></span>()</code>
<div class="block">Gets local grid node.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#nodeLocalMap--">nodeLocalMap</a></span>()</code>
<div class="block">Gets node-local storage instance.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#pingNode-java.util.UUID-">pingNode</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;nodeId)</code>
<div class="block">Pings a remote node.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#resetMetrics--">resetMetrics</a></span>()</code>
<div class="block">Resets local I/O, job, and task execution metrics.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#restartNodes--">restartNodes</a></span>()</code>
<div class="block">Restarts nodes satisfying optional set of predicates.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#restartNodes-java.util.Collection-">restartNodes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a><span class='angle_bracket'>&gt;</span>&nbsp;ids)</code>
<div class="block">Restarts nodes defined by provided IDs.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#setBaselineTopology-java.util.Collection-">setBaselineTopology</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span>? extends <a href="../../../org/apache/ignite/cluster/BaselineNode.html" title="interface in org.apache.ignite.cluster">BaselineNode</a><span class='angle_bracket'>&gt;</span>&nbsp;baselineTop)</code>
<div class="block">Sets baseline topology.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#setBaselineTopology-long-">setBaselineTopology</a></span>(long&nbsp;topVer)</code>
<div class="block">Sets baseline topology constructed from the cluster topology of the given version (the method succeeds
only if the cluster topology has not changed).</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#setTxTimeoutOnPartitionMapExchange-long-">setTxTimeoutOnPartitionMapExchange</a></span>(long&nbsp;timeout)</code>
<div class="block">Sets transaction timeout on partition map exchange.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/ignite/ShutdownPolicy.html" title="enum in org.apache.ignite">ShutdownPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#shutdownPolicy--">shutdownPolicy</a></span>()</code>
<div class="block">Returns a policy of shutdown or default value <code>IgniteConfiguration.DFLT_SHUTDOWN_POLICY</code>
if the property is not set.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#shutdownPolicy-org.apache.ignite.ShutdownPolicy-">shutdownPolicy</a></span>(<a href="../../../org/apache/ignite/ShutdownPolicy.html" title="enum in org.apache.ignite">ShutdownPolicy</a>&nbsp;shutdownPolicy)</code>
<div class="block">Sets a shutdown policy on a cluster.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="../../../org/apache/ignite/cluster/ClusterStartNodeResult.html" title="interface in org.apache.ignite.cluster">ClusterStartNodeResult</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#startNodes-java.util.Collection-java.util.Map-boolean-int-int-">startNodes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'>&lt;</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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;hosts,
@Nullable <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'>&lt;</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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a><span class='angle_bracket'>&gt;</span>&nbsp;dflts,
boolean&nbsp;restart,
int&nbsp;timeout,
int&nbsp;maxConn)</code>
<div class="block">Starts one or more nodes on remote host(s).</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="../../../org/apache/ignite/cluster/ClusterStartNodeResult.html" title="interface in org.apache.ignite.cluster">ClusterStartNodeResult</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#startNodes-java.io.File-boolean-int-int-">startNodes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
boolean&nbsp;restart,
int&nbsp;timeout,
int&nbsp;maxConn)</code>
<div class="block">Starts one or more nodes on remote host(s).</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/ignite/lang/IgniteFuture.html" title="interface in org.apache.ignite.lang">IgniteFuture</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="../../../org/apache/ignite/cluster/ClusterStartNodeResult.html" title="interface in org.apache.ignite.cluster">ClusterStartNodeResult</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#startNodesAsync-java.util.Collection-java.util.Map-boolean-int-int-">startNodesAsync</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'>&lt;</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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;hosts,
@Nullable <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'>&lt;</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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a><span class='angle_bracket'>&gt;</span>&nbsp;dflts,
boolean&nbsp;restart,
int&nbsp;timeout,
int&nbsp;maxConn)</code>
<div class="block">Starts one or more nodes on remote host(s) asynchronously.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/ignite/lang/IgniteFuture.html" title="interface in org.apache.ignite.lang">IgniteFuture</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="../../../org/apache/ignite/cluster/ClusterStartNodeResult.html" title="interface in org.apache.ignite.cluster">ClusterStartNodeResult</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#startNodesAsync-java.io.File-boolean-int-int-">startNodesAsync</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
boolean&nbsp;restart,
int&nbsp;timeout,
int&nbsp;maxConn)</code>
<div class="block">Starts one or more nodes on remote host(s) asynchronously.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/ignite/cluster/ClusterState.html" title="enum in org.apache.ignite.cluster">ClusterState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#state--">state</a></span>()</code>
<div class="block">Gets current cluster state.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#state-org.apache.ignite.cluster.ClusterState-">state</a></span>(<a href="../../../org/apache/ignite/cluster/ClusterState.html" title="enum in org.apache.ignite.cluster">ClusterState</a>&nbsp;newState)</code>
<div class="block">Changes current cluster state to given <code>newState</code> cluster state.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#stopNodes--">stopNodes</a></span>()</code>
<div class="block">Stops nodes satisfying optional set of predicates.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#stopNodes-java.util.Collection-">stopNodes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a><span class='angle_bracket'>&gt;</span>&nbsp;ids)</code>
<div class="block">Stops nodes defined by provided IDs.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<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/ignite/IgniteCluster.html#tag--">tag</a></span>()</code>
<div class="block">User-defined tag describing the cluster.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#tag-java.lang.String-">tag</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;tag)</code>
<div class="block">Enables user to add a specific label to the cluster e.g. to describe purpose of the cluster
or any its characteristics.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#topology-long-">topology</a></span>(long&nbsp;topVer)</code>
<div class="block">Gets a topology by version.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#topologyVersion--">topologyVersion</a></span>()</code>
<div class="block">Gets current topology version.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/ignite/IgniteCluster.html" title="interface in org.apache.ignite">IgniteCluster</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteCluster.html#withAsync--">withAsync</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.cluster.ClusterGroup">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.ignite.cluster.<a href="../../../org/apache/ignite/cluster/ClusterGroup.html" title="interface in org.apache.ignite.cluster">ClusterGroup</a></h3>
<code><a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forAttribute-java.lang.String-java.lang.Object-">forAttribute</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forCacheNodes-java.lang.String-">forCacheNodes</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forClientNodes-java.lang.String-">forClientNodes</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forClients--">forClients</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forDaemons--">forDaemons</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forDataNodes-java.lang.String-">forDataNodes</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forHost-org.apache.ignite.cluster.ClusterNode-">forHost</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forHost-java.lang.String-java.lang.String...-">forHost</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forNode-org.apache.ignite.cluster.ClusterNode-org.apache.ignite.cluster.ClusterNode...-">forNode</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forNodeId-java.util.UUID-java.util.UUID...-">forNodeId</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forNodeIds-java.util.Collection-">forNodeIds</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forNodes-java.util.Collection-">forNodes</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forOldest--">forOldest</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forOthers-org.apache.ignite.cluster.ClusterGroup-">forOthers</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forOthers-org.apache.ignite.cluster.ClusterNode-org.apache.ignite.cluster.ClusterNode...-">forOthers</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forPredicate-org.apache.ignite.lang.IgnitePredicate-">forPredicate</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forRandom--">forRandom</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forRemotes--">forRemotes</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forServers--">forServers</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#forYoungest--">forYoungest</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#hostNames--">hostNames</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#ignite--">ignite</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#metrics--">metrics</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#node--">node</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#node-java.util.UUID-">node</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#nodes--">nodes</a>, <a href="../../../org/apache/ignite/cluster/ClusterGroup.html#predicate--">predicate</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.lang.IgniteAsyncSupport">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.ignite.lang.<a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html" title="interface in org.apache.ignite.lang">IgniteAsyncSupport</a></h3>
<code><a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html#future--">future</a>, <a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html#isAsync--">isAsync</a></code></li>
</ul>
</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="MAX_TAG_LENGTH">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MAX_TAG_LENGTH</h4>
<pre>static final&nbsp;int MAX_TAG_LENGTH</pre>
<div class="block">Maximum length of <a href="../../../org/apache/ignite/IgniteCluster.html#tag--"><code>tag()</code></a> tag.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.apache.ignite.IgniteCluster.MAX_TAG_LENGTH">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="localNode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>localNode</h4>
<pre><a href="../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a>&nbsp;localNode()</pre>
<div class="block">Gets local grid node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Local grid node.</dd>
</dl>
</li>
</ul>
<a name="forLocal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forLocal</h4>
<pre><a href="../../../org/apache/ignite/cluster/ClusterGroup.html" title="interface in org.apache.ignite.cluster">ClusterGroup</a>&nbsp;forLocal()</pre>
<div class="block">Gets a cluster group consisting from the local node.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Cluster group consisting from the local node.</dd>
</dl>
</li>
</ul>
<a name="nodeLocalMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nodeLocalMap</h4>
<pre><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span>&nbsp;nodeLocalMap()</pre>
<div class="block">Gets node-local storage instance.
<p>
Node-local values are similar to thread locals in a way that these values are not
distributed and kept only on local node (similar like thread local values are attached to the
current thread only). Node-local values are used primarily by closures executed from the remote
nodes to keep intermediate state on the local node between executions.
<p>
There's only one instance of node local storage per local node. Node local storage is
based on <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent"><code>ConcurrentMap</code></a> and is safe for multi-threaded access.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Node local storage instance for the local node.</dd>
</dl>
</li>
</ul>
<a name="pingNode-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pingNode</h4>
<pre>boolean&nbsp;pingNode(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;nodeId)</pre>
<div class="block">Pings a remote node.
<p>
Discovery SPIs usually have some latency in discovering failed nodes. Hence,
communication to remote nodes may fail at times if an attempt was made to
establish communication with a failed node. This method can be used to check
if communication has failed due to node failure or due to some other reason.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeId</code> - ID of a node to ping.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if node for a given ID is alive, <code>false</code> otherwise.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/apache/ignite/spi/discovery/DiscoverySpi.html" title="interface in org.apache.ignite.spi.discovery"><code>DiscoverySpi</code></a></dd>
</dl>
</li>
</ul>
<a name="topologyVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>topologyVersion</h4>
<pre>long&nbsp;topologyVersion()</pre>
<div class="block">Gets current topology version. In case of TCP discovery
(see <a href="../../../org/apache/ignite/spi/discovery/tcp/TcpDiscoverySpi.html" title="class in org.apache.ignite.spi.discovery.tcp"><code>TcpDiscoverySpi</code></a>) topology versions
are sequential - they start from <code>'1'</code> and get incremented every time whenever a
node joins or leaves. For other discovery SPIs topology versions may not be (and likely are
not) sequential.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Current topology version.</dd>
</dl>
</li>
</ul>
<a name="topology-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>topology</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a><span class='angle_bracket'>&gt;</span>&nbsp;topology(long&nbsp;topVer)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></pre>
<div class="block">Gets a topology by version. Returns <code>null</code> if topology history storage doesn't contain
specified topology version (history currently keeps last <code>1000</code> snapshots).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>topVer</code> - Topology version.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Collection of grid nodes which represented by specified topology version,
if it is present in history storage, <code>null</code> otherwise.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - If underlying SPI implementation does not support
topology history. Currently only <a href="../../../org/apache/ignite/spi/discovery/tcp/TcpDiscoverySpi.html" title="class in org.apache.ignite.spi.discovery.tcp"><code>TcpDiscoverySpi</code></a>
supports topology history.</dd>
</dl>
</li>
</ul>
<a name="startNodes-java.io.File-boolean-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startNodes</h4>
<pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a>
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="../../../org/apache/ignite/cluster/ClusterStartNodeResult.html" title="interface in org.apache.ignite.cluster">ClusterStartNodeResult</a><span class='angle_bracket'>&gt;</span>&nbsp;startNodes(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
boolean&nbsp;restart,
int&nbsp;timeout,
int&nbsp;maxConn)
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<div class="block">Starts one or more nodes on remote host(s).
<p>
This method takes INI file which defines all startup parameters. It can contain one or
more sections, each for a host or for range of hosts (note that they must have different
names) and a special '<code>defaults</code>' section with default values. They are applied to
undefined parameters in host's sections.
<p>
Returned result is collection of tuples. Each tuple corresponds to one node start attempt and
contains hostname, success flag and error message if attempt was not successful. Note that
successful attempt doesn't mean that node was actually started and joined topology. For large
topologies (> 100s nodes) it can take over 10 minutes for all nodes to start. See individual
node logs for details.
<p>
Supports asynchronous execution (see <a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html" title="interface in org.apache.ignite.lang"><code>IgniteAsyncSupport</code></a>).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>file</code> - Configuration file.</dd>
<dd><code>restart</code> - Whether to stop existing nodes. If <code>true</code>, all existing
nodes on the host will be stopped before starting new ones. If
<code>false</code>, nodes will be started only if there are less
nodes on the host than expected.</dd>
<dd><code>timeout</code> - Connection timeout.</dd>
<dd><code>maxConn</code> - Number of parallel SSH connections to one host.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Collection of start node results, each containing host name, result (success or failure)
and error message (if any).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - In case of error.</dd>
</dl>
</li>
</ul>
<a name="startNodesAsync-java.io.File-boolean-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startNodesAsync</h4>
<pre><a href="../../../org/apache/ignite/lang/IgniteFuture.html" title="interface in org.apache.ignite.lang">IgniteFuture</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="../../../org/apache/ignite/cluster/ClusterStartNodeResult.html" title="interface in org.apache.ignite.cluster">ClusterStartNodeResult</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;startNodesAsync(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
boolean&nbsp;restart,
int&nbsp;timeout,
int&nbsp;maxConn)
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<div class="block">Starts one or more nodes on remote host(s) asynchronously.
<p>
This method takes INI file which defines all startup parameters. It can contain one or
more sections, each for a host or for range of hosts (note that they must have different
names) and a special '<code>defaults</code>' section with default values. They are applied to
undefined parameters in host's sections.
<p>
Completed future contains collection of tuples. Each tuple corresponds to one node start attempt and
contains hostname, success flag and error message if attempt was not successful. Note that
successful attempt doesn't mean that node was actually started and joined topology. For large
topologies (> 100s nodes) it can take over 10 minutes for all nodes to start. See individual
node logs for details.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>file</code> - Configuration file.</dd>
<dd><code>restart</code> - Whether to stop existing nodes. If <code>true</code>, all existing
nodes on the host will be stopped before starting new ones. If
<code>false</code>, nodes will be started only if there are less
nodes on the host than expected.</dd>
<dd><code>timeout</code> - Connection timeout.</dd>
<dd><code>maxConn</code> - Number of parallel SSH connections to one host.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Future representing pending completion of the starting nodes.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - In case of error.</dd>
</dl>
</li>
</ul>
<a name="startNodes-java.util.Collection-java.util.Map-boolean-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startNodes</h4>
<pre><a href="../../../org/apache/ignite/lang/IgniteAsyncSupported.html" title="annotation in org.apache.ignite.lang">@IgniteAsyncSupported</a>
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="../../../org/apache/ignite/cluster/ClusterStartNodeResult.html" title="interface in org.apache.ignite.cluster">ClusterStartNodeResult</a><span class='angle_bracket'>&gt;</span>&nbsp;startNodes(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'>&lt;</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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;hosts,
@Nullable
@Nullable <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'>&lt;</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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a><span class='angle_bracket'>&gt;</span>&nbsp;dflts,
boolean&nbsp;restart,
int&nbsp;timeout,
int&nbsp;maxConn)
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<div class="block">Starts one or more nodes on remote host(s).
<p>
Each map in <code>hosts</code> collection
defines startup parameters for one host or for a range of hosts. The following
parameters are supported:
<table class="doctable">
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><b>host</b></td>
<td>String</td>
<td>
Hostname (required). Can define several hosts if their IPs are sequential.
E.g., <code>10.0.0.1~5</code> defines range of five IP addresses. Other
parameters are applied to all hosts equally.
</td>
</tr>
<tr>
<td><b>port</b></td>
<td>Integer</td>
<td>Port number (default is <code>22</code>).</td>
</tr>
<tr>
<td><b>uname</b></td>
<td>String</td>
<td>Username (if not defined, current local username will be used).</td>
</tr>
<tr>
<td><b>passwd</b></td>
<td>String</td>
<td>Password (if not defined, private key file must be defined).</td>
</tr>
<tr>
<td><b>key</b></td>
<td>File</td>
<td>Private key file (if not defined, password must be defined).</td>
</tr>
<tr>
<td><b>nodes</b></td>
<td>Integer</td>
<td>
Expected number of nodes on the host. If some nodes are started
already, then only remaining nodes will be started. If current count of
nodes is equal to this number, and <code>restart</code> flag is <code>false</code>,
then nothing will happen.
</td>
</tr>
<tr>
<td><b>igniteHome</b></td>
<td>String</td>
<td>
Path to Ignite installation folder. If not defined, IGNITE_HOME
environment variable must be set on remote hosts.
</td>
</tr>
<tr>
<td><b>cfg</b></td>
<td>String</td>
<td>Path to configuration file (relative to <code>igniteHome</code>).</td>
</tr>
<tr>
<td><b>script</b></td>
<td>String</td>
<td>
Custom startup script file name and path (relative to <code>igniteHome</code>).
You can also specify a space-separated list of parameters in the same
string (for example: <code>"bin/my-custom-script.sh -v"</code>).
</td>
</tr>
</table>
<p>
<code>dflts</code> map defines default values. They are applied to undefined parameters in
<code>hosts</code> collection.
<p>
Returned result is collection of tuples. Each tuple corresponds to one node start attempt and
contains hostname, success flag and error message if attempt was not successful. Note that
successful attempt doesn't mean that node was actually started and joined topology. For large
topologies (> 100s nodes) it can take over 10 minutes for all nodes to start. See individual
node logs for details.
<p>
Supports asynchronous execution (see <a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html" title="interface in org.apache.ignite.lang"><code>IgniteAsyncSupport</code></a>).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hosts</code> - Startup parameters.</dd>
<dd><code>dflts</code> - Default values.</dd>
<dd><code>restart</code> - Whether to stop existing nodes. If <code>true</code>, all existing
nodes on the host will be stopped before starting new ones. If
<code>false</code>, nodes will be started only if there are less
nodes on the host than expected.</dd>
<dd><code>timeout</code> - Connection timeout in milliseconds.</dd>
<dd><code>maxConn</code> - Number of parallel SSH connections to one host.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Collection of start node results, each containing host name, result (success or failure)
and error message (if any).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - In case of error.</dd>
</dl>
</li>
</ul>
<a name="startNodesAsync-java.util.Collection-java.util.Map-boolean-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startNodesAsync</h4>
<pre><a href="../../../org/apache/ignite/lang/IgniteFuture.html" title="interface in org.apache.ignite.lang">IgniteFuture</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="../../../org/apache/ignite/cluster/ClusterStartNodeResult.html" title="interface in org.apache.ignite.cluster">ClusterStartNodeResult</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;startNodesAsync(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'>&lt;</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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;hosts,
@Nullable
@Nullable <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'>&lt;</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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a><span class='angle_bracket'>&gt;</span>&nbsp;dflts,
boolean&nbsp;restart,
int&nbsp;timeout,
int&nbsp;maxConn)
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<div class="block">Starts one or more nodes on remote host(s) asynchronously.
<p>
Each map in <code>hosts</code> collection
defines startup parameters for one host or for a range of hosts. The following
parameters are supported:
<table class="doctable">
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td><b>host</b></td>
<td>String</td>
<td>
Hostname (required). Can define several hosts if their IPs are sequential.
E.g., <code>10.0.0.1~5</code> defines range of five IP addresses. Other
parameters are applied to all hosts equally.
</td>
</tr>
<tr>
<td><b>port</b></td>
<td>Integer</td>
<td>Port number (default is <code>22</code>).</td>
</tr>
<tr>
<td><b>uname</b></td>
<td>String</td>
<td>Username (if not defined, current local username will be used).</td>
</tr>
<tr>
<td><b>passwd</b></td>
<td>String</td>
<td>Password (if not defined, private key file must be defined).</td>
</tr>
<tr>
<td><b>key</b></td>
<td>File</td>
<td>Private key file (if not defined, password must be defined).</td>
</tr>
<tr>
<td><b>nodes</b></td>
<td>Integer</td>
<td>
Expected number of nodes on the host. If some nodes are started
already, then only remaining nodes will be started. If current count of
nodes is equal to this number, and <code>restart</code> flag is <code>false</code>,
then nothing will happen.
</td>
</tr>
<tr>
<td><b>igniteHome</b></td>
<td>String</td>
<td>
Path to Ignite installation folder. If not defined, IGNITE_HOME
environment variable must be set on remote hosts.
</td>
</tr>
<tr>
<td><b>cfg</b></td>
<td>String</td>
<td>Path to configuration file (relative to <code>igniteHome</code>).</td>
</tr>
<tr>
<td><b>script</b></td>
<td>String</td>
<td>
Custom startup script file name and path (relative to <code>igniteHome</code>).
You can also specify a space-separated list of parameters in the same
string (for example: <code>"bin/my-custom-script.sh -v"</code>).
</td>
</tr>
</table>
<p>
<code>dflts</code> map defines default values. They are applied to undefined parameters in
<code>hosts</code> collection.
<p>
Completed future contains collection of tuples. Each tuple corresponds to one node start attempt and
contains hostname, success flag and error message if attempt was not successful. Note that
successful attempt doesn't mean that node was actually started and joined topology. For large
topologies (> 100s nodes) it can take over 10 minutes for all nodes to start. See individual
node logs for details.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hosts</code> - Startup parameters.</dd>
<dd><code>dflts</code> - Default values.</dd>
<dd><code>restart</code> - Whether to stop existing nodes. If <code>true</code>, all existing
nodes on the host will be stopped before starting new ones. If
<code>false</code>, nodes will be started only if there are less
nodes on the host than expected.</dd>
<dd><code>timeout</code> - Connection timeout in milliseconds.</dd>
<dd><code>maxConn</code> - Number of parallel SSH connections to one host.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Future representing pending completion of the starting nodes.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - In case of error.</dd>
</dl>
</li>
</ul>
<a name="stopNodes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopNodes</h4>
<pre>void&nbsp;stopNodes()
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<div class="block">Stops nodes satisfying optional set of predicates.
<p>
<b>NOTE:</b> <code>System.exit(Ignition.KILL_EXIT_CODE)</code> will be executed on each
stopping node. If you have other applications running in the same JVM along with Ignition,
those applications will be stopped as well.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - In case of error.</dd>
</dl>
</li>
</ul>
<a name="stopNodes-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopNodes</h4>
<pre>void&nbsp;stopNodes(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a><span class='angle_bracket'>&gt;</span>&nbsp;ids)
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<div class="block">Stops nodes defined by provided IDs.
<p>
<b>NOTE:</b> <code>System.exit(Ignition.KILL_EXIT_CODE)</code> will be executed on each
stopping node. If you have other applications running in the same JVM along with Ignition,
those applications will be stopped as well.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ids</code> - IDs defining nodes to stop.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - In case of error.</dd>
</dl>
</li>
</ul>
<a name="restartNodes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>restartNodes</h4>
<pre>void&nbsp;restartNodes()
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<div class="block">Restarts nodes satisfying optional set of predicates.
<p>
<b>NOTE:</b> this command only works for grid nodes started with Ignition
<code>ignite.sh</code> or <code>ignite.bat</code> scripts.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - In case of error.</dd>
</dl>
</li>
</ul>
<a name="restartNodes-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>restartNodes</h4>
<pre>void&nbsp;restartNodes(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a><span class='angle_bracket'>&gt;</span>&nbsp;ids)
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<div class="block">Restarts nodes defined by provided IDs.
<p>
<b>NOTE:</b> this command only works for grid nodes started with Ignition
<code>ignite.sh</code> or <code>ignite.bat</code> scripts.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ids</code> - IDs defining nodes to restart.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - In case of error.</dd>
</dl>
</li>
</ul>
<a name="resetMetrics--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetMetrics</h4>
<pre>void&nbsp;resetMetrics()</pre>
<div class="block">Resets local I/O, job, and task execution metrics.</div>
</li>
</ul>
<a name="enableStatistics-java.util.Collection-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableStatistics</h4>
<pre>void&nbsp;enableStatistics(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</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><span class='angle_bracket'>&gt;</span>&nbsp;caches,
boolean&nbsp;enabled)</pre>
<div class="block">Enables/disables statistics for caches cluster wide.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>caches</code> - Collection of cache names.</dd>
<dd><code>enabled</code> - Statistics enabled flag.</dd>
</dl>
</li>
</ul>
<a name="clearStatistics-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearStatistics</h4>
<pre>void&nbsp;clearStatistics(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</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><span class='angle_bracket'>&gt;</span>&nbsp;caches)</pre>
<div class="block">Clear statistics for caches cluster wide.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>caches</code> - Collection of cache names.</dd>
</dl>
</li>
</ul>
<a name="setTxTimeoutOnPartitionMapExchange-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTxTimeoutOnPartitionMapExchange</h4>
<pre>void&nbsp;setTxTimeoutOnPartitionMapExchange(long&nbsp;timeout)</pre>
<div class="block">Sets transaction timeout on partition map exchange.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - Transaction timeout on partition map exchange in milliseconds.</dd>
</dl>
</li>
</ul>
<a name="clientReconnectFuture--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clientReconnectFuture</h4>
<pre>@Nullable
@Nullable <a href="../../../org/apache/ignite/lang/IgniteFuture.html" title="interface in org.apache.ignite.lang">IgniteFuture</a><span class='angle_bracket'>&lt;</span>?<span class='angle_bracket'>&gt;</span>&nbsp;clientReconnectFuture()</pre>
<div class="block">If local client node disconnected from cluster returns future
that will be completed when client reconnected.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Future that will be completed when client reconnected.</dd>
</dl>
</li>
</ul>
<a name="active--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>active</h4>
<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>
boolean&nbsp;active()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../org/apache/ignite/IgniteCluster.html#state--"><code>state()</code></a> instead.</span></div>
<div class="block">Checks Ignite grid is active or not active.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> if grid is active. <code>False</code> If grid is not active.</dd>
</dl>
</li>
</ul>
<a name="active-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>active</h4>
<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>
void&nbsp;active(boolean&nbsp;active)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../org/apache/ignite/IgniteCluster.html#state-org.apache.ignite.cluster.ClusterState-"><code>state(ClusterState)</code></a> instead.</span></div>
<div class="block">Changes Ignite grid state to active or inactive.
<p>
<b>NOTE:</b>
Deactivation clears in-memory caches (without persistence) including the system caches.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>active</code> - If <code>True</code> start activation process. If <code>False</code> start deactivation process.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If there is an already started transaction or lock in the same thread.</dd>
</dl>
</li>
</ul>
<a name="state--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>state</h4>
<pre><a href="../../../org/apache/ignite/cluster/ClusterState.html" title="enum in org.apache.ignite.cluster">ClusterState</a>&nbsp;state()</pre>
<div class="block">Gets current cluster state.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Current cluster state.</dd>
</dl>
</li>
</ul>
<a name="state-org.apache.ignite.cluster.ClusterState-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>state</h4>
<pre>void&nbsp;state(<a href="../../../org/apache/ignite/cluster/ClusterState.html" title="enum in org.apache.ignite.cluster">ClusterState</a>&nbsp;newState)
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<div class="block">Changes current cluster state to given <code>newState</code> cluster state.
<p>
<b>NOTE:</b>
Deactivation clears in-memory caches (without persistence) including the system caches.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newState</code> - New cluster state.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If there is an already started transaction or lock in the same thread.</dd>
</dl>
</li>
</ul>
<a name="currentBaselineTopology--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>currentBaselineTopology</h4>
<pre>@Nullable
@Nullable <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span><a href="../../../org/apache/ignite/cluster/BaselineNode.html" title="interface in org.apache.ignite.cluster">BaselineNode</a><span class='angle_bracket'>&gt;</span>&nbsp;currentBaselineTopology()</pre>
<div class="block">Gets current baseline topology. If baseline topology was not set, will return <code>null</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Collection of nodes included to the current baseline topology.</dd>
</dl>
</li>
</ul>
<a name="setBaselineTopology-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBaselineTopology</h4>
<pre>void&nbsp;setBaselineTopology(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'>&lt;</span>? extends <a href="../../../org/apache/ignite/cluster/BaselineNode.html" title="interface in org.apache.ignite.cluster">BaselineNode</a><span class='angle_bracket'>&gt;</span>&nbsp;baselineTop)</pre>
<div class="block">Sets baseline topology. The cluster must be activated for this method to be called.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>baselineTop</code> - A collection of nodes to be included to the baseline topology.</dd>
</dl>
</li>
</ul>
<a name="setBaselineTopology-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBaselineTopology</h4>
<pre>void&nbsp;setBaselineTopology(long&nbsp;topVer)</pre>
<div class="block">Sets baseline topology constructed from the cluster topology of the given version (the method succeeds
only if the cluster topology has not changed). All client and daemon nodes will be filtered out of the
resulting baseline.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>topVer</code> - Topology version to set.</dd>
</dl>
</li>
</ul>
<a name="withAsync--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withAsync</h4>
<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>
<a href="../../../org/apache/ignite/IgniteCluster.html" title="interface in org.apache.ignite">IgniteCluster</a>&nbsp;withAsync()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Gets instance of this component with asynchronous mode enabled.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html#withAsync--">withAsync</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/ignite/lang/IgniteAsyncSupport.html" title="interface in org.apache.ignite.lang">IgniteAsyncSupport</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Instance of this component with asynchronous mode enabled.</dd>
</dl>
</li>
</ul>
<a name="disableWal-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableWal</h4>
<pre>boolean&nbsp;disableWal(<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;cacheName)
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<div class="block">Disables write-ahead logging for specified cache. When WAL is disabled, changes are not logged to disk.
This significantly improves cache update speed. The drawback is absence of local crash-recovery guarantees.
If node is crashed, local content of WAL-disabled cache will be cleared on restart to avoid data corruption.
<p>
Internally this method will wait for all current cache operations to finish and prevent new cache operations
from being executed. Then checkpoint is initiated to flush all data to disk. Control is returned to the callee
when all dirty pages are prepared for checkpoint, but not necessarily flushed to disk.
<p>
WAL state can be changed only for persistent caches.
<p>
<b>NOTE:</b>
Currently, this method should only be called on a stable topology when no nodes are leaving or joining cluster,
and all baseline nodes are present.
Cache may be stuck in inconsistent state due to violation of these conditions. It is advised to destroy
such cache.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cacheName</code> - Cache name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether WAL disabled by this call.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If error occurs.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/apache/ignite/IgniteCluster.html#enableWal-java.lang.String-"><code>enableWal(String)</code></a>,
<a href="../../../org/apache/ignite/IgniteCluster.html#isWalEnabled-java.lang.String-"><code>isWalEnabled(String)</code></a></dd>
</dl>
</li>
</ul>
<a name="enableWal-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableWal</h4>
<pre>boolean&nbsp;enableWal(<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;cacheName)
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<div class="block">Enables write-ahead logging for specified cache. Restoring crash-recovery guarantees of a previous call to
<a href="../../../org/apache/ignite/IgniteCluster.html#disableWal-java.lang.String-"><code>disableWal(String)</code></a>.
<p>
Internally this method will wait for all current cache operations to finish and prevent new cache operations
from being executed. Then checkpoint is initiated to flush all data to disk. Control is returned to the callee
when all data is persisted to disk.
<p>
WAL state can be changed only for persistent caches.
<p>
<b>NOTE:</b>
Currently, this method should only be called on a stable topology when no nodes are leaving or joining cluster,
and all baseline nodes are present.
Cache may be stuck in inconsistent state due to violation of these conditions. It is advised to destroy
such cache.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cacheName</code> - Cache name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether WAL enabled by this call.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If error occurs.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/apache/ignite/IgniteCluster.html#disableWal-java.lang.String-"><code>disableWal(String)</code></a>,
<a href="../../../org/apache/ignite/IgniteCluster.html#isWalEnabled-java.lang.String-"><code>isWalEnabled(String)</code></a></dd>
</dl>
</li>
</ul>
<a name="isWalEnabled-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWalEnabled</h4>
<pre>boolean&nbsp;isWalEnabled(<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;cacheName)</pre>
<div class="block">Checks if write-ahead logging is enabled for specified cache.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cacheName</code> - Cache name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> if WAL is enabled for cache.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/apache/ignite/IgniteCluster.html#disableWal-java.lang.String-"><code>disableWal(String)</code></a>,
<a href="../../../org/apache/ignite/IgniteCluster.html#enableWal-java.lang.String-"><code>enableWal(String)</code></a></dd>
</dl>
</li>
</ul>
<a name="id--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>id</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;id()</pre>
<div class="block">Cluster ID is a unique identifier automatically generated when cluster starts up for the very first time.
It is a cluster-wide property so all nodes of the cluster (including client nodes) return the same value.
In in-memory clusters ID is generated again upon each cluster restart.
In clusters running in persistent mode cluster ID is stored to disk and is used even after full cluster restart.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Unique cluster ID.</dd>
</dl>
</li>
</ul>
<a name="tag--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tag</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;tag()</pre>
<div class="block">User-defined tag describing the cluster.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Current tag value same across all nodes of the cluster.</dd>
</dl>
</li>
</ul>
<a name="tag-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tag</h4>
<pre>void&nbsp;tag(<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;tag)
throws <a href="../../../org/apache/ignite/IgniteCheckedException.html" title="class in org.apache.ignite">IgniteCheckedException</a></pre>
<div class="block">Enables user to add a specific label to the cluster e.g. to describe purpose of the cluster
or any its characteristics.
Tag is set cluster-wide,
value set on one node will be distributed across all nodes (including client nodes) in the cluster.
Maximum tag length is limited by <a href="../../../org/apache/ignite/IgniteCluster.html#MAX_TAG_LENGTH"><code>MAX_TAG_LENGTH</code></a> value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tag</code> - New tag to be set.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteCheckedException.html" title="class in org.apache.ignite">IgniteCheckedException</a></code> - In case tag change is requested on inactive cluster
or concurrent tag change request was completed before the current one.
Also provided tag is checked for max length.</dd>
</dl>
</li>
</ul>
<a name="isBaselineAutoAdjustEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBaselineAutoAdjustEnabled</h4>
<pre>boolean&nbsp;isBaselineAutoAdjustEnabled()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Value of manual baseline control or auto adjusting baseline. <code>True</code> If cluster in auto-adjust.
<code>False</code> If cluster in manual.</dd>
</dl>
</li>
</ul>
<a name="baselineAutoAdjustEnabled-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>baselineAutoAdjustEnabled</h4>
<pre>void&nbsp;baselineAutoAdjustEnabled(boolean&nbsp;baselineAutoAdjustEnabled)
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>baselineAutoAdjustEnabled</code> - Value of manual baseline control or auto adjusting baseline. <code>True</code> If
cluster in auto-adjust. <code>False</code> If cluster in manuale.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If operation failed.</dd>
</dl>
</li>
</ul>
<a name="baselineAutoAdjustTimeout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>baselineAutoAdjustTimeout</h4>
<pre>long&nbsp;baselineAutoAdjustTimeout()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Value of time which we would wait before the actual topology change since last server topology change
(node join/left/fail).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If operation failed.</dd>
</dl>
</li>
</ul>
<a name="baselineAutoAdjustTimeout-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>baselineAutoAdjustTimeout</h4>
<pre>void&nbsp;baselineAutoAdjustTimeout(long&nbsp;baselineAutoAdjustTimeout)
throws <a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>baselineAutoAdjustTimeout</code> - Value of time which we would wait before the actual topology change since last
server topology change (node join/left/fail).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If failed.</dd>
</dl>
</li>
</ul>
<a name="baselineAutoAdjustStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>baselineAutoAdjustStatus</h4>
<pre>org.apache.ignite.internal.processors.cluster.baseline.autoadjust.BaselineAutoAdjustStatus&nbsp;baselineAutoAdjustStatus()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Status of baseline auto-adjust.</dd>
</dl>
</li>
</ul>
<a name="shutdownPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdownPolicy</h4>
<pre><a href="../../../org/apache/ignite/ShutdownPolicy.html" title="enum in org.apache.ignite">ShutdownPolicy</a>&nbsp;shutdownPolicy()</pre>
<div class="block">Returns a policy of shutdown or default value <code>IgniteConfiguration.DFLT_SHUTDOWN_POLICY</code>
if the property is not set.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Shutdown policy.</dd>
</dl>
</li>
</ul>
<a name="shutdownPolicy-org.apache.ignite.ShutdownPolicy-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>shutdownPolicy</h4>
<pre>void&nbsp;shutdownPolicy(<a href="../../../org/apache/ignite/ShutdownPolicy.html" title="enum in org.apache.ignite">ShutdownPolicy</a>&nbsp;shutdownPolicy)</pre>
<div class="block">Sets a shutdown policy on a cluster.
If a policy is specified here the value will override static configuration on
<a href="../../../org/apache/ignite/configuration/IgniteConfiguration.html#setShutdownPolicy-org.apache.ignite.ShutdownPolicy-"><code>IgniteConfiguration.setShutdownPolicy(ShutdownPolicy)</code></a> and persists to cluster meta storage.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>shutdownPolicy</code> - Shutdown policy.</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="class-use/IgniteCluster.html">Use</a></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/ignite/IgniteClientDisconnectedException.html" title="class in org.apache.ignite"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/ignite/IgniteCompute.html" title="interface in org.apache.ignite"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/ignite/IgniteCluster.html" target="_top">Frames</a></li>
<li><a href="IgniteCluster.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2021 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Database and Caching Platform</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.10.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; March 10 2021 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>