| <!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>PluginProvider (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="PluginProvider (Ignite 2.11.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":38,"i13":18,"i14":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/PluginProvider.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/plugin/PluginNotFoundException.html" title="class in org.apache.ignite.plugin"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/plugin/PluginValidationException.html" title="class in org.apache.ignite.plugin"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/plugin/PluginProvider.html" target="_top">Frames</a></li> |
| <li><a href="PluginProvider.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.plugin</div> |
| <h2 title="Interface PluginProvider" class="title">Interface PluginProvider<span class='angle_bracket'><</span>C extends <a href="../../../../org/apache/ignite/plugin/PluginConfiguration.html" title="interface in org.apache.ignite.plugin">PluginConfiguration</a><span class='angle_bracket'>></span></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/ignite/ml/util/plugin/MLPluginProvider.html" title="class in org.apache.ignite.ml.util.plugin">MLPluginProvider</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">PluginProvider<span class='angle_bracket'><</span>C extends <a href="../../../../org/apache/ignite/plugin/PluginConfiguration.html" title="interface in org.apache.ignite.plugin">PluginConfiguration</a><span class='angle_bracket'>></span></span></pre> |
| <div class="block">Pluggable Ignite component. |
| <p> |
| Ignite plugins can be loaded using JDK <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html?is-external=true" title="class or interface in java.util"><code>ServiceLoader</code></a> or set up explicitly via |
| <a href="../../../../org/apache/ignite/configuration/IgniteConfiguration.html#setPluginProviders-org.apache.ignite.plugin.PluginProvider...-"><code>IgniteConfiguration.setPluginProviders(PluginProvider[])</code></a>. |
| First method called to initialize plugin is <a href="../../../../org/apache/ignite/plugin/PluginProvider.html#initExtensions-org.apache.ignite.plugin.PluginContext-org.apache.ignite.plugin.ExtensionRegistry-"><code>initExtensions(PluginContext, ExtensionRegistry)</code></a>. |
| If <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html?is-external=true" title="class or interface in java.util"><code>ServiceLoader</code></a> approach of plugin loading is chosen, fully-qualified <a href="../../../../org/apache/ignite/plugin/PluginProvider.html" title="interface in org.apache.ignite.plugin"><code>PluginProvider</code></a> class name is |
| used as the service type. And required plugin configuration in this case can be set up via |
| <a href="../../../../org/apache/ignite/configuration/IgniteConfiguration.html#setPluginConfigurations-org.apache.ignite.plugin.PluginConfiguration...-"><code>IgniteConfiguration.setPluginConfigurations(PluginConfiguration...)</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/ignite/configuration/IgniteConfiguration.html#setPluginProviders-org.apache.ignite.plugin.PluginProvider...-"><code>IgniteConfiguration.setPluginProviders(PluginProvider[])</code></a>, |
| <a href="../../../../org/apache/ignite/configuration/IgniteConfiguration.html#setPluginConfigurations-org.apache.ignite.plugin.PluginConfiguration...-"><code>IgniteConfiguration.setPluginConfigurations(PluginConfiguration...)</code></a>, |
| <a href="../../../../org/apache/ignite/plugin/PluginContext.html" title="interface in org.apache.ignite.plugin"><code>PluginContext</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="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/plugin/PluginProvider.html#copyright--">copyright</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/plugin/CachePluginProvider.html" title="interface in org.apache.ignite.plugin">CachePluginProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/plugin/PluginProvider.html#createCacheProvider-org.apache.ignite.plugin.CachePluginContext-">createCacheProvider</a></span>(<a href="../../../../org/apache/ignite/plugin/CachePluginContext.html" title="interface in org.apache.ignite.plugin">CachePluginContext</a> ctx)</code> |
| <div class="block">Creates cache plugin provider.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><span class='angle_bracket'><</span>T<span class='angle_bracket'>></span> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/plugin/PluginProvider.html#createComponent-org.apache.ignite.plugin.PluginContext-java.lang.Class-">createComponent</a></span>(<a href="../../../../org/apache/ignite/plugin/PluginContext.html" title="interface in org.apache.ignite.plugin">PluginContext</a> ctx, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><span class='angle_bracket'><</span>T<span class='angle_bracket'>></span> cls)</code> |
| <div class="block">Creates Ignite component.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/plugin/PluginProvider.html#initExtensions-org.apache.ignite.plugin.PluginContext-org.apache.ignite.plugin.ExtensionRegistry-">initExtensions</a></span>(<a href="../../../../org/apache/ignite/plugin/PluginContext.html" title="interface in org.apache.ignite.plugin">PluginContext</a> ctx, |
| <a href="../../../../org/apache/ignite/plugin/ExtensionRegistry.html" title="interface in org.apache.ignite.plugin">ExtensionRegistry</a> registry)</code> |
| <div class="block">Registers extensions.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/plugin/PluginProvider.html#name--">name</a></span>()</code> </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/plugin/PluginProvider.html#onIgniteStart--">onIgniteStart</a></span>()</code> |
| <div class="block">Callback that notifies that Ignite has successfully started, |
| including all internal components.</div> |
| </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/plugin/PluginProvider.html#onIgniteStop-boolean-">onIgniteStop</a></span>(boolean cancel)</code> |
| <div class="block">Callback to notify that Ignite is about to stop.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><span class='angle_bracket'><</span>T extends <a href="../../../../org/apache/ignite/plugin/IgnitePlugin.html" title="interface in org.apache.ignite.plugin">IgnitePlugin</a><span class='angle_bracket'>></span><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/plugin/PluginProvider.html#plugin--">plugin</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>@Nullable <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/plugin/PluginProvider.html#provideDiscoveryData-java.util.UUID-">provideDiscoveryData</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> nodeId)</code> |
| <div class="block">Gets plugin discovery data object that will be sent to the new node |
| during discovery process.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/plugin/PluginProvider.html#receiveDiscoveryData-java.util.UUID-java.io.Serializable-">receiveDiscoveryData</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> nodeId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a> data)</code> |
| <div class="block">Receives plugin discovery data object from remote nodes (called |
| on new node during discovery process).</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/plugin/PluginProvider.html#start-org.apache.ignite.plugin.PluginContext-">start</a></span>(<a href="../../../../org/apache/ignite/plugin/PluginContext.html" title="interface in org.apache.ignite.plugin">PluginContext</a> ctx)</code> |
| <div class="block">Starts grid component.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/plugin/PluginProvider.html#stop-boolean-">stop</a></span>(boolean cancel)</code> |
| <div class="block">Stops grid component.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/plugin/PluginProvider.html#validateNewNode-org.apache.ignite.cluster.ClusterNode-">validateNewNode</a></span>(<a href="../../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a> node)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/ignite/plugin/PluginProvider.html#validateNewNode-org.apache.ignite.cluster.ClusterNode-java.io.Serializable-"><code>validateNewNode(ClusterNode, Serializable)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/plugin/PluginProvider.html#validateNewNode-org.apache.ignite.cluster.ClusterNode-java.io.Serializable-">validateNewNode</a></span>(<a href="../../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a> node, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a> data)</code> |
| <div class="block">Validates that new node can join grid topology, this method is called on coordinator |
| node before new node joins topology.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/plugin/PluginProvider.html#version--">version</a></span>()</code> </td> |
| </tr> |
| </table> |
| </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="name--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</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> name()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Plugin name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="version--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>version</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> version()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Plugin version.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyright--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyright</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> copyright()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Copyright.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="plugin--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>plugin</h4> |
| <pre><span class='angle_bracket'><</span>T extends <a href="../../../../org/apache/ignite/plugin/IgnitePlugin.html" title="interface in org.apache.ignite.plugin">IgnitePlugin</a><span class='angle_bracket'>></span> T plugin()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Plugin API.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initExtensions-org.apache.ignite.plugin.PluginContext-org.apache.ignite.plugin.ExtensionRegistry-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initExtensions</h4> |
| <pre>void initExtensions(<a href="../../../../org/apache/ignite/plugin/PluginContext.html" title="interface in org.apache.ignite.plugin">PluginContext</a> ctx, |
| <a href="../../../../org/apache/ignite/plugin/ExtensionRegistry.html" title="interface in org.apache.ignite.plugin">ExtensionRegistry</a> registry) |
| throws <a href="../../../../org/apache/ignite/IgniteCheckedException.html" title="class in org.apache.ignite">IgniteCheckedException</a></pre> |
| <div class="block">Registers extensions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - Plugin context.</dd> |
| <dd><code>registry</code> - Extension registry.</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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createComponent-org.apache.ignite.plugin.PluginContext-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createComponent</h4> |
| <pre>@Nullable |
| <span class='angle_bracket'><</span>T<span class='angle_bracket'>></span> T createComponent(<a href="../../../../org/apache/ignite/plugin/PluginContext.html" title="interface in org.apache.ignite.plugin">PluginContext</a> ctx, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><span class='angle_bracket'><</span>T<span class='angle_bracket'>></span> cls)</pre> |
| <div class="block">Creates Ignite component.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - Plugin context.</dd> |
| <dd><code>cls</code> - Ignite component class.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Ignite component or <code>null</code> if component is not supported.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createCacheProvider-org.apache.ignite.plugin.CachePluginContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createCacheProvider</h4> |
| <pre><a href="../../../../org/apache/ignite/plugin/CachePluginProvider.html" title="interface in org.apache.ignite.plugin">CachePluginProvider</a> createCacheProvider(<a href="../../../../org/apache/ignite/plugin/CachePluginContext.html" title="interface in org.apache.ignite.plugin">CachePluginContext</a> ctx)</pre> |
| <div class="block">Creates cache plugin provider.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - Plugin context.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Cache plugin provider class.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start-org.apache.ignite.plugin.PluginContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>void start(<a href="../../../../org/apache/ignite/plugin/PluginContext.html" title="interface in org.apache.ignite.plugin">PluginContext</a> ctx) |
| throws <a href="../../../../org/apache/ignite/IgniteCheckedException.html" title="class in org.apache.ignite">IgniteCheckedException</a></pre> |
| <div class="block">Starts grid component.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - Plugin context.</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> - Throws in case of any errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stop-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>void stop(boolean cancel) |
| throws <a href="../../../../org/apache/ignite/IgniteCheckedException.html" title="class in org.apache.ignite">IgniteCheckedException</a></pre> |
| <div class="block">Stops grid component.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cancel</code> - If <code>true</code>, then all ongoing tasks or jobs for relevant |
| components need to be cancelled.</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> - Thrown in case of any errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onIgniteStart--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onIgniteStart</h4> |
| <pre>void onIgniteStart() |
| throws <a href="../../../../org/apache/ignite/IgniteCheckedException.html" title="class in org.apache.ignite">IgniteCheckedException</a></pre> |
| <div class="block">Callback that notifies that Ignite has successfully started, |
| including all internal components.</div> |
| <dl> |
| <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> - Thrown in case of any errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onIgniteStop-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onIgniteStop</h4> |
| <pre>void onIgniteStop(boolean cancel)</pre> |
| <div class="block">Callback to notify that Ignite is about to stop.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cancel</code> - Flag indicating whether jobs should be canceled.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="provideDiscoveryData-java.util.UUID-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>provideDiscoveryData</h4> |
| <pre>@Nullable |
| @Nullable <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a> provideDiscoveryData(<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> nodeId)</pre> |
| <div class="block">Gets plugin discovery data object that will be sent to the new node |
| during discovery process.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeId</code> - ID of new node that joins topology.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Discovery data object or <code>null</code> if there is nothing |
| to send for this component.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="receiveDiscoveryData-java.util.UUID-java.io.Serializable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>receiveDiscoveryData</h4> |
| <pre>void receiveDiscoveryData(<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> nodeId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a> data)</pre> |
| <div class="block">Receives plugin discovery data object from remote nodes (called |
| on new node during discovery process). This data is provided by |
| <a href="../../../../org/apache/ignite/plugin/PluginProvider.html#provideDiscoveryData-java.util.UUID-"><code>provideDiscoveryData(UUID)</code></a> method on the other nodes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeId</code> - Remote node ID.</dd> |
| <dd><code>data</code> - Discovery data object or <code>null</code> if nothing was |
| sent for this component.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateNewNode-org.apache.ignite.cluster.ClusterNode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateNewNode</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 validateNewNode(<a href="../../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a> node) |
| throws <a href="../../../../org/apache/ignite/plugin/PluginValidationException.html" title="class in org.apache.ignite.plugin">PluginValidationException</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/ignite/plugin/PluginProvider.html#validateNewNode-org.apache.ignite.cluster.ClusterNode-java.io.Serializable-"><code>validateNewNode(ClusterNode, Serializable)</code></a> instead.</span></div> |
| <div class="block">Validates that new node can join grid topology, this method is called on coordinator |
| node before new node joins topology.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>node</code> - Joining node.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/plugin/PluginValidationException.html" title="class in org.apache.ignite.plugin">PluginValidationException</a></code> - If cluster-wide plugin validation failed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateNewNode-org.apache.ignite.cluster.ClusterNode-java.io.Serializable-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>validateNewNode</h4> |
| <pre>default void validateNewNode(<a href="../../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a> node, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a> data)</pre> |
| <div class="block">Validates that new node can join grid topology, this method is called on coordinator |
| node before new node joins topology.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>node</code> - Joining node.</dd> |
| <dd><code>data</code> - Discovery data object or <code>null</code> if nothing was |
| sent for this component.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/plugin/PluginValidationException.html" title="class in org.apache.ignite.plugin">PluginValidationException</a></code> - If cluster-wide plugin validation failed.</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/PluginProvider.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/plugin/PluginNotFoundException.html" title="class in org.apache.ignite.plugin"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/plugin/PluginValidationException.html" title="class in org.apache.ignite.plugin"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/plugin/PluginProvider.html" target="_top">Frames</a></li> |
| <li><a href="PluginProvider.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> |
