| <!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_261) on Mon Dec 20 14:15:52 MSK 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ClientCluster (Ignite 2.11.1)</title> |
| <meta name="date" content="2021-12-20"> |
| <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'/> |
| </head> |
| |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ClientCluster (Ignite 2.11.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ClientCluster.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/client/ClientCacheConfiguration.html" title="class in org.apache.ignite.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/client/ClientClusterGroup.html" title="interface in org.apache.ignite.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/client/ClientCluster.html" target="_top">Frames</a></li> |
| <li><a href="ClientCluster.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">org.apache.ignite.client</div> |
| <h2 title="Interface ClientCluster" class="title">Interface ClientCluster</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/client/ClientClusterGroup.html" title="interface in org.apache.ignite.client">ClientClusterGroup</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ClientCluster</span> |
| extends <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html" title="interface in org.apache.ignite.client">ClientClusterGroup</a></pre> |
| <div class="block">Thin client cluster facade. Represents whole cluster (all available nodes).</div> |
| </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></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/client/ClientCluster.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> cacheName)</code> |
| <div class="block">Disables write-ahead logging for specified cache.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCluster.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> cacheName)</code> |
| <div class="block">Enables write-ahead logging for specified cache.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCluster.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> cacheName)</code> |
| <div class="block">Checks if write-ahead logging is enabled for specified cache.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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/client/ClientCluster.html#state--">state</a></span>()</code> |
| <div class="block">Gets current cluster state.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientCluster.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> newState)</code> |
| <div class="block">Changes current cluster state to given <code>newState</code> cluster state.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.client.ClientClusterGroup"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.ignite.client.<a href="../../../../org/apache/ignite/client/ClientClusterGroup.html" title="interface in org.apache.ignite.client">ClientClusterGroup</a></h3> |
| <code><a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forAttribute-java.lang.String-java.lang.Object-">forAttribute</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forClients--">forClients</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forHost-org.apache.ignite.cluster.ClusterNode-">forHost</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forHost-java.lang.String-java.lang.String...-">forHost</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forNode-org.apache.ignite.cluster.ClusterNode-org.apache.ignite.cluster.ClusterNode...-">forNode</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forNodeId-java.util.UUID-java.util.UUID...-">forNodeId</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forNodeIds-java.util.Collection-">forNodeIds</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forNodes-java.util.Collection-">forNodes</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forOldest--">forOldest</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forOthers-org.apache.ignite.client.ClientClusterGroup-">forOthers</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forOthers-org.apache.ignite.cluster.ClusterNode-org.apache.ignite.cluster.ClusterNode...-">forOthers</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forPredicate-java.util.function.Predicate-">forPredicate</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forRandom--">forRandom</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forServers--">forServers</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#forYoungest--">forYoungest</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#node--">node</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#node-java.util.UUID-">node</a>, <a href="../../../../org/apache/ignite/client/ClientClusterGroup.html#nodes--">nodes</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="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> 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 state(<a href="../../../../org/apache/ignite/cluster/ClusterState.html" title="enum in org.apache.ignite.cluster">ClusterState</a> newState) |
| throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</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/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code> - If change state operation failed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="disableWal-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disableWal</h4> |
| <pre>boolean 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> cacheName) |
| throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</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.</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/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code> - If error occurs.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/ignite/client/ClientCluster.html#enableWal-java.lang.String-"><code>enableWal(String)</code></a>, |
| <a href="../../../../org/apache/ignite/client/ClientCluster.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 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> cacheName) |
| throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</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/client/ClientCluster.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.</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/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code> - If error occurs.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/ignite/client/ClientCluster.html#disableWal-java.lang.String-"><code>disableWal(String)</code></a>, |
| <a href="../../../../org/apache/ignite/client/ClientCluster.html#isWalEnabled-java.lang.String-"><code>isWalEnabled(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isWalEnabled-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isWalEnabled</h4> |
| <pre>boolean 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> 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/client/ClientCluster.html#disableWal-java.lang.String-"><code>disableWal(String)</code></a>, |
| <a href="../../../../org/apache/ignite/client/ClientCluster.html#enableWal-java.lang.String-"><code>enableWal(String)</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="class-use/ClientCluster.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/client/ClientCacheConfiguration.html" title="class in org.apache.ignite.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/client/ClientClusterGroup.html" title="interface in org.apache.ignite.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/client/ClientCluster.html" target="_top">Frames</a></li> |
| <li><a href="ClientCluster.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 ======= --> |
| <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 © 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>: ver. <strong>2.11.1</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>: December 20 2021 </td> </tr> </tbody> </table> </td> </tr> </table></small></p> |
| </body> |
| </html> |
