blob: 30921abf2668f1f19dfa2d74231061ba565ddbf2 [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>
<META NAME="ROBOTS" CONTENT="NOINDEX">
<link rel="canonical" href="https://ignite.apache.org/releases/1.6.0/javadoc/org/apache/ignite/plugin/CachePluginProvider.html" />
<!-- Generated by javadoc (version 1.7.0_80) on Wed May 18 17:03:58 MSK 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CachePluginProvider (Ignite 1.6.0)</title>
<meta name="date" content="2016-05-18">
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CachePluginProvider (Ignite 1.6.0)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/CachePluginProvider.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 class="aboutLanguage"><em>Ignite - In-Memory Data Fabric</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/plugin/CachePluginContext.html" title="interface in org.apache.ignite.plugin"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/ignite/plugin/Extension.html" title="interface in org.apache.ignite.plugin"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/plugin/CachePluginProvider.html" target="_top">Frames</a></li>
<li><a href="CachePluginProvider.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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.plugin</div>
<h2 title="Interface CachePluginProvider" class="title">Interface CachePluginProvider&lt;C extends <a href="../../../../org/apache/ignite/plugin/CachePluginConfiguration.html" title="interface in org.apache.ignite.plugin">CachePluginConfiguration</a>&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">CachePluginProvider&lt;C extends <a href="../../../../org/apache/ignite/plugin/CachePluginConfiguration.html" title="interface in org.apache.ignite.plugin">CachePluginConfiguration</a>&gt;</span></pre>
<div class="block">Cache plugin provider is a point for processing of properties
which provide specific <a href="../../../../org/apache/ignite/plugin/CachePluginConfiguration.html" title="interface in org.apache.ignite.plugin"><code>CachePluginConfiguration</code></a>.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/plugin/CachePluginProvider.html#createComponent(java.lang.Class)">createComponent</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;cls)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/plugin/CachePluginProvider.html#onIgniteStart()">onIgniteStart</a></strong>()</code>
<div class="block">Callback that notifies that Ignite has successfully started,
including all internal components.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/plugin/CachePluginProvider.html#onIgniteStop(boolean)">onIgniteStop</a></strong>(boolean&nbsp;cancel)</code>
<div class="block">Callback to notify that Ignite is about to stop.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/plugin/CachePluginProvider.html#start()">start</a></strong>()</code>
<div class="block">Starts grid component.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/plugin/CachePluginProvider.html#stop(boolean)">stop</a></strong>(boolean&nbsp;cancel)</code>
<div class="block">Stops grid component.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T,K,V&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/plugin/CachePluginProvider.html#unwrapCacheEntry(javax.cache.Cache.Entry,%20java.lang.Class)">unwrapCacheEntry</a></strong>(javax.cache.Cache.Entry&lt;K,V&gt;&nbsp;entry,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;cls)</code>
<div class="block">Unwrap entry to specified type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/plugin/CachePluginProvider.html#validate()">validate</a></strong>()</code>
<div class="block">Validates cache plugin configuration in process of cache creation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/plugin/CachePluginProvider.html#validateRemote(org.apache.ignite.configuration.CacheConfiguration,%20C,%20org.apache.ignite.configuration.CacheConfiguration,%20org.apache.ignite.cluster.ClusterNode)">validateRemote</a></strong>(<a href="../../../../org/apache/ignite/configuration/CacheConfiguration.html" title="class in org.apache.ignite.configuration">CacheConfiguration</a>&nbsp;locCfg,
<a href="../../../../org/apache/ignite/plugin/CachePluginProvider.html" title="type parameter in CachePluginProvider">C</a>&nbsp;locPluginCcfg,
<a href="../../../../org/apache/ignite/configuration/CacheConfiguration.html" title="class in org.apache.ignite.configuration">CacheConfiguration</a>&nbsp;rmtCfg,
<a href="../../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a>&nbsp;rmtNode)</code>
<div class="block">Checks that remote caches has configuration compatible with the local.</div>
</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="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>void&nbsp;start()
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="strong">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&nbsp;stop(boolean&nbsp;cancel)</pre>
<div class="block">Stops grid component.</div>
<dl><dt><span class="strong">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="strong">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&nbsp;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="strong">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&nbsp;onIgniteStop(boolean&nbsp;cancel)</pre>
<div class="block">Callback to notify that Ignite is about to stop.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cancel</code> - Flag indicating whether jobs should be canceled.</dd></dl>
</li>
</ul>
<a name="createComponent(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createComponent</h4>
<pre>@Nullable
&lt;T&gt;&nbsp;T&nbsp;createComponent(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;cls)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cls</code> - Ignite component class.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Ignite component or <code>null</code> if component is not supported.</dd></dl>
</li>
</ul>
<a name="unwrapCacheEntry(javax.cache.Cache.Entry, java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unwrapCacheEntry</h4>
<pre>@Nullable
&lt;T,K,V&gt;&nbsp;T&nbsp;unwrapCacheEntry(javax.cache.Cache.Entry&lt;K,V&gt;&nbsp;entry,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;cls)</pre>
<div class="block">Unwrap entry to specified type. For details see <code>javax.cache.Cache.Entry.unwrap(Class)</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entry</code> - Mutable entry to unwrap.</dd><dd><code>cls</code> - Type of the expected component.</dd>
<dt><span class="strong">Returns:</span></dt><dd>New instance of underlying type or <code>null</code> if it's not available.</dd></dl>
</li>
</ul>
<a name="validate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre>void&nbsp;validate()
throws <a href="../../../../org/apache/ignite/IgniteCheckedException.html" title="class in org.apache.ignite">IgniteCheckedException</a></pre>
<div class="block">Validates cache plugin configuration in process of cache creation. Throw exception if validation failed.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/IgniteCheckedException.html" title="class in org.apache.ignite">IgniteCheckedException</a></code> - If validation failed.</dd></dl>
</li>
</ul>
<a name="validateRemote(org.apache.ignite.configuration.CacheConfiguration,org.apache.ignite.plugin.CachePluginConfiguration,org.apache.ignite.configuration.CacheConfiguration,org.apache.ignite.cluster.ClusterNode)">
<!-- -->
</a><a name="validateRemote(org.apache.ignite.configuration.CacheConfiguration, C, org.apache.ignite.configuration.CacheConfiguration, org.apache.ignite.cluster.ClusterNode)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>validateRemote</h4>
<pre>void&nbsp;validateRemote(<a href="../../../../org/apache/ignite/configuration/CacheConfiguration.html" title="class in org.apache.ignite.configuration">CacheConfiguration</a>&nbsp;locCfg,
<a href="../../../../org/apache/ignite/plugin/CachePluginProvider.html" title="type parameter in CachePluginProvider">C</a>&nbsp;locPluginCcfg,
<a href="../../../../org/apache/ignite/configuration/CacheConfiguration.html" title="class in org.apache.ignite.configuration">CacheConfiguration</a>&nbsp;rmtCfg,
<a href="../../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a>&nbsp;rmtNode)
throws <a href="../../../../org/apache/ignite/IgniteCheckedException.html" title="class in org.apache.ignite">IgniteCheckedException</a></pre>
<div class="block">Checks that remote caches has configuration compatible with the local.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locCfg</code> - Local configuration.</dd><dd><code>locPluginCcfg</code> - Local plugin configuration.</dd><dd><code>rmtCfg</code> - Remote configuration.</dd><dd><code>rmtNode</code> - Remote node.</dd>
<dt><span class="strong">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>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/CachePluginProvider.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 class="aboutLanguage"><em>Ignite - In-Memory Data Fabric</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/plugin/CachePluginContext.html" title="interface in org.apache.ignite.plugin"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/ignite/plugin/Extension.html" title="interface in org.apache.ignite.plugin"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/plugin/CachePluginProvider.html" target="_top">Frames</a></li>
<li><a href="CachePluginProvider.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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>2015 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> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> </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 Fabric</b> </td> <td>:&nbsp;&nbsp; ver. <strong>1.6.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; May 18 2016 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>