| <!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:51 MSK 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CacheEvent (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="CacheEvent (Ignite 2.11.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/CacheEvent.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/events/CacheConsistencyViolationEvent.html" title="class in org.apache.ignite.events"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/events/CacheQueryExecutedEvent.html" title="class in org.apache.ignite.events"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/events/CacheEvent.html" target="_top">Frames</a></li> |
| <li><a href="CacheEvent.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.events</div> |
| <h2 title="Class CacheEvent" class="title">Class CacheEvent</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/ignite/events/EventAdapter.html" title="class in org.apache.ignite.events">org.apache.ignite.events.EventAdapter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.ignite.events.CacheEvent</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><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>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/events/Event.html" title="interface in org.apache.ignite.events">Event</a><span class='angle_bracket'>></span>, <a href="../../../../org/apache/ignite/events/Event.html" title="interface in org.apache.ignite.events">Event</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">CacheEvent</span> |
| extends <a href="../../../../org/apache/ignite/events/EventAdapter.html" title="class in org.apache.ignite.events">EventAdapter</a></pre> |
| <div class="block">In-memory database (cache) event. |
| <p> |
| Grid events are used for notification about what happens within the grid. Note that by |
| design Ignite keeps all events generated on the local node locally and it provides |
| APIs for performing a distributed queries across multiple nodes: |
| <ul> |
| <li> |
| <a href="../../../../org/apache/ignite/IgniteEvents.html#remoteQuery-org.apache.ignite.lang.IgnitePredicate-long-int...-"><code>IgniteEvents.remoteQuery(IgnitePredicate, long, int...)</code></a> - |
| asynchronously querying events occurred on the nodes specified, including remote nodes. |
| </li> |
| <li> |
| <a href="../../../../org/apache/ignite/IgniteEvents.html#localQuery-org.apache.ignite.lang.IgnitePredicate-int...-"><code>IgniteEvents.localQuery(IgnitePredicate, int...)</code></a> - |
| querying only local events stored on this local node. |
| </li> |
| <li> |
| <a href="../../../../org/apache/ignite/IgniteEvents.html#localListen-org.apache.ignite.lang.IgnitePredicate-int...-"><code>IgniteEvents.localListen(IgnitePredicate, int...)</code></a> - |
| listening to local grid events (events from remote nodes not included). |
| </li> |
| </ul> |
| User can also wait for events using method <a href="../../../../org/apache/ignite/IgniteEvents.html#waitForLocal-org.apache.ignite.lang.IgnitePredicate-int...-"><code>IgniteEvents.waitForLocal(IgnitePredicate, int...)</code></a>. |
| <h1 class="header">Events and Performance</h1> |
| Note that by default all events in Ignite are enabled and therefore generated and stored |
| by whatever event storage SPI is configured. Ignite can and often does generate thousands events per seconds |
| under the load and therefore it creates a significant additional load on the system. If these events are |
| not needed by the application this load is unnecessary and leads to significant performance degradation. |
| <p> |
| It is <b>highly recommended</b> to enable only those events that your application logic requires |
| by using <a href="../../../../org/apache/ignite/configuration/IgniteConfiguration.html#getIncludeEventTypes--"><code>IgniteConfiguration.getIncludeEventTypes()</code></a> method in Ignite configuration. Note that certain |
| events are required for Ignite's internal operations and such events will still be generated but not stored by |
| event storage SPI if they are disabled in Ignite configuration.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_STARTED"><code>EventType.EVT_CACHE_STARTED</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_STOPPED"><code>EventType.EVT_CACHE_STOPPED</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_NODES_LEFT"><code>EventType.EVT_CACHE_NODES_LEFT</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVTS_CACHE_LIFECYCLE"><code>EventType.EVTS_CACHE_LIFECYCLE</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_ENTRY_CREATED"><code>EventType.EVT_CACHE_ENTRY_CREATED</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_ENTRY_DESTROYED"><code>EventType.EVT_CACHE_ENTRY_DESTROYED</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_ENTRY_EVICTED"><code>EventType.EVT_CACHE_ENTRY_EVICTED</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_OBJECT_EXPIRED"><code>EventType.EVT_CACHE_OBJECT_EXPIRED</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_OBJECT_LOCKED"><code>EventType.EVT_CACHE_OBJECT_LOCKED</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_OBJECT_PUT"><code>EventType.EVT_CACHE_OBJECT_PUT</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_OBJECT_READ"><code>EventType.EVT_CACHE_OBJECT_READ</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_OBJECT_REMOVED"><code>EventType.EVT_CACHE_OBJECT_REMOVED</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_OBJECT_UNLOCKED"><code>EventType.EVT_CACHE_OBJECT_UNLOCKED</code></a>, |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVTS_CACHE"><code>EventType.EVTS_CACHE</code></a>, |
| <a href="../../../../serialized-form.html#org.apache.ignite.events.CacheEvent">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/events/CacheEvent.html#CacheEvent-java.lang.String-org.apache.ignite.cluster.ClusterNode-org.apache.ignite.cluster.ClusterNode-java.lang.String-int-int-boolean-java.lang.Object-org.apache.ignite.lang.IgniteUuid-java.lang.String-java.lang.Object-java.lang.Object-boolean-java.lang.Object-boolean-java.util.UUID-java.lang.String-java.lang.String-">CacheEvent</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, |
| <a href="../../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a> node, |
| @Nullable <a href="../../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a> evtNode, |
| <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> msg, |
| int type, |
| int part, |
| boolean near, |
| <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> key, |
| <a href="../../../../org/apache/ignite/lang/IgniteUuid.html" title="class in org.apache.ignite.lang">IgniteUuid</a> xid, |
| <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> txLbl, |
| <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> lockId, |
| <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> newVal, |
| boolean hasNewVal, |
| <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> oldVal, |
| boolean hasOldVal, |
| <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> subjId, |
| <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> cloClsName, |
| <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> taskName)</code> |
| <div class="block">Constructs cache event.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/events/CacheEvent.html#cacheName--">cacheName</a></span>()</code> |
| <div class="block">Gets cache name.</div> |
| </td> |
| </tr> |
| <tr id="i1" 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/events/CacheEvent.html#closureClassName--">closureClassName</a></span>()</code> |
| <div class="block">Gets closure class name (applicable only for TRANSFORM operations).</div> |
| </td> |
| </tr> |
| <tr id="i2" 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/events/CacheEvent.html#eventNode--">eventNode</a></span>()</code> |
| <div class="block">Gets node which initiated cache operation or <code>null</code> if that node is not available.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/events/CacheEvent.html#hasNewValue--">hasNewValue</a></span>()</code> |
| <div class="block">Gets flag indicating whether cache entry has new value in case if |
| we only have new value in serialized form in which case <a href="../../../../org/apache/ignite/events/CacheEvent.html#newValue--"><code>newValue()</code></a> |
| will return <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/events/CacheEvent.html#hasOldValue--">hasOldValue</a></span>()</code> |
| <div class="block">Gets flag indicating whether cache entry has old value in case if |
| we only have old value in serialized form in which case <a href="../../../../org/apache/ignite/events/CacheEvent.html#oldValue--"><code>oldValue()</code></a> |
| will return <code>null</code>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/events/CacheEvent.html#isNear--">isNear</a></span>()</code> |
| <div class="block">Gets flag indicating whether event happened on <code>near</code> or <code>partitioned</code> cache.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><span class='angle_bracket'><</span>K<span class='angle_bracket'>></span> K</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/events/CacheEvent.html#key--">key</a></span>()</code> |
| <div class="block">Gets cache entry associated with event.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/events/CacheEvent.html#lockId--">lockId</a></span>()</code> |
| <div class="block">ID of the lock if held or <tt>null</tt> if no lock held.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/events/CacheEvent.html#newValue--">newValue</a></span>()</code> |
| <div class="block">Gets new value for this event.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/events/CacheEvent.html#oldValue--">oldValue</a></span>()</code> |
| <div class="block">Gets old value associated with this event.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/events/CacheEvent.html#partition--">partition</a></span>()</code> |
| <div class="block">Gets partition for the event which is the partition the key belongs to.</div> |
| </td> |
| </tr> |
| <tr id="i11" 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/events/CacheEvent.html#shortDisplay--">shortDisplay</a></span>()</code> |
| <div class="block">Gets a shortened version of <code>toString()</code> result.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <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/events/CacheEvent.html#subjectId--">subjectId</a></span>()</code> |
| <div class="block">Gets security subject ID initiated this cache event, if available.</div> |
| </td> |
| </tr> |
| <tr id="i13" 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/events/CacheEvent.html#taskName--">taskName</a></span>()</code> |
| <div class="block">Gets task name if cache event was caused by an operation initiated within task execution.</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/events/CacheEvent.html#toString--">toString</a></span>()</code></td> |
| </tr> |
| <tr id="i15" 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/events/CacheEvent.html#txLabel--">txLabel</a></span>()</code> |
| <div class="block">Label of surrounding cache transaction or <tt>null</tt> if there either is |
| no surrounding transaction or label was not set.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/lang/IgniteUuid.html" title="class in org.apache.ignite.lang">IgniteUuid</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/events/CacheEvent.html#xid--">xid</a></span>()</code> |
| <div class="block">ID of surrounding cache transaction or <tt>null</tt> if there is |
| no surrounding transaction.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.events.EventAdapter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.ignite.events.<a href="../../../../org/apache/ignite/events/EventAdapter.html" title="class in org.apache.ignite.events">EventAdapter</a></h3> |
| <code><a href="../../../../org/apache/ignite/events/EventAdapter.html#compareTo-org.apache.ignite.events.Event-">compareTo</a>, <a href="../../../../org/apache/ignite/events/EventAdapter.html#equals-java.lang.Object-">equals</a>, <a href="../../../../org/apache/ignite/events/EventAdapter.html#hashCode--">hashCode</a>, <a href="../../../../org/apache/ignite/events/EventAdapter.html#id--">id</a>, <a href="../../../../org/apache/ignite/events/EventAdapter.html#localOrder--">localOrder</a>, <a href="../../../../org/apache/ignite/events/EventAdapter.html#message--">message</a>, <a href="../../../../org/apache/ignite/events/EventAdapter.html#message-java.lang.String-">message</a>, <a href="../../../../org/apache/ignite/events/EventAdapter.html#name--">name</a>, <a href="../../../../org/apache/ignite/events/EventAdapter.html#node--">node</a>, <a href="../../../../org/apache/ignite/events/EventAdapter.html#node-org.apache.ignite.cluster.ClusterNode-">node</a>, <a href="../../../../org/apache/ignite/events/EventAdapter.html#timestamp--">timestamp</a>, <a href="../../../../org/apache/ignite/events/EventAdapter.html#type--">type</a>, <a href="../../../../org/apache/ignite/events/EventAdapter.html#type-int-">type</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CacheEvent-java.lang.String-org.apache.ignite.cluster.ClusterNode-org.apache.ignite.cluster.ClusterNode-java.lang.String-int-int-boolean-java.lang.Object-org.apache.ignite.lang.IgniteUuid-java.lang.String-java.lang.Object-java.lang.Object-boolean-java.lang.Object-boolean-java.util.UUID-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CacheEvent</h4> |
| <pre>public CacheEvent(<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, |
| <a href="../../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a> node, |
| @Nullable |
| @Nullable <a href="../../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a> evtNode, |
| <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> msg, |
| int type, |
| int part, |
| boolean near, |
| <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> key, |
| <a href="../../../../org/apache/ignite/lang/IgniteUuid.html" title="class in org.apache.ignite.lang">IgniteUuid</a> xid, |
| <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> txLbl, |
| <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> lockId, |
| <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> newVal, |
| boolean hasNewVal, |
| <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> oldVal, |
| boolean hasOldVal, |
| <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> subjId, |
| <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> cloClsName, |
| <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> taskName)</pre> |
| <div class="block">Constructs cache event.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cacheName</code> - Cache name.</dd> |
| <dd><code>node</code> - Local node.</dd> |
| <dd><code>evtNode</code> - Event node ID.</dd> |
| <dd><code>msg</code> - Event message.</dd> |
| <dd><code>type</code> - Event type.</dd> |
| <dd><code>part</code> - Partition for the event (usually the partition the key belongs to).</dd> |
| <dd><code>near</code> - Flag indicating whether event happened on <code>near</code> or <code>partitioned</code> cache.</dd> |
| <dd><code>key</code> - Cache key.</dd> |
| <dd><code>xid</code> - Transaction ID.</dd> |
| <dd><code>txLbl</code> - Transaction label.</dd> |
| <dd><code>lockId</code> - Lock ID.</dd> |
| <dd><code>newVal</code> - New value.</dd> |
| <dd><code>hasNewVal</code> - Flag indicating whether new value is present in case if we |
| don't have it in deserialized form.</dd> |
| <dd><code>oldVal</code> - Old value.</dd> |
| <dd><code>hasOldVal</code> - Flag indicating whether old value is present in case if we |
| don't have it in deserialized form.</dd> |
| <dd><code>subjId</code> - Subject ID.</dd> |
| <dd><code>cloClsName</code> - Closure class name.</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="cacheName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cacheName</h4> |
| <pre>public <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">Gets cache name.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Cache name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="partition--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>partition</h4> |
| <pre>public int partition()</pre> |
| <div class="block">Gets partition for the event which is the partition the key belongs to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Partition for the event.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isNear--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNear</h4> |
| <pre>public boolean isNear()</pre> |
| <div class="block">Gets flag indicating whether event happened on <code>near</code> or <code>partitioned</code> cache.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Flag indicating whether event happened on <code>near</code> or <code>partitioned</code> cache.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="eventNode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>eventNode</h4> |
| <pre>public <a href="../../../../org/apache/ignite/cluster/ClusterNode.html" title="interface in org.apache.ignite.cluster">ClusterNode</a> eventNode()</pre> |
| <div class="block">Gets node which initiated cache operation or <code>null</code> if that node is not available.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Node which initiated cache operation or <code>null</code> if that node is not available.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="key--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>key</h4> |
| <pre>public <span class='angle_bracket'><</span>K<span class='angle_bracket'>></span> K key()</pre> |
| <div class="block">Gets cache entry associated with event.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Cache entry associated with event.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="xid--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>xid</h4> |
| <pre>public <a href="../../../../org/apache/ignite/lang/IgniteUuid.html" title="class in org.apache.ignite.lang">IgniteUuid</a> xid()</pre> |
| <div class="block">ID of surrounding cache transaction or <tt>null</tt> if there is |
| no surrounding transaction.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ID of surrounding cache transaction.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="txLabel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>txLabel</h4> |
| <pre>public <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> txLabel()</pre> |
| <div class="block">Label of surrounding cache transaction or <tt>null</tt> if there either is |
| no surrounding transaction or label was not set.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Label of surrounding cache transaction.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="lockId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lockId</h4> |
| <pre>public <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> lockId()</pre> |
| <div class="block">ID of the lock if held or <tt>null</tt> if no lock held.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ID of the lock if held.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newValue</h4> |
| <pre>public <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> newValue()</pre> |
| <div class="block">Gets new value for this event.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>New value associated with event (<tt>null</tt> if event is |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_OBJECT_REMOVED"><code>EventType.EVT_CACHE_OBJECT_REMOVED</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="oldValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>oldValue</h4> |
| <pre>public <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> oldValue()</pre> |
| <div class="block">Gets old value associated with this event.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Old value associated with event.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasOldValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasOldValue</h4> |
| <pre>public boolean hasOldValue()</pre> |
| <div class="block">Gets flag indicating whether cache entry has old value in case if |
| we only have old value in serialized form in which case <a href="../../../../org/apache/ignite/events/CacheEvent.html#oldValue--"><code>oldValue()</code></a> |
| will return <code>null</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Flag indicating whether there is old value associated with this event.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasNewValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasNewValue</h4> |
| <pre>public boolean hasNewValue()</pre> |
| <div class="block">Gets flag indicating whether cache entry has new value in case if |
| we only have new value in serialized form in which case <a href="../../../../org/apache/ignite/events/CacheEvent.html#newValue--"><code>newValue()</code></a> |
| will return <code>null</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Flag indicating whether there is new value associated with this event.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="subjectId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>subjectId</h4> |
| <pre>public <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> subjectId()</pre> |
| <div class="block">Gets security subject ID initiated this cache event, if available. This property is available only for |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_OBJECT_PUT"><code>EventType.EVT_CACHE_OBJECT_PUT</code></a>, <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_OBJECT_REMOVED"><code>EventType.EVT_CACHE_OBJECT_REMOVED</code></a> and |
| <a href="../../../../org/apache/ignite/events/EventType.html#EVT_CACHE_OBJECT_READ"><code>EventType.EVT_CACHE_OBJECT_READ</code></a> cache events. |
| <p> |
| Subject ID will be set either to nodeId initiated cache update or read or client ID initiated |
| cache update or read.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Subject ID.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="closureClassName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closureClassName</h4> |
| <pre>public <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> closureClassName()</pre> |
| <div class="block">Gets closure class name (applicable only for TRANSFORM operations).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Closure class name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="taskName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>taskName</h4> |
| <pre>public <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> taskName()</pre> |
| <div class="block">Gets task name if cache event was caused by an operation initiated within task execution.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Task name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shortDisplay--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shortDisplay</h4> |
| <pre>public <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> shortDisplay()</pre> |
| <div class="block">Gets a shortened version of <code>toString()</code> result. Suitable for humans to read.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/events/Event.html#shortDisplay--">shortDisplay</a></code> in interface <code><a href="../../../../org/apache/ignite/events/Event.html" title="interface in org.apache.ignite.events">Event</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/events/EventAdapter.html#shortDisplay--">shortDisplay</a></code> in class <code><a href="../../../../org/apache/ignite/events/EventAdapter.html" title="class in org.apache.ignite.events">EventAdapter</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Shortened version of <code>toString()</code> result.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <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> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/events/EventAdapter.html#toString--">toString</a></code> in class <code><a href="../../../../org/apache/ignite/events/EventAdapter.html" title="class in org.apache.ignite.events">EventAdapter</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> |
| <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/CacheEvent.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/events/CacheConsistencyViolationEvent.html" title="class in org.apache.ignite.events"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/events/CacheQueryExecutedEvent.html" title="class in org.apache.ignite.events"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/events/CacheEvent.html" target="_top">Frames</a></li> |
| <li><a href="CacheEvent.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
