org.gridgain.grid.kernal.processors.cache

Class GridCacheTxProxyImpl<K,V>

java.lang.Object

org.gridgain.grid.kernal.processors.cache.GridCacheTxProxyImpl<K,V>

All Implemented Interfaces:

Externalizable, Serializable, AutoCloseable, GridCacheTx, GridMetadataAware, GridCacheTxProxy

public class GridCacheTxProxyImpl<K,V>
extends Object
implements GridCacheTxProxy, Externalizable

Cache transaction proxy.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridCacheTxProxyImpl() Empty constructor required for Externalizable.
GridCacheTxProxyImpl(GridCacheTx tx, GridCacheAdapter<K,V> cache, GridCacheGateway gate)

Method Summary

Methods

Modifier and Type	Method and Description
<V> V	addMeta(String name, V val) Adds a new metadata.
<V> V	addMetaIfAbsent(String name, Callable<V> c) Adds given metadata value only if it was absent.
<V> V	addMetaIfAbsent(String name, V val) Adds given metadata value only if it was absent.
<V> Map<String,V>	allMeta() Gets all metadata in this entry.
void	close() Ends the transaction.
void	commit() Commits this transaction by initiating two-phase-commit process.
GridFuture<GridCacheTx>	commitAsync() Asynchronously commits this transaction by initiating two-phase-commit process.
GridCacheTxConcurrency	concurrency() Cache transaction concurrency mode.
void	copyMeta(GridMetadataAware from) Copies all metadata from another instance.
void	copyMeta(Map<String,?> data) Copies all metadata from given map.
boolean	hasMeta(String name) Tests whether or not given metadata is set.
<V> boolean	hasMeta(String name, V val) Tests whether or not metadata with given name and value is set.
boolean	implicit() Flag indicating whether transaction was started automatically by the system or not.
boolean	isInvalidate() Get invalidation flag for this transaction.
GridCacheTxIsolation	isolation() Cache transaction isolation level.
boolean	isRollbackOnly() If transaction was marked as rollback-only.
<V> V	meta(String name) Gets metadata by name.
UUID	nodeId() ID of the node on which this transaction started.
<V> V	putMetaIfAbsent(String name, Callable<V> c) Adds given metadata value only if it was absent.
<V> V	putMetaIfAbsent(String name, V val) Adds given metadata value only if it was absent.
void	readExternal(ObjectInput in)
<V> V	removeMeta(String name) Removes metadata by name.
<V> boolean	removeMeta(String name, V val) Removes metadata only if its current value is equal to val passed in.
<V> boolean	replaceMeta(String name, V curVal, V newVal) Replaces given metadata with new newVal value only if its current value is equal to curVal.
void	rollback() Rolls back this transaction.
boolean	setRollbackOnly() Modify the transaction associated with the current thread such that the only possible outcome of the transaction is to roll back the transaction.
long	startTime() Start time of this transaction.
GridCacheTxState	state() Gets current transaction state value.
long	threadId() ID of the thread in which this transaction started.
long	timeout() Gets timeout value in milliseconds for this transaction.
long	timeout(long timeout) Sets transaction timeout value.
String	toString()
void	writeExternal(ObjectOutput out)
GridUuid	xid() Gets unique identifier for this transaction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GridCacheTxProxyImpl

public GridCacheTxProxyImpl()

Empty constructor required for Externalizable.

GridCacheTxProxyImpl

public GridCacheTxProxyImpl(GridCacheTx tx,
                    GridCacheAdapter<K,V> cache,
                    GridCacheGateway gate)

Parameters:

tx - Transaction.

gate - Gateway.

Method Detail

xid

public GridUuid xid()

Gets unique identifier for this transaction.

Specified by:

xid in interface GridCacheTx

Returns:

Transaction UID.

nodeId

public UUID nodeId()

ID of the node on which this transaction started.

Specified by:

nodeId in interface GridCacheTx

Returns:

Originating node ID.

threadId

public long threadId()

ID of the thread in which this transaction started.

Specified by:

threadId in interface GridCacheTx

Returns:

Thread ID.

startTime

public long startTime()

Start time of this transaction.

Specified by:

startTime in interface GridCacheTx

Returns:

Start time of this transaction on this node.

isolation

public GridCacheTxIsolation isolation()

Cache transaction isolation level.

Specified by:

isolation in interface GridCacheTx

Returns:

Isolation level.

concurrency

public GridCacheTxConcurrency concurrency()

Cache transaction concurrency mode.

Specified by:

concurrency in interface GridCacheTx

Returns:

Concurrency mode.

isInvalidate

public boolean isInvalidate()

Get invalidation flag for this transaction. If set to true, then remote values will be invalidated (set to null) instead of updated.

Invalidation messages don't carry new values, so they are a lot lighter than update messages. However, when a value is accessed on a node after it's been invalidated, it must be loaded from persistent store.

Specified by:

isInvalidate in interface GridCacheTx

Returns:

Invalidation flag.

implicit

public boolean implicit()

Flag indicating whether transaction was started automatically by the system or not. System will start transactions implicitly whenever any cache put(..) or remove(..) operation is invoked outside of transaction.

Specified by:

implicit in interface GridCacheTx

Returns:

True if transaction was started implicitly.

timeout

public long timeout()

Gets timeout value in milliseconds for this transaction. If transaction times out prior to it's completion, GridCacheTxTimeoutException will be thrown.

Specified by:

timeout in interface GridCacheTx

Returns:

Transaction timeout value.

state

public GridCacheTxState state()

Gets current transaction state value.

Specified by:

state in interface GridCacheTx

Returns:

Current transaction state.

timeout

public long timeout(long timeout)

Sets transaction timeout value. This value can be set only before a first operation on transaction has been performed.

Specified by:

timeout in interface GridCacheTx

Parameters:

timeout - Transaction timeout value.

Returns:

Previous timeout.

setRollbackOnly

public boolean setRollbackOnly()

Modify the transaction associated with the current thread such that the only possible outcome of the transaction is to roll back the transaction.

Specified by:

setRollbackOnly in interface GridCacheTx

Returns:

True if rollback-only flag was set as a result of this operation, false if it was already set prior to this call or could not be set because transaction is already finishing up committing or rolling back.

isRollbackOnly

public boolean isRollbackOnly()

If transaction was marked as rollback-only.

Specified by:

isRollbackOnly in interface GridCacheTx

Returns:

True if transaction can only be rolled back.

commit

public void commit()
            throws GridException

Commits this transaction by initiating two-phase-commit process.

Specified by:

commit in interface GridCacheTx

Throws:

GridException - If commit failed.

close

public void close()
           throws GridException

Ends the transaction. Transaction will be rolled back if it has not been committed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface GridCacheTx

Throws:

GridException - If transaction could not be gracefully ended.

commitAsync

public GridFuture<GridCacheTx> commitAsync()

Asynchronously commits this transaction by initiating two-phase-commit process.

Specified by:

commitAsync in interface GridCacheTx

Returns:

Future for commit operation.

rollback

public void rollback()
              throws GridException

Rolls back this transaction.

Specified by:

rollback in interface GridCacheTx

Throws:

GridException - If rollback failed.

copyMeta

public void copyMeta(GridMetadataAware from)

Copies all metadata from another instance.

Specified by:

copyMeta in interface GridMetadataAware

Parameters:

from - Metadata aware instance to copy metadata from.

copyMeta

public void copyMeta(Map<String,?> data)

Copies all metadata from given map.

Specified by:

copyMeta in interface GridMetadataAware

Parameters:

data - Map to copy metadata from.

addMeta

public <V> V addMeta(String name,
            V val)

Adds a new metadata.

Specified by:

addMeta in interface GridMetadataAware

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

val - Metadata value.

Returns:

Metadata previously associated with given name, or null if there was none.

putMetaIfAbsent

public <V> V putMetaIfAbsent(String name,
                    V val)

Adds given metadata value only if it was absent.

Specified by:

putMetaIfAbsent in interface GridMetadataAware

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

val - Value to add if it's not attached already.

Returns:

null if new value was put, or current value if put didn't happen.

putMetaIfAbsent

public <V> V putMetaIfAbsent(String name,
                    Callable<V> c)

Adds given metadata value only if it was absent.

Specified by:

putMetaIfAbsent in interface GridMetadataAware

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

c - Factory closure to produce value to add if it's not attached already. Not that unlike GridMetadataAware.addMeta(String, Object) method the factory closure will not be called unless the value is required and therefore value will only be created when it is actually needed.

Returns:

null if new value was put, or current value if put didn't happen.

addMetaIfAbsent

@Nullable
public <V> V addMetaIfAbsent(String name,
                             V val)

Adds given metadata value only if it was absent. Unlike GridMetadataAware.putMetaIfAbsent(String, Callable), this method always returns the latest value and never previous one.

Specified by:

addMetaIfAbsent in interface GridMetadataAware

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

val - Value to add if it's not attached already.

Returns:

The value of the metadata after execution of this method.

addMetaIfAbsent

public <V> V addMetaIfAbsent(String name,
                    @Nullable
                    Callable<V> c)

Adds given metadata value only if it was absent.

Specified by:

addMetaIfAbsent in interface GridMetadataAware

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

c - Factory closure to produce value to add if it's not attached already. Not that unlike GridMetadataAware.addMeta(String, Object) method the factory closure will not be called unless the value is required and therefore value will only be created when it is actually needed. If null and metadata value is missing - null will be returned from this method.

Returns:

The value of the metadata after execution of this method.

meta

public <V> V meta(String name)

Gets metadata by name.

Specified by:

meta in interface GridMetadataAware

Type Parameters:

V - Type of the value.

Parameters:

name - Metadata name.

Returns:

Metadata value or null.

removeMeta

public <V> V removeMeta(String name)

Removes metadata by name.

Specified by:

removeMeta in interface GridMetadataAware

Type Parameters:

V - Type of the value.

Parameters:

name - Name of the metadata to remove.

Returns:

Value of removed metadata or null.

removeMeta

public <V> boolean removeMeta(String name,
                     V val)

Removes metadata only if its current value is equal to val passed in.

Specified by:

removeMeta in interface GridMetadataAware

Type Parameters:

V - Value type.

Parameters:

name - Name of metadata attribute.

val - Value to compare.

Returns:

True if value was removed, false otherwise.

allMeta

public <V> Map<String,V> allMeta()

Gets all metadata in this entry.

Specified by:

allMeta in interface GridMetadataAware

Type Parameters:

V - Type of the value.

Returns:

All metadata in this entry.

hasMeta

public boolean hasMeta(String name)

Tests whether or not given metadata is set.

Specified by:

hasMeta in interface GridMetadataAware

Parameters:

name - Name of the metadata to test.

Returns:

Whether or not given metadata is set.

hasMeta

public <V> boolean hasMeta(String name,
                  V val)

Tests whether or not metadata with given name and value is set. Returns true if attachment with given name it set and its value is equals to provided value. Otherwise returns false.

Specified by:

hasMeta in interface GridMetadataAware

Type Parameters:

V - Type of the value.

Parameters:

name - Name of the metadata.

val - Value to compare. Cannot be null.

Returns:

true if metadata with given name is set and its value is equals to provided value - otherwise returns false.

replaceMeta

public <V> boolean replaceMeta(String name,
                      V curVal,
                      V newVal)

Replaces given metadata with new newVal value only if its current value is equal to curVal. Otherwise, it is no-op.

Specified by:

replaceMeta in interface GridMetadataAware

Parameters:

name - Name of the metadata.

curVal - Current value to check.

newVal - New value.

Returns:

true if replacement occurred, false otherwise.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

toString

public String toString()

Overrides:

toString in class Object