IgniteTxEntry (Ignite 2.9.0)

java.lang.Object
- org.apache.ignite.internal.processors.cache.transactions.IgniteTxEntry

All Implemented Interfaces:

Serializable, GridPeerDeployAware, Message
```
public class IgniteTxEntry
extends Object
implements GridPeerDeployAware, Message
```
Transaction entry. Note that it is essential that this class does not override Object.equals(Object) method, as transaction entries should use referential equality.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static GridCacheVersion`	`GET_ENTRY_INVALID_VER_AFTER_GET`
`static GridCacheVersion`	`GET_ENTRY_INVALID_VER_UPDATED`
`static GridCacheVersion`	`SER_READ_EMPTY_ENTRY_VER` Dummy version for non-existing entry read in SERIALIZABLE transaction.
`static GridCacheVersion`	`SER_READ_NOT_EMPTY_VER` Dummy version for any existing entry read in SERIALIZABLE transaction.
`IgniteInternalTx`	`tx` Owning transaction.

Fields inherited from interface org.apache.ignite.plugin.extensions.communication.Message
DIRECT_TYPE_SIZE

Constructor Summary

Constructors
Constructor and Description
`IgniteTxEntry()` Required by `Externalizable`
`IgniteTxEntry(GridCacheContext<?,?> ctx, IgniteInternalTx tx, GridCacheOperation op, CacheObject val, javax.cache.processor.EntryProcessor<Object,Object,Object> entryProcessor, Object[] invokeArgs, long ttl, GridCacheEntryEx entry, CacheEntryPredicate[] filters, GridCacheVersion conflictVer, boolean skipStore, boolean keepBinary, boolean addReader)` This constructor is meant for local transactions.
`IgniteTxEntry(GridCacheContext<?,?> ctx, IgniteInternalTx tx, GridCacheOperation op, CacheObject val, long ttl, long conflictExpireTime, GridCacheEntryEx entry, @Nullable GridCacheVersion conflictVer, boolean skipStore, boolean keepBinary)` This constructor is meant for remote transactions.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEntryProcessor(javax.cache.processor.EntryProcessor<Object,Object,Object> entryProcessor, Object[] invokeArgs)`
`boolean`	`addReader()`
`void`	`addReader(boolean addReader)`
`CacheObject`	`applyEntryProcessors(CacheObject cacheVal)`
`GridCacheEntryEx`	`cached()`
`void`	`cached(GridCacheEntryEx entry)`
`int`	`cacheId()`
`ClassLoader`	`classLoader()` Gets class loader for the class.
`IgniteTxEntry`	`cleanCopy(GridCacheContext<?,?> ctx)`
`void`	`clearEntryReadVersion()` Clears recorded read version, should be done before starting commit of not serializable/optimistic transaction.
`long`	`conflictExpireTime()`
`void`	`conflictExpireTime(long conflictExpireTime)`
`@Nullable GridCacheVersion`	`conflictVersion()`
`void`	`conflictVersion(@Nullable GridCacheVersion conflictVer)`
`GridCacheContext<?,?>`	`context()`
`void`	`context(GridCacheContext<?,?> ctx)`
`GridAbsClosureX`	`cqNotifyClosure()`
`void`	`cqNotifyClosure(GridAbsClosureX clo)`
`Class<?>`	`deployClass()` Gets top level user class being deployed.
`GridCacheVersion`	`dhtVersion()`
`void`	`dhtVersion(GridCacheVersion dhtVer)`
`short`	`directType()` Gets message type.
`T2<GridCacheOperation,CacheObject>`	`entryProcessorCalculatedValue()`
`void`	`entryProcessorCalculatedValue(T2<GridCacheOperation,CacheObject> entryProcessorCalcVal)`
`Collection<T2<javax.cache.processor.EntryProcessor<Object,Object,Object>,Object[]>>`	`entryProcessors()`
`void`	`entryProcessors(@Nullable Collection<T2<javax.cache.processor.EntryProcessor<Object,Object,Object>,Object[]>> entryProcessorsCol)`
`@Nullable GridCacheVersion`	`entryReadVersion()` Gets stored entry version.
`void`	`entryReadVersion(GridCacheVersion ver)`
`@Nullable javax.cache.expiry.ExpiryPolicy`	`expiry()`
`void`	`expiry(@Nullable javax.cache.expiry.ExpiryPolicy expiryPlc)`
`GridCacheVersion`	`explicitVersion()`
`void`	`explicitVersion(GridCacheVersion explicitVer)`
`byte`	`fieldsCount()` Gets fields count.
`CacheEntryPredicate[]`	`filters()`
`void`	`filters(CacheEntryPredicate[] filters)`
`boolean`	`filtersPassed()`
`void`	`filtersPassed(boolean filtersPassed)`
`boolean`	`filtersSet()`
`void`	`filtersSet(boolean filtersSet)`
`boolean`	`hasOldValue()`
`boolean`	`hasPreviousValue()`
`boolean`	`hasReadValue()`
`boolean`	`hasValue()`
`boolean`	`hasWriteValue()`
`boolean`	`isRead()`
`boolean`	`keepBinary()`
`void`	`keepBinary(boolean keepBinary)` Sets keep binary flag value.
`KeyCacheObject`	`key()`
`boolean`	`locallyMapped()`
`void`	`locallyMapped(boolean locMapped)`
`boolean`	`locked()`
`void`	`markLocked()` Marks tx entry as locked.
`void`	`markValid()` Marks this entry as value-has-bean-read.
`void`	`marshal(GridCacheSharedContext<?,?> ctx, boolean transferExpiry)`
`UUID`	`nodeId()`
`void`	`nodeId(UUID nodeId)`
`@Nullable CacheObject`	`oldValue()`
`void`	`oldValue(CacheObject oldVal)`
`void`	`oldValueOnPrimary(boolean oldValOnPrimary)`
`void`	`onAckReceived()` Method called when ack message received.
`GridCacheOperation`	`op()`
`void`	`op(GridCacheOperation op)`
`@Nullable GridCacheOperation`	`previousOperation()`
`@Nullable CacheObject`	`previousValue()`
`boolean`	`readFrom(ByteBuffer buf, MessageReader reader)` Reads this message from provided byte buffer.
`void`	`readValue(@Nullable CacheObject val)` Sets read value if this tx entry does not have write value yet.
`void`	`setAndMarkValid(CacheObject val)`
`boolean`	`skipStore()`
`void`	`skipStore(boolean skipStore)` Sets skip store flag value.
`String`	`toString()`
`long`	`ttl()`
`void`	`ttl(long ttl)`
`IgniteTxKey`	`txKey()`
`void`	`unmarshal(GridCacheSharedContext<?,?> ctx, boolean near, ClassLoader clsLdr)` Unmarshalls entry.
`long`	`updateCounter()`
`void`	`updateCounter(long partCntr)` Sets partition counter.
`@Nullable CacheObject`	`value()`
`void`	`value(@Nullable CacheObject val, boolean writeVal, boolean readVal)`
`boolean`	`writeTo(ByteBuffer buf, MessageWriter writer)` Writes this message to provided byte buffer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SER_READ_EMPTY_ENTRY_VER
```
public static final GridCacheVersion SER_READ_EMPTY_ENTRY_VER
```
    Dummy version for non-existing entry read in SERIALIZABLE transaction.
  - SER_READ_NOT_EMPTY_VER
```
public static final GridCacheVersion SER_READ_NOT_EMPTY_VER
```
    Dummy version for any existing entry read in SERIALIZABLE transaction.
  - GET_ENTRY_INVALID_VER_UPDATED
```
public static final GridCacheVersion GET_ENTRY_INVALID_VER_UPDATED
```
  - GET_ENTRY_INVALID_VER_AFTER_GET
```
public static final GridCacheVersion GET_ENTRY_INVALID_VER_AFTER_GET
```
  - tx
```
@GridToStringExclude
public IgniteInternalTx tx
```
    Owning transaction.
- Constructor Detail
  - IgniteTxEntry
```
public IgniteTxEntry()
```
    Required by Externalizable
  - IgniteTxEntry
```
public IgniteTxEntry(GridCacheContext<?,?> ctx,
                     IgniteInternalTx tx,
                     GridCacheOperation op,
                     CacheObject val,
                     long ttl,
                     long conflictExpireTime,
                     GridCacheEntryEx entry,
                     @Nullable
                     @Nullable GridCacheVersion conflictVer,
                     boolean skipStore,
                     boolean keepBinary)
```
    This constructor is meant for remote transactions.
    
    Parameters:
    
    ctx - Cache registry.
    
    tx - Owning transaction.
    
    op - Operation.
    
    val - Value.
    
    ttl - Time to live.
    
    conflictExpireTime - DR expire time.
    
    entry - Cache entry.
    
    conflictVer - Data center replication version.
    
    skipStore - Skip store flag.
  - IgniteTxEntry
```
public IgniteTxEntry(GridCacheContext<?,?> ctx,
                     IgniteInternalTx tx,
                     GridCacheOperation op,
                     CacheObject val,
                     javax.cache.processor.EntryProcessor<Object,Object,Object> entryProcessor,
                     Object[] invokeArgs,
                     long ttl,
                     GridCacheEntryEx entry,
                     CacheEntryPredicate[] filters,
                     GridCacheVersion conflictVer,
                     boolean skipStore,
                     boolean keepBinary,
                     boolean addReader)
```
    This constructor is meant for local transactions.
    
    Parameters:
    
    ctx - Cache registry.
    
    tx - Owning transaction.
    
    op - Operation.
    
    val - Value.
    
    entryProcessor - Entry processor.
    
    invokeArgs - Optional arguments for EntryProcessor.
    
    ttl - Time to live.
    
    entry - Cache entry.
    
    filters - Put filters.
    
    conflictVer - Data center replication version.
    
    skipStore - Skip store flag.
    
    addReader - Add reader flag.
- Method Detail
  - context
```
public GridCacheContext<?,?> context()
```
    Returns:
    
    Cache context for this tx entry.
  - context
```
public void context(GridCacheContext<?,?> ctx)
```
    Parameters:
    
    ctx - Cache context for this tx entry.
  - locallyMapped
```
public boolean locallyMapped()
```
    Returns:
    
    Flag indicating if this entry is affinity mapped to the same node.
  - locallyMapped
```
public void locallyMapped(boolean locMapped)
```
    Parameters:
    
    locMapped - Flag indicating if this entry is affinity mapped to the same node.
  - cleanCopy
```
public IgniteTxEntry cleanCopy(GridCacheContext<?,?> ctx)
```
    Parameters:
    
    ctx - Context.
    
    Returns:
    
    Clean copy of this entry.
  - nodeId
```
public UUID nodeId()
```
    Returns:
    
    Node ID.
  - nodeId
```
public void nodeId(UUID nodeId)
```
    Parameters:
    
    nodeId - Node ID.
  - dhtVersion
```
public GridCacheVersion dhtVersion()
```
    Returns:
    
    DHT version.
  - dhtVersion
```
public void dhtVersion(GridCacheVersion dhtVer)
```
    Parameters:
    
    dhtVer - DHT version.
  - locked
```
public boolean locked()
```
    Returns:
    
    True if tx entry was marked as locked.
  - markLocked
```
public void markLocked()
```
    Marks tx entry as locked.
  - updateCounter
```
public void updateCounter(long partCntr)
```
    Sets partition counter.
    
    Parameters:
    
    partCntr - Partition counter.
  - updateCounter
```
public long updateCounter()
```
    Returns:
    
    Partition index.
  - setAndMarkValid
```
public void setAndMarkValid(CacheObject val)
```
    Parameters:
    
    val - Value to set.
  - markValid
```
public void markValid()
```
    Marks this entry as value-has-bean-read. Effectively, makes values enlisted to transaction visible to further peek operations.
  - key
```
public KeyCacheObject key()
```
    Returns:
    
    Entry key.
  - cacheId
```
public int cacheId()
```
    Returns:
    
    Cache ID.
  - skipStore
```
public void skipStore(boolean skipStore)
```
    Sets skip store flag value.
    
    Parameters:
    
    skipStore - Skip store flag.
  - skipStore
```
public boolean skipStore()
```
    Returns:
    
    Skip store flag.
  - oldValueOnPrimary
```
public void oldValueOnPrimary(boolean oldValOnPrimary)
```
    Parameters:
    
    oldValOnPrimary - True If old value for was non null on primary node.
  - keepBinary
```
public void keepBinary(boolean keepBinary)
```
    Sets keep binary flag value.
    
    Parameters:
    
    keepBinary - Keep binary flag value.
  - keepBinary
```
public boolean keepBinary()
```
    Returns:
    
    Keep binary flag value.
  - addReader
```
public void addReader(boolean addReader)
```
    Parameters:
    
    addReader - Add reader flag.
  - addReader
```
public boolean addReader()
```
    Returns:
    
    Add reader flag.
  - txKey
```
public IgniteTxKey txKey()
```
    Returns:
    
    Tx key.
  - cached
```
public GridCacheEntryEx cached()
```
    Returns:
    
    Underlying cache entry.
  - cached
```
public void cached(GridCacheEntryEx entry)
```
    Parameters:
    
    entry - Cache entry.
  - value
```
@Nullable
public @Nullable CacheObject value()
```
    Returns:
    
    Entry value.
  - oldValue
```
@Nullable
public @Nullable CacheObject oldValue()
```
    Returns:
    
    Old value.
  - oldValue
```
public void oldValue(CacheObject oldVal)
```
    Parameters:
    
    oldVal - Old value.
  - hasOldValue
```
public boolean hasOldValue()
```
    Returns:
    
    True if old value present.
  - hasValue
```
public boolean hasValue()
```
    Returns:
    
    True if has value explicitly set.
  - hasWriteValue
```
public boolean hasWriteValue()
```
    Returns:
    
    True if has write value set.
  - hasReadValue
```
public boolean hasReadValue()
```
    Returns:
    
    True if has read value set.
  - previousValue
```
@Nullable
public @Nullable CacheObject previousValue()
```
    Returns:
    
    Value visible for peek.
  - hasPreviousValue
```
public boolean hasPreviousValue()
```
    Returns:
    
    True if has previous value explicitly set.
  - previousOperation
```
@Nullable
public @Nullable GridCacheOperation previousOperation()
```
    Returns:
    
    Previous operation to revert entry in case of filter failure.
  - ttl
```
public long ttl()
```
    Returns:
    
    Time to live.
  - ttl
```
public void ttl(long ttl)
```
    Parameters:
    
    ttl - Time to live.
  - conflictExpireTime
```
public long conflictExpireTime()
```
    Returns:
    
    Conflict expire time.
  - conflictExpireTime
```
public void conflictExpireTime(long conflictExpireTime)
```
    Parameters:
    
    conflictExpireTime - Conflict expire time.
  - value
```
public void value(@Nullable
                  @Nullable CacheObject val,
                  boolean writeVal,
                  boolean readVal)
```
    Parameters:
    
    val - Entry value.
    
    writeVal - Write value flag.
    
    readVal - Read value flag.
  - readValue
```
public void readValue(@Nullable
                      @Nullable CacheObject val)
```
    Sets read value if this tx entry does not have write value yet.
    
    Parameters:
    
    val - Read value to set.
  - addEntryProcessor
```
public void addEntryProcessor(javax.cache.processor.EntryProcessor<Object,Object,Object> entryProcessor,
                              Object[] invokeArgs)
```
    Parameters:
    
    entryProcessor - Entry processor.
    
    invokeArgs - Optional arguments for EntryProcessor.
  - entryProcessors
```
public Collection<T2<javax.cache.processor.EntryProcessor<Object,Object,Object>,Object[]>> entryProcessors()
```
    Returns:
    
    Collection of entry processors.
  - applyEntryProcessors
```
public CacheObject applyEntryProcessors(CacheObject cacheVal)
```
    Parameters:
    
    cacheVal - Value.
    
    Returns:
    
    New value.
  - entryProcessors
```
public void entryProcessors(@Nullable
                            @Nullable Collection<T2<javax.cache.processor.EntryProcessor<Object,Object,Object>,Object[]>> entryProcessorsCol)
```
    Parameters:
    
    entryProcessorsCol - Collection of entry processors.
  - op
```
public GridCacheOperation op()
```
    Returns:
    
    Cache operation.
  - op
```
public void op(GridCacheOperation op)
```
    Parameters:
    
    op - Cache operation.
  - isRead
```
public boolean isRead()
```
    Returns:
    
    True if read entry.
  - explicitVersion
```
public void explicitVersion(GridCacheVersion explicitVer)
```
    Parameters:
    
    explicitVer - Explicit version.
  - explicitVersion
```
public GridCacheVersion explicitVersion()
```
    Returns:
    
    Explicit version.
  - conflictVersion
```
@Nullable
public @Nullable GridCacheVersion conflictVersion()
```
    Returns:
    
    Conflict version.
  - conflictVersion
```
public void conflictVersion(@Nullable
                            @Nullable GridCacheVersion conflictVer)
```
    Parameters:
    
    conflictVer - Conflict version.
  - filters
```
public CacheEntryPredicate[] filters()
```
    Returns:
    
    Put filters.
  - filters
```
public void filters(CacheEntryPredicate[] filters)
```
    Parameters:
    
    filters - Put filters.
  - filtersPassed
```
public boolean filtersPassed()
```
    Returns:
    
    True if filters passed for fast-commit transactions.
  - filtersPassed
```
public void filtersPassed(boolean filtersPassed)
```
    Parameters:
    
    filtersPassed - True if filters passed for fast-commit transactions.
  - filtersSet
```
public boolean filtersSet()
```
    Returns:
    
    True if filters are set.
  - filtersSet
```
public void filtersSet(boolean filtersSet)
```
    Parameters:
    
    filtersSet - True if filters are set and should not be replaced.
  - marshal
```
public void marshal(GridCacheSharedContext<?,?> ctx,
                    boolean transferExpiry)
             throws IgniteCheckedException
```
    Parameters:
    
    ctx - Context.
    
    transferExpiry - True if expire policy should be marshalled.
    
    Throws:
    
    IgniteCheckedException - If failed.
  - unmarshal
```
public void unmarshal(GridCacheSharedContext<?,?> ctx,
                      boolean near,
                      ClassLoader clsLdr)
               throws IgniteCheckedException
```
    Unmarshalls entry.
    
    Parameters:
    
    ctx - Cache context.
    
    near - Near flag.
    
    clsLdr - Class loader.
    
    Throws:
    
    IgniteCheckedException - If un-marshalling failed.
  - expiry
```
public void expiry(@Nullable
                   @Nullable javax.cache.expiry.ExpiryPolicy expiryPlc)
```
    Parameters:
    
    expiryPlc - Expiry policy.
  - expiry
```
@Nullable
public @Nullable javax.cache.expiry.ExpiryPolicy expiry()
```
    Returns:
    
    Expiry policy.
  - entryProcessorCalculatedValue
```
public T2<GridCacheOperation,CacheObject> entryProcessorCalculatedValue()
```
    Returns:
    
    Entry processor calculated value.
  - entryProcessorCalculatedValue
```
public void entryProcessorCalculatedValue(T2<GridCacheOperation,CacheObject> entryProcessorCalcVal)
```
    Parameters:
    
    entryProcessorCalcVal - Entry processor calculated value.
  - entryReadVersion
```
@Nullable
public @Nullable GridCacheVersion entryReadVersion()
```
    Gets stored entry version. Version is stored for all entries in serializable transaction or when value is read using IgniteCache.getEntry(Object) method.
    
    Returns:
    
    Entry version.
  - entryReadVersion
```
public void entryReadVersion(GridCacheVersion ver)
```
    Parameters:
    
    ver - Entry version.
  - clearEntryReadVersion
```
public void clearEntryReadVersion()
```
    Clears recorded read version, should be done before starting commit of not serializable/optimistic transaction.
  - onAckReceived
```
public void onAckReceived()
```
    Method called when ack message received.
    
    Specified by:
    
    onAckReceived in interface Message
  - writeTo
```
public boolean writeTo(ByteBuffer buf,
                       MessageWriter writer)
```
    Writes this message to provided byte buffer.
    
    Specified by:
    
    writeTo in interface Message
    
    Parameters:
    
    buf - Byte buffer.
    
    writer - Writer.
    
    Returns:
    
    Whether message was fully written.
  - readFrom
```
public boolean readFrom(ByteBuffer buf,
                        MessageReader reader)
```
    Reads this message from provided byte buffer.
    
    Specified by:
    
    readFrom in interface Message
    
    Parameters:
    
    buf - Byte buffer.
    
    reader - Reader.
    
    Returns:
    
    Whether message was fully read.
  - directType
```
public short directType()
```
    Gets message type.
    
    Specified by:
    
    directType in interface Message
    
    Returns:
    
    Message type.
  - fieldsCount
```
public byte fieldsCount()
```
    Gets fields count.
    
    Specified by:
    
    fieldsCount in interface Message
    
    Returns:
    
    Fields count.
  - deployClass
```
public Class<?> deployClass()
```
    Gets top level user class being deployed.
    
    Specified by:
    
    deployClass in interface GridPeerDeployAware
    
    Returns:
    
    Top level user deployed class.
  - cqNotifyClosure
```
public GridAbsClosureX cqNotifyClosure()
```
  - cqNotifyClosure
```
public void cqNotifyClosure(GridAbsClosureX clo)
```
    Parameters:
    
    clo - Clo.
  - classLoader
```
public ClassLoader classLoader()
```
    Gets class loader for the class. This class loader must be able to load the class returned from GridPeerDeployAware.deployClass() as well as all of its dependencies.
    Note that in most cases the class loader returned from this method and the class loader for the class returned from GridPeerDeployAware.deployClass() method will be the same. If they are not the same, it is required that the class loader returned from this method still has to be able to load the deploy class and all its dependencies.
    
    Specified by:
    
    classLoader in interface GridPeerDeployAware
    
    Returns:
    
    Class loader for the class.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class IgniteTxEntry

Field Summary

Fields inherited from interface org.apache.ignite.plugin.extensions.communication.Message

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SER_READ_EMPTY_ENTRY_VER

SER_READ_NOT_EMPTY_VER

GET_ENTRY_INVALID_VER_UPDATED

GET_ENTRY_INVALID_VER_AFTER_GET

tx

Constructor Detail

IgniteTxEntry

IgniteTxEntry

IgniteTxEntry

Method Detail

context

context

locallyMapped

locallyMapped

cleanCopy

nodeId

nodeId

dhtVersion

dhtVersion

locked

markLocked

updateCounter

updateCounter

setAndMarkValid

markValid

key

cacheId

skipStore

skipStore

oldValueOnPrimary

keepBinary

keepBinary

addReader

addReader

txKey

cached

cached

value

oldValue

oldValue

hasOldValue

hasValue

hasWriteValue

hasReadValue

previousValue

hasPreviousValue

previousOperation

ttl

ttl

conflictExpireTime

conflictExpireTime

value

readValue

addEntryProcessor

entryProcessors

applyEntryProcessors

entryProcessors

op

op

isRead

explicitVersion

explicitVersion

conflictVersion

conflictVersion

filters

filters

filtersPassed

filtersPassed

filtersSet

filtersSet

marshal

unmarshal

expiry