org.apache.ignite.internal.processors.cache

Class GridCacheProcessor

java.lang.Object

org.apache.ignite.internal.processors.GridProcessorAdapter

org.apache.ignite.internal.processors.cache.GridCacheProcessor

All Implemented Interfaces:

GridComponent, GridProcessor

public class GridCacheProcessor
extends GridProcessorAdapter

Cache processor.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ignite.internal.GridComponent

GridComponent.DiscoveryDataExchangeType

Field Summary

Fields inherited from class org.apache.ignite.internal.processors.GridProcessorAdapter

ctx, log

Constructor Summary

Constructors

Constructor and Description
GridCacheProcessor(GridKernalContext ctx)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCacheConfiguration(CacheConfiguration cacheCfg)
<K,V> IgniteInternalCache<K,V>	atomicsCache() Gets utility cache for atomic data structures.
void	awaitStarted()
void	blockGateway(DynamicCacheChangeRequest req)
void	blockGateways() Blocks all available gateways
<K,V> IgniteInternalCache<K,V>	cache()
<K,V> IgniteInternalCache<K,V>	cache(String name)
CacheConfiguration	cacheConfiguration(String name) Get configuration for the given cache.
DynamicCacheDescriptor	cacheDescriptor(int cacheId)
Collection<DynamicCacheDescriptor>	cacheDescriptors()
CacheMode	cacheMode(String cacheName) Gets cache mode.
Collection<String>	cacheNames() Gets a collection of currently started caches.
Collection<IgniteInternalCache<?,?>>	caches()
<T> T	clone(T obj)
Serializable	collectDiscoveryData(UUID nodeId) Gets discovery data object that will be sent to new node during discovery process.
void	completeStartFuture(DynamicCacheChangeRequest req)
<K,V> GridCacheSharedContext<K,V>	context()
IgniteInternalFuture<?>	createFromTemplate(String cacheName) Dynamically starts cache using template configuration.
void	createMissingCaches() Starts client caches that do not exist yet.
GridComponent.DiscoveryDataExchangeType	discoveryDataType() Gets unique component type to distinguish components providing discovery data.
IgniteInternalFuture<?>	dynamicCloseCache(String cacheName)
IgniteInternalFuture<?>	dynamicDestroyCache(String cacheName, boolean checkThreadTx)
IgniteInternalFuture<?>	dynamicStartCache(CacheConfiguration ccfg, String cacheName, NearCacheConfiguration nearCfg, boolean failIfExists, boolean failIfNotStarted, boolean checkThreadTx) Dynamically starts cache.
IgniteInternalFuture<?>	dynamicStartCache(CacheConfiguration ccfg, String cacheName, NearCacheConfiguration nearCfg, CacheType cacheType, boolean failIfExists, boolean failIfNotStarted, boolean checkThreadTx) Dynamically starts cache.
IgniteInternalFuture<?>	getOrCreateFromTemplate(String cacheName, boolean checkThreadTx) Dynamically starts cache using template configuration.
<K,V> IgniteInternalCache<K,V>	getOrStartCache(String name)
IgniteCacheProxy<?,?>	getOrStartPublicCache(boolean start, boolean inclLoc) Gets public cache that can be used for query execution.
<K,V> GridCacheAdapter<K,V>	internalCache()
<K,V> GridCacheAdapter<K,V>	internalCache(String name)
Collection<GridCacheAdapter<?,?>>	internalCaches()
<K,V> IgniteCacheProxy<K,V>	jcache(String name)
Collection<IgniteCacheProxy<?,?>>	jcaches()
long	lastDataVersion()
GridCacheAdapter<Integer,String>	marshallerCache()
boolean	onCustomEvent(DiscoveryCustomMessage msg, AffinityTopologyVersion topVer) Callback invoked from discovery thread when discovery custom message is received.
void	onDisconnected(IgniteFuture<?> reconnectFut) Client disconnected callback.
void	onDiscoveryDataReceived(UUID joiningNodeId, UUID rmtNodeId, Serializable data) Receives discovery data object from remote nodes (called on new node during discovery process).
void	onDiscoveryEvent(int type, ClusterNode node, AffinityTopologyVersion topVer)
void	onEvictFromSwap(String spaceName, byte[] keyBytes, byte[] valBytes)
void	onExchangeDone(AffinityTopologyVersion topVer, Collection<DynamicCacheChangeRequest> reqs, Throwable err) Callback invoked when first exchange future for dynamic cache is completed.
void	onKernalStart() Callback that notifies that kernal has successfully started, including all managers and processors.
void	onKernalStop(boolean cancel) Callback to notify that kernal is about to stop.
IgniteInternalFuture<?>	onReconnected(boolean clusterRestarted) Client reconnected callback.
void	onUndeployed(ClassLoader ldr) Callback invoked by deployment manager for whenever a class loader gets undeployed.
void	prepareCacheStart(DynamicCacheChangeRequest req, AffinityTopologyVersion topVer)
void	prepareCacheStop(DynamicCacheChangeRequest req)
void	printMemoryStats() Prints memory statistics (sizes of internal structures, etc.).
<K,V> IgniteInternalCache<K,V>	publicCache(String name)
Collection<String>	publicCacheNames() Gets a collection of currently started public cache names.
Collection<IgniteCacheProxy<?,?>>	publicCaches()
<K,V> IgniteCacheProxy<K,V>	publicJCache(String cacheName)
<K,V> IgniteCacheProxy<K,V>	publicJCache(String cacheName, boolean failIfNotStarted, boolean checkThreadTx)
void	start() Starts grid component.
Collection<DynamicCacheDescriptor>	startReceivedCaches(AffinityTopologyVersion topVer) Starts statically configured caches received from remote nodes during exchange.
void	stop(boolean cancel) Stops grid component.
boolean	systemCache(String name)
IgniteTransactionsEx	transactions()
<K,V> IgniteInternalCache<K,V>	utilityCache() Gets utility cache.
IgniteNodeValidationResult	validateNode(ClusterNode node) Validates that new node can join grid topology, this method is called on coordinator node before new node joins topology.

Methods inherited from class org.apache.ignite.internal.processors.GridProcessorAdapter

assertParameter, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GridCacheProcessor

public GridCacheProcessor(GridKernalContext ctx)

Parameters:

ctx - Kernal context.

Method Detail

start

public void start()
           throws IgniteCheckedException

Starts grid component.

Specified by:

start in interface GridComponent

Overrides:

start in class GridProcessorAdapter

Throws:

IgniteCheckedException - Throws in case of any errors.

onKernalStart

public void onKernalStart()
                   throws IgniteCheckedException

Callback that notifies that kernal has successfully started, including all managers and processors.

Specified by:

onKernalStart in interface GridComponent

Overrides:

onKernalStart in class GridProcessorAdapter

Throws:

IgniteCheckedException - Thrown in case of any errors.

stop

public void stop(boolean cancel)
          throws IgniteCheckedException

Stops grid component.

Specified by:

stop in interface GridComponent

Overrides:

stop in class GridProcessorAdapter

Parameters:

cancel - If true, then all ongoing tasks or jobs for relevant components need to be cancelled.

Throws:

IgniteCheckedException - Thrown in case of any errors.

blockGateways

public void blockGateways()

Blocks all available gateways

onKernalStop

public void onKernalStop(boolean cancel)

Callback to notify that kernal is about to stop.

Specified by:

onKernalStop in interface GridComponent

Overrides:

onKernalStop in class GridProcessorAdapter

Parameters:

cancel - Flag indicating whether jobs should be canceled.

onDisconnected

public void onDisconnected(IgniteFuture<?> reconnectFut)
                    throws IgniteCheckedException

Client disconnected callback.

Specified by:

onDisconnected in interface GridComponent

Overrides:

onDisconnected in class GridProcessorAdapter

Parameters:

reconnectFut - Reconnect future.

Throws:

IgniteCheckedException - If failed.

onReconnected

public IgniteInternalFuture<?> onReconnected(boolean clusterRestarted)
                                      throws IgniteCheckedException

Client reconnected callback.

Specified by:

onReconnected in interface GridComponent

Overrides:

onReconnected in class GridProcessorAdapter

Parameters:

clusterRestarted - Cluster restarted flag.

Returns:

Future to wait before completing reconnect future.

Throws:

IgniteCheckedException - If failed.

awaitStarted

public void awaitStarted()
                  throws IgniteCheckedException

Throws:

IgniteCheckedException - If failed to wait.

cacheNames

public Collection<String> cacheNames()

Gets a collection of currently started caches.

Returns:

Collection of started cache names.

getOrStartPublicCache

public IgniteCacheProxy<?,?> getOrStartPublicCache(boolean start,
                                          boolean inclLoc)
                                            throws IgniteCheckedException

Gets public cache that can be used for query execution. If cache isn't created on current node it will be started.

Parameters:

start - Start cache.

inclLoc - Include local caches.

Returns:

Cache or null if there is no suitable cache.

Throws:

IgniteCheckedException

publicCacheNames

public Collection<String> publicCacheNames()

Gets a collection of currently started public cache names.

Returns:

Collection of currently started public cache names

cacheMode

public CacheMode cacheMode(String cacheName)

Gets cache mode.

Parameters:

cacheName - Cache name to check.

Returns:

Cache mode.

prepareCacheStart

public void prepareCacheStart(DynamicCacheChangeRequest req,
                     AffinityTopologyVersion topVer)
                       throws IgniteCheckedException

Parameters:

req - Cache start request.

topVer - Topology version.

Throws:

IgniteCheckedException - If failed.

startReceivedCaches

public Collection<DynamicCacheDescriptor> startReceivedCaches(AffinityTopologyVersion topVer)
                                                       throws IgniteCheckedException

Starts statically configured caches received from remote nodes during exchange.

Parameters:

topVer - Topology version.

Returns:

Started caches descriptors.

Throws:

IgniteCheckedException - If failed.

blockGateway

public void blockGateway(DynamicCacheChangeRequest req)

Parameters:

req - Stop request.

prepareCacheStop

public void prepareCacheStop(DynamicCacheChangeRequest req)

Parameters:

req - Stop request.

onExchangeDone

public void onExchangeDone(AffinityTopologyVersion topVer,
                  Collection<DynamicCacheChangeRequest> reqs,
                  Throwable err)

Callback invoked when first exchange future for dynamic cache is completed.

Parameters:

topVer - Completed topology version.

reqs - Change requests.

err - Error.

completeStartFuture

public void completeStartFuture(DynamicCacheChangeRequest req)

Parameters:

req - Request to complete future for.

discoveryDataType

@Nullable
public GridComponent.DiscoveryDataExchangeType discoveryDataType()

Gets unique component type to distinguish components providing discovery data. Must return non-null value if component implements method GridComponent.collectDiscoveryData(UUID).

Specified by:

discoveryDataType in interface GridComponent

Overrides:

discoveryDataType in class GridProcessorAdapter

Returns:

Unique component type for discovery data exchange.

collectDiscoveryData

@Nullable
public Serializable collectDiscoveryData(UUID nodeId)

Gets discovery data object that will be sent to new node during discovery process.

Specified by:

collectDiscoveryData in interface GridComponent

Overrides:

collectDiscoveryData in class GridProcessorAdapter

Parameters:

nodeId - ID of new node that joins topology.

Returns:

Discovery data object or null if there is nothing to send for this component.

onDiscoveryDataReceived

public void onDiscoveryDataReceived(UUID joiningNodeId,
                           UUID rmtNodeId,
                           Serializable data)

Receives discovery data object from remote nodes (called on new node during discovery process).

Specified by:

onDiscoveryDataReceived in interface GridComponent

Overrides:

onDiscoveryDataReceived in class GridProcessorAdapter

Parameters:

joiningNodeId - Joining node ID.

rmtNodeId - Remote node ID for which data is provided.

data - Discovery data object or null if nothing was

createFromTemplate

public IgniteInternalFuture<?> createFromTemplate(String cacheName)

Dynamically starts cache using template configuration.

Parameters:

cacheName - Cache name.

Returns:

Future that will be completed when cache is deployed.

getOrCreateFromTemplate

public IgniteInternalFuture<?> getOrCreateFromTemplate(String cacheName,
                                              boolean checkThreadTx)

Dynamically starts cache using template configuration.

Parameters:

cacheName - Cache name.

checkThreadTx - If true checks that current thread does not have active transactions.

Returns:

Future that will be completed when cache is deployed.

dynamicStartCache

public IgniteInternalFuture<?> dynamicStartCache(@Nullable
                                        CacheConfiguration ccfg,
                                        String cacheName,
                                        @Nullable
                                        NearCacheConfiguration nearCfg,
                                        boolean failIfExists,
                                        boolean failIfNotStarted,
                                        boolean checkThreadTx)

Dynamically starts cache.

Parameters:

ccfg - Cache configuration.

cacheName - Cache name.

nearCfg - Near cache configuration.

failIfExists - Fail if exists flag.

failIfNotStarted - If true fails if cache is not started.

checkThreadTx - If true checks that current thread does not have active transactions.

Returns:

Future that will be completed when cache is deployed.

dynamicStartCache

public IgniteInternalFuture<?> dynamicStartCache(@Nullable
                                        CacheConfiguration ccfg,
                                        String cacheName,
                                        @Nullable
                                        NearCacheConfiguration nearCfg,
                                        CacheType cacheType,
                                        boolean failIfExists,
                                        boolean failIfNotStarted,
                                        boolean checkThreadTx)

Dynamically starts cache.

Parameters:

ccfg - Cache configuration.

cacheName - Cache name.

nearCfg - Near cache configuration.

cacheType - Cache type.

failIfExists - Fail if exists flag.

failIfNotStarted - If true fails if cache is not started.

checkThreadTx - If true checks that current thread does not have active transactions.

Returns:

Future that will be completed when cache is deployed.

dynamicDestroyCache

public IgniteInternalFuture<?> dynamicDestroyCache(String cacheName,
                                          boolean checkThreadTx)

Parameters:

cacheName - Cache name to destroy.

checkThreadTx - If true checks that current thread does not have active transactions.

Returns:

Future that will be completed when cache is destroyed.

dynamicCloseCache

public IgniteInternalFuture<?> dynamicCloseCache(String cacheName)

Parameters:

cacheName - Cache name to close.

Returns:

Future that will be completed when cache is closed.

onDiscoveryEvent

public void onDiscoveryEvent(int type,
                    ClusterNode node,
                    AffinityTopologyVersion topVer)

Parameters:

type - Event type.

node - Event node.

topVer - Topology version.

onCustomEvent

public boolean onCustomEvent(DiscoveryCustomMessage msg,
                    AffinityTopologyVersion topVer)

Callback invoked from discovery thread when discovery custom message is received.

Parameters:

msg - Customer message.

topVer - Current topology version.

Returns:

True if minor topology version should be increased.

validateNode

@Nullable
public IgniteNodeValidationResult validateNode(ClusterNode node)

Validates that new node can join grid topology, this method is called on coordinator node before new node joins topology.

Specified by:

validateNode in interface GridComponent

Overrides:

validateNode in class GridProcessorAdapter

Parameters:

node - Joining node.

Returns:

Validation result or null in case of success.

onEvictFromSwap

public void onEvictFromSwap(String spaceName,
                   byte[] keyBytes,
                   byte[] valBytes)

Parameters:

spaceName - Space name.

keyBytes - Key bytes.

valBytes - Value bytes.

lastDataVersion

public long lastDataVersion()

Returns:

Last data version.

cache

public <K,V> IgniteInternalCache<K,V> cache()

Type Parameters:

K - type of keys.

V - type of values.

Returns:

Default cache.

cache

public <K,V> IgniteInternalCache<K,V> cache(@Nullable
                                   String name)

Type Parameters:

K - type of keys.

V - type of values.

Parameters:

name - Cache name.

Returns:

Cache instance for given name.

getOrStartCache

public <K,V> IgniteInternalCache<K,V> getOrStartCache(@Nullable
                                             String name)
                                         throws IgniteCheckedException

Parameters:

name - Cache name.

Returns:

Cache instance for given name.

Throws:

IgniteCheckedException - If failed.

caches

public Collection<IgniteInternalCache<?,?>> caches()

Returns:

All configured cache instances.

jcaches

public Collection<IgniteCacheProxy<?,?>> jcaches()

Returns:

All configured cache instances.

marshallerCache

public GridCacheAdapter<Integer,String> marshallerCache()

Returns:

Marshaller system cache.

utilityCache

public <K,V> IgniteInternalCache<K,V> utilityCache()

Gets utility cache.

Returns:

Utility cache.

atomicsCache

public <K,V> IgniteInternalCache<K,V> atomicsCache()

Gets utility cache for atomic data structures.

Returns:

Utility cache for atomic data structures.

publicCache

public <K,V> IgniteInternalCache<K,V> publicCache(@Nullable
                                         String name)

Type Parameters:

K - type of keys.

V - type of values.

Parameters:

name - Cache name.

Returns:

Cache instance for given name.

publicJCache

public <K,V> IgniteCacheProxy<K,V> publicJCache(@Nullable
                                       String cacheName)
                                   throws IgniteCheckedException

Type Parameters:

K - type of keys.

V - type of values.

Parameters:

cacheName - Cache name.

Returns:

Cache instance for given name.

Throws:

IgniteCheckedException - If failed.

publicJCache

@Nullable
public <K,V> IgniteCacheProxy<K,V> publicJCache(@Nullable
                                                String cacheName,
                                                boolean failIfNotStarted,
                                                boolean checkThreadTx)
                                   throws IgniteCheckedException

Parameters:

cacheName - Cache name.

failIfNotStarted - If true throws IllegalArgumentException if cache is not started, otherwise returns null in this case.

checkThreadTx - If true checks that current thread does not have active transactions.

Returns:

Cache instance for given name.

Throws:

IgniteCheckedException - If failed.

cacheConfiguration

public CacheConfiguration cacheConfiguration(String name)

Get configuration for the given cache.

Parameters:

name - Cache name.

Returns:

Cache configuration.

cacheDescriptors

public Collection<DynamicCacheDescriptor> cacheDescriptors()

Returns:

Cache descriptors.

cacheDescriptor

@Nullable
public DynamicCacheDescriptor cacheDescriptor(int cacheId)

Parameters:

cacheId - Cache ID.

Returns:

Cache descriptor.

addCacheConfiguration

public void addCacheConfiguration(CacheConfiguration cacheCfg)
                           throws IgniteCheckedException

Parameters:

cacheCfg - Cache configuration template.

Throws:

IgniteCheckedException - If failed.

jcache

public <K,V> IgniteCacheProxy<K,V> jcache(@Nullable
                                 String name)

Parameters:

name - Cache name.

Returns:

Cache instance for given name.

publicCaches

public Collection<IgniteCacheProxy<?,?>> publicCaches()

Returns:

All configured public cache instances.

internalCache

public <K,V> GridCacheAdapter<K,V> internalCache()

Type Parameters:

K - type of keys.

V - type of values.

Returns:

Default cache.

internalCache

public <K,V> GridCacheAdapter<K,V> internalCache(@Nullable
                                        String name)

Type Parameters:

K - type of keys.

V - type of values.

Parameters:

name - Cache name.

Returns:

Cache instance for given name.

internalCaches

public Collection<GridCacheAdapter<?,?>> internalCaches()

Returns:

All internal cache instances.

systemCache

public boolean systemCache(@Nullable
                  String name)

Parameters:

name - Cache name.

Returns:

True if specified cache is system, false otherwise.

printMemoryStats

public void printMemoryStats()

Prints memory statistics (sizes of internal structures, etc.). NOTE: this method is for testing and profiling purposes only.

Specified by:

printMemoryStats in interface GridComponent

Overrides:

printMemoryStats in class GridProcessorAdapter

onUndeployed

public void onUndeployed(ClassLoader ldr)

Callback invoked by deployment manager for whenever a class loader gets undeployed.

Parameters:

ldr - Class loader.

context

public <K,V> GridCacheSharedContext<K,V> context()

Returns:

Shared context.

transactions

public IgniteTransactionsEx transactions()

Returns:

Transactions interface implementation.

createMissingCaches

public void createMissingCaches()
                         throws IgniteCheckedException

Starts client caches that do not exist yet.

Throws:

IgniteCheckedException - In case of error.

clone

public <T> T clone(T obj)
        throws IgniteCheckedException

Parameters:

obj - Object to clone.

Returns:

Object copy.

Throws:

IgniteCheckedException - If failed.