blob: 39d8ae5f7560589e2bd2bff6201b6431f7eeafe6 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IPluginContext&lt;T&gt;
| Apache Ignite.NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IPluginContext&lt;T&gt;
| Apache Ignite.NET ">
<meta name="generator" content="docfx 2.24.0.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
</head>
<body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo_ignite_32_32.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items"></div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1">
<h1 id="Apache_Ignite_Core_Plugin_IPluginContext_1" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1" class="text-break">Interface IPluginContext&lt;T&gt;
</h1>
<div class="markdown level0 summary"><p>Plugin execution context.</p>
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Apache.Ignite.Core.Plugin.html">Apache.Ignite.Core.Plugin</a></h6>
<h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
<h5 id="Apache_Ignite_Core_Plugin_IPluginContext_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IPluginContext&lt;out T&gt;
where T : IPluginConfiguration</code></pre>
</div>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Apache_Ignite_Core_Plugin_IPluginContext_1_Ignite_" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.Ignite*"></a>
<h4 id="Apache_Ignite_Core_Plugin_IPluginContext_1_Ignite" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.Ignite">Ignite</h4>
<div class="markdown level1 summary"><p>Gets the Ignite.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IIgnite Ignite { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.IIgnite.html">IIgnite</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Plugin_IPluginContext_1_IgniteConfiguration_" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.IgniteConfiguration*"></a>
<h4 id="Apache_Ignite_Core_Plugin_IPluginContext_1_IgniteConfiguration" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.IgniteConfiguration">IgniteConfiguration</h4>
<div class="markdown level1 summary"><p>Gets the Ignite configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IgniteConfiguration IgniteConfiguration { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.IgniteConfiguration.html">IgniteConfiguration</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Plugin_IPluginContext_1_PluginConfiguration_" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.PluginConfiguration*"></a>
<h4 id="Apache_Ignite_Core_Plugin_IPluginContext_1_PluginConfiguration" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.PluginConfiguration">PluginConfiguration</h4>
<div class="markdown level1 summary"><p>Gets the plugin configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T PluginConfiguration { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="Apache_Ignite_Core_Plugin_IPluginContext_1_GetExtension_" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.GetExtension*"></a>
<h4 id="Apache_Ignite_Core_Plugin_IPluginContext_1_GetExtension_System_Int32_" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.GetExtension(System.Int32)">GetExtension(Int32)</h4>
<div class="markdown level1 summary"><p>Gets a reference to plugin extension on Java side.
<p>
Extensions on Java side are configured via PluginProvider.initExtensions().
Extension should implement PlatformExtension interface to be accessible from this method.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IPlatformTarget GetExtension(int id)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">id</span></td>
<td><p>Extension id. Equal to PlatformExtension.id().</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Interop.IPlatformTarget.html">IPlatformTarget</a></td>
<td><p>Reference to a plugin extension on Java side.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Plugin_IPluginContext_1_InjectResources_" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.InjectResources*"></a>
<h4 id="Apache_Ignite_Core_Plugin_IPluginContext_1_InjectResources_System_Object_" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.InjectResources(System.Object)">InjectResources(Object)</h4>
<div class="markdown level1 summary"><p>Injects resources into specified target:
populates members marked with <a class="xref" href="Apache.Ignite.Core.Resource.InstanceResourceAttribute.html">InstanceResourceAttribute</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void InjectResources(object target)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Object</span></td>
<td><span class="parametername">target</span></td>
<td><p>Target object.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Plugin_IPluginContext_1_RegisterCallback_" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.RegisterCallback*"></a>
<h4 id="Apache_Ignite_Core_Plugin_IPluginContext_1_RegisterCallback_System_Int64_Apache_Ignite_Core_Plugin_PluginCallback_" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.RegisterCallback(System.Int64,Apache.Ignite.Core.Plugin.PluginCallback)">RegisterCallback(Int64, PluginCallback)</h4>
<div class="markdown level1 summary"><p>Registers Java-&gt;.NET callback.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void RegisterCallback(long callbackId, PluginCallback callback)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int64</span></td>
<td><span class="parametername">callbackId</span></td>
<td><p>Callback id.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Plugin.PluginCallback.html">PluginCallback</a></td>
<td><span class="parametername">callback</span></td>
<td><p>Callback delegate.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Plugin_IPluginContext_1_RegisterExceptionMapping_" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.RegisterExceptionMapping*"></a>
<h4 id="Apache_Ignite_Core_Plugin_IPluginContext_1_RegisterExceptionMapping_System_String_Apache_Ignite_Core_Common_ExceptionFactory_" data-uid="Apache.Ignite.Core.Plugin.IPluginContext`1.RegisterExceptionMapping(System.String,Apache.Ignite.Core.Common.ExceptionFactory)">RegisterExceptionMapping(String, ExceptionFactory)</h4>
<div class="markdown level1 summary"><p>Registers custom exception mapping: when Java exception of specified class occurs, it will be mapped
using provided factory delegate.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void RegisterExceptionMapping(string className, ExceptionFactory factory)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">className</span></td>
<td><p>Name of the Java exception class to be mapped.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Common.ExceptionFactory.html">ExceptionFactory</a></td>
<td><span class="parametername">factory</span></td>
<td><p>Exception factory delegate.</p>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
© 2015 - 2019 The Apache Software Foundation
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>