org.gridgain.grid.kernal

Class GridKernal

java.lang.Object

org.gridgain.grid.util.lang.GridMetadataAwareAdapter

org.gridgain.grid.kernal.GridProjectionAdapter

org.gridgain.grid.kernal.GridKernal

All Implemented Interfaces:

Externalizable, Serializable, AutoCloseable, Grid, GridKernalMBean, GridMetadataAware, GridProjection, GridEx, GridProjectionEx

public class GridKernal
extends GridProjectionAdapter
implements GridEx, GridKernalMBean

GridGain kernal.

See http://en.wikipedia.org/wiki/Kernal for information on the misspelling.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.gridgain.grid.kernal.GridProjectionAdapter

ctx

Constructor Summary

Constructors

Constructor and Description
GridKernal() No-arg constructor is required by externalization.
GridKernal(GridSpringResourceContext rsrcCtx)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allEventsUserRecordable(int[] types) Checks whether all provided events are user-recordable.
<K,V> GridCache<K,V>	cache(String name) Gets the cache instance for the given name, if one does not exist IllegalArgumentException will be thrown.
Collection<GridCache<?,?>>	caches() Gets all configured caches.
Collection<GridCache<?,?>>	cachesx(GridPredicate<? super GridCache<?,?>>[] p) Gets configured cache instance that satisfy all provided predicates including non-public caches.
<K,V> GridCache<K,V>	cachex() Gets default cache instance if one is configured or null otherwise returning even non-public caches.
<K,V> GridCache<K,V>	cachex(String name) Gets the cache instance for the given name if one is configured or null otherwise returning even non-public caches.
void	close() Closes this instance of grid.
Collection<String>	compatibleVersions() Gets list of compatible versions.
GridConfiguration	configuration() Gets the configuration of this grid instance.
GridKernalContext	context() It's intended for use by internal marshalling implementation only.
<K,V> GridDataLoader<K,V>	dataLoader(String cacheName) Gets a new instance of data loader associated with given cache name.
GridDr	dr() Gets an instance of Data Center Replication.
ExecutorService	drPool() Get DR pool.
boolean	eventUserRecordable(int type) Checks if the event type is user-recordable.
String	executeTask(String taskName, String arg) A shortcut method that executes given task assuming single java.lang.String argument and java.lang.String return type.
GridProjection	forLocal() Gets monadic projection consisting from the local node.
String	getAuthenticationSpiFormatted() Gets a formatted instance of fully configured authentication SPI implementation.
String	getCheckpointSpiFormatted() Gets a formatted instance of configured checkpoint SPI implementation.
String	getCollisionSpiFormatted() Gets a formatted instance of configured collision SPI implementations.
String	getCommunicationSpiFormatted() Gets a formatted instance of fully configured SPI communication implementation.
String	getCopyright() Gets copyright statement for GridGain product.
String	getDeploymentSpiFormatted() Gets a formatted instance of fully configured deployment SPI implementation.
String	getDiscoverySpiFormatted() Gets a formatted instance of configured discovery SPI implementation.
String	getEventStorageSpiFormatted() Gets a formatted instance of fully configured event SPI implementation.
String	getExecutorServiceFormatted() Gets a formatted instance of fully configured thread pool that is used in grid.
String	getFailoverSpiFormatted() Gets a formatted instance of fully configured failover SPI implementations.
String	getFullVersion() Gets string presentation of the version.
String	getGridGainHome() Gets GridGain installation home folder.
String	getGridLoggerFormatted() Gets a formatted instance of logger that is in grid.
String	getInstanceName() Gets optional kernal instance name.
String	getJdkInformation() Gets JDK information.
String	getLicenseFilePath() Gets file path of the license.
Collection<String>	getLifecycleBeansFormatted() Gets toString() representation of of lifecycle beans configured with GridGain.
String	getLoadBalancingSpiFormatted() Gets a formatted instance of fully configured load balancing SPI implementations.
UUID	getLocalNodeId() Unique identifier for this node within grid.
String	getMBeanServerFormatted() Gets a formatted instance of MBean server instance.
String	getOsInformation() Gets OS information.
String	getOsUser() Gets OS user.
String	getSecureSessionSpiFormatted() Gets a formatted instance of fully configured secure session SPI implementation.
long	getStartTimestamp() Get start timestamp of the kernal.
String	getStartTimestampFormatted() Gets string presentation of the kernal start timestamp.
String	getSwapSpaceSpiFormatted() Gets a formatted instance of configured swapspace SPI implementations.
long	getUpTime() Gets up-time of the kernal.
String	getUpTimeFormatted() Gets string presentation of up-time for the kernal.
Collection<String>	getUserAttributesFormatted() Gets a collection of formatted user-defined attributes added to this node.
String	getVmName() Gets VM name.
GridGgfs	ggfs(String name) Gets an instance of GGFS - GridGain In-Memory File System, if one is not configured then IllegalArgumentException will be thrown.
Collection<GridGgfs>	ggfss() Gets all instances of the grid file systems.
<K,V> GridCacheAdapter<K,V>	internalCache() USED ONLY FOR TESTING.
<K,V> GridCacheAdapter<K,V>	internalCache(String name) USED ONLY FOR TESTING.
boolean	isJmxRemoteEnabled() Whether or not remote JMX management is enabled for this node.
boolean	isPeerClassLoadingEnabled() Returns true if peer class loading is enabled, false otherwise.
boolean	isRestartEnabled() Whether or not node restart is enabled.
boolean	isSmtpEnabled() Whether or not SMTP is configured.
long	licenseGracePeriodLeft()
GridNode	localNode() Gets local grid node.
GridLogger	log() Gets grid's logger.
<K> Map<GridNode,Collection<K>>	mapKeysToNodes(String cacheName, Collection<? extends K> keys) This method provides ability to detect which cache keys are mapped to which nodes on cache instance with given name.
<K> GridNode	mapKeyToNode(String cacheName, K key) This method provides ability to detect which cache keys are mapped to which nodes on cache instance with given name.
String	name() Gets the name of the grid this grid instance (and correspondingly its local node) belongs to.
<K,V> GridNodeLocalMap<K,V>	nodeLocalMap() Gets node-local storage instance.
boolean	pingNode(String nodeId) Pings node with given node ID to see whether it is alive.
boolean	pingNode(UUID nodeId) Pings a remote node.
boolean	pingNodeByAddress(String host) Pings node with given host name to see if it is alive.
GridProduct	product() Gets information about product as well as license management capabilities.
boolean	removeCheckpoint(String key) This method allows manually remove the checkpoint with given key.
void	resetMetrics() Resets local I/O, job, and task execution metrics.
void	restartNodes() Restarts nodes satisfying optional set of predicates.
void	restartNodes(Collection<UUID> ids) Restarts nodes defined by provided IDs.
GridScheduler	scheduler() Gets an instance of cron-based scheduler.
GridSecurity	security() Gets an instance of GridSecurity interface.
GridFuture<Boolean>	sendAdminEmailAsync(String subj, String body, boolean html) Schedule sending of given email to all configured admin emails.
void	start(GridConfiguration cfg, ExecutorService drPool, GridAbsClosure errHnd)
GridFuture<Collection<GridTuple3<String,Boolean,String>>>	startNodes(Collection<Map<String,Object>> hosts, Map<String,Object> dflts, boolean restart, int timeout, int maxConn) Starts one or more nodes on remote host(s).
GridFuture<Collection<GridTuple3<String,Boolean,String>>>	startNodes(File file, boolean restart, int timeout, int maxConn) Starts one or more nodes on remote host(s).
void	stop(boolean cancel) Stops grid instance.
void	stopNodes() Stops nodes satisfying optional set of predicates.
void	stopNodes(Collection<UUID> ids) Stops nodes defined by provided IDs.
GridStreamer	streamer(String name) Gets an instance of streamer by name, if one does not exist then IllegalArgumentException will be thrown.
Collection<GridStreamer>	streamers() Gets all instances of streamers.
Collection<GridNode>	topology(long topVer) Gets a topology by version.
long	topologyVersion() Gets current topology version.
String	toString()
void	undeployTaskFromGrid(String taskName) Makes the best attempt to undeploy a task from the whole grid.

Methods inherited from class org.gridgain.grid.kernal.GridProjectionAdapter

compute, events, forAttribute, forCache, forDaemons, forHost, forNode, forNodeId, forNodeIds, forNodes, forOthers, forOthers, forPredicate, forRandom, forRemotes, forStreamer, forSubjectId, grid, guard, lightCheck, message, metrics, node, node, nodes, predicate, readExternal, readResolve, setKernalContext, unguard, writeExternal

Methods inherited from class org.gridgain.grid.util.lang.GridMetadataAwareAdapter

addMeta, addMetaIfAbsent, addMetaIfAbsent, allMeta, clone, copyMeta, copyMeta, hasMeta, hasMeta, meta, putMetaIfAbsent, putMetaIfAbsent, readExternalMeta, removeMeta, removeMeta, replaceMeta, writeExternalMeta

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.kernal.GridProjectionEx

forSubjectId

Methods inherited from interface org.gridgain.grid.GridProjection

compute, events, forAttribute, forCache, forDaemons, forHost, forNode, forNodeId, forNodeIds, forNodes, forOthers, forOthers, forPredicate, forRandom, forRemotes, forStreamer, grid, message, metrics, node, node, nodes, predicate

Constructor Detail

GridKernal

public GridKernal()

No-arg constructor is required by externalization.

GridKernal

public GridKernal(@Nullable
          GridSpringResourceContext rsrcCtx)

Parameters:

rsrcCtx - Optional Spring application context.

Method Detail

name

public String name()

Gets the name of the grid this grid instance (and correspondingly its local node) belongs to. Note that single Java VM can have multiple grid instances all belonging to different grids. Grid name allows to indicate to what grid this particular grid instance (i.e. grid runtime and its local node) belongs to.

If default grid instance is used, then null is returned. Refer to GridGain documentation for information on how to start named grids.

Specified by:

name in interface Grid

Returns:

Name of the grid, or null for default grid.

getCopyright

public String getCopyright()

Gets copyright statement for GridGain product.

Specified by:

getCopyright in interface GridKernalMBean

Returns:

Copyright statement for GridGain product.

getLicenseFilePath

public String getLicenseFilePath()

Gets file path of the license.

Specified by:

getLicenseFilePath in interface GridKernalMBean

Returns:

File path of the license.

getStartTimestamp

public long getStartTimestamp()

Get start timestamp of the kernal.

Specified by:

getStartTimestamp in interface GridKernalMBean

Returns:

Start timestamp of the kernal.

getStartTimestampFormatted

public String getStartTimestampFormatted()

Gets string presentation of the kernal start timestamp.

Specified by:

getStartTimestampFormatted in interface GridKernalMBean

Returns:

String presentation of the kernal start timestamp.

getUpTime

public long getUpTime()

Gets up-time of the kernal.

Specified by:

getUpTime in interface GridKernalMBean

Returns:

Up-time of the kernal.

getUpTimeFormatted

public String getUpTimeFormatted()

Gets string presentation of up-time for the kernal.

Specified by:

getUpTimeFormatted in interface GridKernalMBean

Returns:

String presentation of up-time for the kernal.

getFullVersion

public String getFullVersion()

Gets string presentation of the version.

Specified by:

getFullVersion in interface GridKernalMBean

Returns:

String presentation of the version.

getCheckpointSpiFormatted

public String getCheckpointSpiFormatted()

Gets a formatted instance of configured checkpoint SPI implementation.

Specified by:

getCheckpointSpiFormatted in interface GridKernalMBean

Returns:

Grid checkpoint SPI implementation.

getSwapSpaceSpiFormatted

public String getSwapSpaceSpiFormatted()

Gets a formatted instance of configured swapspace SPI implementations.

Specified by:

getSwapSpaceSpiFormatted in interface GridKernalMBean

Returns:

Grid swapspace SPI implementations.

getCommunicationSpiFormatted

public String getCommunicationSpiFormatted()

Gets a formatted instance of fully configured SPI communication implementation.

Specified by:

getCommunicationSpiFormatted in interface GridKernalMBean

Returns:

Grid communication SPI implementation.

getDeploymentSpiFormatted

public String getDeploymentSpiFormatted()

Gets a formatted instance of fully configured deployment SPI implementation.

Specified by:

getDeploymentSpiFormatted in interface GridKernalMBean

Returns:

Grid deployment SPI implementation.

getDiscoverySpiFormatted

public String getDiscoverySpiFormatted()

Gets a formatted instance of configured discovery SPI implementation.

Specified by:

getDiscoverySpiFormatted in interface GridKernalMBean

Returns:

Grid discovery SPI implementation.

getEventStorageSpiFormatted

public String getEventStorageSpiFormatted()

Gets a formatted instance of fully configured event SPI implementation.

Specified by:

getEventStorageSpiFormatted in interface GridKernalMBean

Returns:

Grid event SPI implementation.

getCollisionSpiFormatted

public String getCollisionSpiFormatted()

Gets a formatted instance of configured collision SPI implementations.

Specified by:

getCollisionSpiFormatted in interface GridKernalMBean

Returns:

Grid collision SPI implementations.

getFailoverSpiFormatted

public String getFailoverSpiFormatted()

Gets a formatted instance of fully configured failover SPI implementations.

Specified by:

getFailoverSpiFormatted in interface GridKernalMBean

Returns:

Grid failover SPI implementations.

getLoadBalancingSpiFormatted

public String getLoadBalancingSpiFormatted()

Gets a formatted instance of fully configured load balancing SPI implementations.

Specified by:

getLoadBalancingSpiFormatted in interface GridKernalMBean

Returns:

Grid load balancing SPI implementations.

getAuthenticationSpiFormatted

public String getAuthenticationSpiFormatted()

Gets a formatted instance of fully configured authentication SPI implementation.

Specified by:

getAuthenticationSpiFormatted in interface GridKernalMBean

Returns:

Grid authentication SPI implementation.

getSecureSessionSpiFormatted

public String getSecureSessionSpiFormatted()

Gets a formatted instance of fully configured secure session SPI implementation.

Specified by:

getSecureSessionSpiFormatted in interface GridKernalMBean

Returns:

Grid secure session SPI implementation.

getOsInformation

public String getOsInformation()

Gets OS information.

Specified by:

getOsInformation in interface GridKernalMBean

Returns:

OS information.

getJdkInformation

public String getJdkInformation()

Gets JDK information.

Specified by:

getJdkInformation in interface GridKernalMBean

Returns:

JDK information.

getOsUser

public String getOsUser()

Gets OS user.

Specified by:

getOsUser in interface GridKernalMBean

Returns:

OS user name.

getVmName

public String getVmName()

Gets VM name.

Specified by:

getVmName in interface GridKernalMBean

Returns:

VM name.

getInstanceName

public String getInstanceName()

Gets optional kernal instance name. It can be null.

Specified by:

getInstanceName in interface GridKernalMBean

Returns:

Optional kernal instance name.

getExecutorServiceFormatted

public String getExecutorServiceFormatted()

Gets a formatted instance of fully configured thread pool that is used in grid.

Specified by:

getExecutorServiceFormatted in interface GridKernalMBean

Returns:

Thread pool implementation that is used in grid.

getGridGainHome

public String getGridGainHome()

Gets GridGain installation home folder.

Specified by:

getGridGainHome in interface GridKernalMBean

Returns:

GridGain installation home.

getGridLoggerFormatted

public String getGridLoggerFormatted()

Gets a formatted instance of logger that is in grid.

Specified by:

getGridLoggerFormatted in interface GridKernalMBean

Returns:

Logger that is used in grid.

getMBeanServerFormatted

public String getMBeanServerFormatted()

Gets a formatted instance of MBean server instance.

Specified by:

getMBeanServerFormatted in interface GridKernalMBean

Returns:

MBean server instance.

getLocalNodeId

public UUID getLocalNodeId()

Unique identifier for this node within grid.

Specified by:

getLocalNodeId in interface GridKernalMBean

Returns:

Unique identifier for this node within grid.

getUserAttributesFormatted

public Collection<String> getUserAttributesFormatted()

Gets a collection of formatted user-defined attributes added to this node.

Note that grid will add all System properties and environment properties to grid node attributes also. SPIs may also add node attributes that are used for SPI implementation.

Specified by:

getUserAttributesFormatted in interface GridKernalMBean

Returns:

User defined attributes for this node.

isPeerClassLoadingEnabled

public boolean isPeerClassLoadingEnabled()

Returns true if peer class loading is enabled, false otherwise. Default value is true.

When peer class loading is enabled and task is not deployed on local node, local node will try to load classes from the node that initiated task execution. This way, a task can be physically deployed only on one node and then internally penetrate to all other nodes.

Specified by:

isPeerClassLoadingEnabled in interface GridKernalMBean

Returns:

true if peer class loading is enabled, false otherwise.

getLifecycleBeansFormatted

public Collection<String> getLifecycleBeansFormatted()

Gets toString() representation of of lifecycle beans configured with GridGain.

Specified by:

getLifecycleBeansFormatted in interface GridKernalMBean

Returns:

toString() representation of all lifecycle beans configured with GridGain.

start

public void start(GridConfiguration cfg,
         @Nullable
         ExecutorService drPool,
         GridAbsClosure errHnd)
           throws GridException

Parameters:

cfg - Grid configuration to use.

drPool - Dr executor service.

errHnd - Error handler to use for notification about startup problems.

Throws:

GridException - Thrown in case of any errors.

stop

public void stop(boolean cancel)

Stops grid instance.

Parameters:

cancel - Whether or not to cancel running jobs.

internalCache

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

USED ONLY FOR TESTING.

Type Parameters:

K - Key type.

V - Value type.

Returns:

Internal cache instance.

internalCache

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

USED ONLY FOR TESTING.

Type Parameters:

K - Key type.

V - Value type.

Parameters:

name - Cache name.

Returns:

Internal cache instance.

context

public GridKernalContext context()

It's intended for use by internal marshalling implementation only.

Returns:

Kernal context.

isJmxRemoteEnabled

public boolean isJmxRemoteEnabled()

Whether or not remote JMX management is enabled for this node. Remote JMX management is enabled when the following system property is set:

• com.sun.management.jmxremote

Specified by:

isJmxRemoteEnabled in interface GridEx

Returns:

True if remote JMX management is enabled - false otherwise.

isRestartEnabled

public boolean isRestartEnabled()

Whether or not node restart is enabled. Node restart us supported when this node was started with bin/ggstart.{sh|bat} script using -r argument. Node can be programmatically restarted using GridGain.restart(boolean)} method.

Specified by:

isRestartEnabled in interface GridEx

Returns:

True if restart mode is enabled, false otherwise.

See Also:

GridGain.restart(boolean)

isSmtpEnabled

public boolean isSmtpEnabled()

Whether or not SMTP is configured. Note that SMTP is considered configured if SMTP host is provided in configuration (see GridConfiguration.getSmtpHost().

If SMTP is not configured all emails notifications will be disabled.

Specified by:

isSmtpEnabled in interface GridEx

Returns:

True if SMTP is configured - false otherwise.

See Also:

GridConfiguration.getSmtpFromEmail(), GridConfiguration.getSmtpHost(), GridConfiguration.getSmtpPassword(), GridConfiguration.getSmtpPort(), GridConfiguration.getSmtpUsername(), GridConfiguration.isSmtpSsl(), GridConfiguration.isSmtpStartTls(), sendAdminEmailAsync(String, String, boolean)

configuration

public GridConfiguration configuration()

Gets the configuration of this grid instance.

NOTE:
SPIs obtains through this method should never be used directly. SPIs provide internal view on the subsystem and is used internally by GridGain kernal. In rare use cases when access to a specific implementation of this SPI is required - an instance of this SPI can be obtained via this method to check its configuration properties or call other non-SPI methods.

Specified by:

configuration in interface Grid

Returns:

Grid configuration instance.

log

public GridLogger log()

Gets grid's logger.

Specified by:

log in interface Grid

Returns:

Grid's logger.

removeCheckpoint

public boolean removeCheckpoint(String key)

This method allows manually remove the checkpoint with given key.

Specified by:

removeCheckpoint in interface GridKernalMBean

Parameters:

key - Checkpoint key.

Returns:

true if specified checkpoint was indeed removed, false otherwise.

pingNode

public boolean pingNode(String nodeId)

Pings node with given node ID to see whether it is alive.

Specified by:

pingNode in interface GridKernalMBean

Parameters:

nodeId - String presentation of node ID. See UUID.fromString(String) for details on string formatting.

Returns:

Whether or not node is alive.

topology

public Collection<GridNode> topology(long topVer)

Gets a topology by version. Returns null if topology history storage doesn't contain specified topology version (history currently keeps last 1000 snapshots).

Specified by:

topology in interface Grid

Parameters:

topVer - Topology version.

Returns:

Collection of grid nodes which represented by specified topology version, if it is present in history storage, null otherwise.

topologyVersion

public long topologyVersion()

Gets current topology version. In case of TCP discovery (see GridTcpDiscoverySpi) topology versions are sequential - they start from '1' and get incremented every time whenever a node joins or leaves. For other discovery SPIs topology versions may not be (and likely are not) sequential.

Specified by:

topologyVersion in interface Grid

Returns:

Current topology version.

undeployTaskFromGrid

public void undeployTaskFromGrid(String taskName)
                          throws JMException

Makes the best attempt to undeploy a task from the whole grid. Note that this method returns immediately and does not wait until the task will actually be undeployed on every node.

Note that GridGain maintains internal versions for grid tasks in case of redeployment. This method will attempt to undeploy all versions on the grid task with given name.

Specified by:

undeployTaskFromGrid in interface GridKernalMBean

Parameters:

taskName - Name of the task to undeploy. If task class has GridComputeTaskName annotation, then task was deployed under a name specified within annotation. Otherwise, full class name should be used as task's name.

Throws:

JMException - Thrown if undeploy failed.

executeTask

public String executeTask(String taskName,
                 String arg)
                   throws JMException

A shortcut method that executes given task assuming single java.lang.String argument and java.lang.String return type.

Specified by:

executeTask in interface GridKernalMBean

Parameters:

taskName - Name of the task to execute.

arg - Single task execution argument (can be null).

Returns:

Task return value (assumed of java.lang.String type).

Throws:

JMException - Thrown in case when execution failed.

sendAdminEmailAsync

public GridFuture<Boolean> sendAdminEmailAsync(String subj,
                                      String body,
                                      boolean html)

Schedule sending of given email to all configured admin emails. If no admin emails are configured this method is no-op. If SMTP is not configured this method is no-op.

Note that this method returns immediately with the future and all emails will be sent asynchronously in a different thread. If email queue is full or sending has failed - the email will be lost. Email queue can fill up if rate of scheduling emails is greater than the rate of SMTP sending.

Implementation is not performing any throttling and it is responsibility of the caller to properly throttle the emails, if necessary.

Specified by:

sendAdminEmailAsync in interface GridEx

Parameters:

subj - Subject of the email.

body - Body of the email.

html - If true the email body will have MIME html subtype.

Returns:

Email's future. You can use this future to check on the status of the email. If future completes ok and its result value is true email was successfully sent. In all other cases - sending process has failed.

See Also:

isSmtpEnabled(), GridConfiguration.getAdminEmails()

pingNodeByAddress

public boolean pingNodeByAddress(String host)

Pings node with given host name to see if it is alive.

Specified by:

pingNodeByAddress in interface GridKernalMBean

Parameters:

host - Host name or IP address of the node to ping.

Returns:

Whether or not node is alive.

localNode

public GridNode localNode()

Gets local grid node.

Specified by:

localNode in interface Grid

Returns:

Local grid node.

nodeLocalMap

public <K,V> GridNodeLocalMap<K,V> nodeLocalMap()

Gets node-local storage instance.

Node-local values are similar to thread locals in a way that these values are not distributed and kept only on local node (similar like thread local values are attached to the current thread only). Node-local values are used primarily by closures executed from the remote nodes to keep intermediate state on the local node between executions.

There's only one instance of node local storage per local node. Node local storage is based on ConcurrentMap and is safe for multi-threaded access.

Specified by:

nodeLocalMap in interface Grid

Returns:

Node local storage instance for the local node.

pingNode

public boolean pingNode(UUID nodeId)

Pings a remote node.

Discovery SPIs usually have some latency in discovering failed nodes. Hence, communication to remote nodes may fail at times if an attempt was made to establish communication with a failed node. This method can be used to check if communication has failed due to node failure or due to some other reason.

Specified by:

pingNode in interface Grid

Parameters:

nodeId - ID of a node to ping.

Returns:

true if node for a given ID is alive, false otherwise.

See Also:

GridDiscoverySpi

startNodes

public GridFuture<Collection<GridTuple3<String,Boolean,String>>> startNodes(File file,
                                                                   boolean restart,
                                                                   int timeout,
                                                                   int maxConn)
                                                                     throws GridException

Starts one or more nodes on remote host(s).

This method takes INI file which defines all startup parameters. It can contain one or more sections, each for a host or for range of hosts (note that they must have different names) and a special 'defaults' section with default values. They are applied to undefined parameters in host's sections.

Returned result is collection of tuples. Each tuple corresponds to one node start attempt and contains hostname, success flag and error message if attempt was not successful. Note that successful attempt doesn't mean that node was actually started and joined topology. For large topologies (> 100s nodes) it can take over 10 minutes for all nodes to start. See individual node logs for details.

Specified by:

startNodes in interface Grid

Parameters:

file - Configuration file.

restart - Whether to stop existing nodes. If true, all existing nodes on the host will be stopped before starting new ones. If false, nodes will be started only if there are less nodes on the host than expected.

timeout - Connection timeout.

maxConn - Number of parallel SSH connections to one host.

Returns:

Future for collection of tuples, each containing host name, result (success of failure) and error message (if any).

Throws:

GridException - In case of error.

startNodes

public GridFuture<Collection<GridTuple3<String,Boolean,String>>> startNodes(Collection<Map<String,Object>> hosts,
                                                                   @Nullable
                                                                   Map<String,Object> dflts,
                                                                   boolean restart,
                                                                   int timeout,
                                                                   int maxConn)
                                                                     throws GridException

Starts one or more nodes on remote host(s).

Each map in hosts collection defines startup parameters for one host or for a range of hosts. The following parameters are supported:

Name	Type	Description
host	String	Hostname (required). Can define several hosts if their IPs are sequential. E.g., 10.0.0.1~5 defines range of five IP addresses. Other parameters are applied to all hosts equally.
port	Integer	Port number (default is 22).
uname	String	Username (if not defined, current local username will be used).
passwd	String	Password (if not defined, private key file must be defined).
key	File	Private key file (if not defined, password must be defined).
nodes	Integer	Expected number of nodes on the host. If some nodes are started already, then only remaining nodes will be started. If current count of nodes is equal to this number, and restart flag is false, then nothing will happen.
ggHome	String	Path to GridGain installation folder. If not defined, GRIDGAIN_HOME environment variable must be set on remote hosts.
cfg	String	Path to configuration file (relative to ggHome).
script	String	Custom startup script file name and path (relative to ggHome). You can also specify a space-separated list of parameters in the same string (for example: "bin/my-custom-script.sh -v").

dflts map defines default values. They are applied to undefined parameters in hosts collection.

Returned result is collection of tuples. Each tuple corresponds to one node start attempt and contains hostname, success flag and error message if attempt was not successful. Note that successful attempt doesn't mean that node was actually started and joined topology. For large topologies (> 100s nodes) it can take over 10 minutes for all nodes to start. See individual node logs for details.

Specified by:

startNodes in interface Grid

Parameters:

hosts - Startup parameters.

dflts - Default values.

restart - Whether to stop existing nodes. If true, all existing nodes on the host will be stopped before starting new ones. If false, nodes will be started only if there are less nodes on the host than expected.

timeout - Connection timeout in milliseconds.

maxConn - Number of parallel SSH connections to one host.

Returns:

Future for collection of tuples, each containing host name, result (success of failure) and error message (if any).

Throws:

GridException - In case of error.

drPool

@Nullable
public ExecutorService drPool()

Get DR pool.

Specified by:

drPool in interface GridEx

Returns:

DR pool.

stopNodes

public void stopNodes()
               throws GridException

Stops nodes satisfying optional set of predicates.

NOTE: System.exit(GridGain.KILL_EXIT_CODE) will be executed on each stopping node. If you have other applications running in the same JVM along with GridGain, those applications will be stopped as well.

Specified by:

stopNodes in interface Grid

Throws:

GridException - In case of error.

stopNodes

public void stopNodes(Collection<UUID> ids)
               throws GridException

Stops nodes defined by provided IDs.

NOTE: System.exit(GridGain.KILL_EXIT_CODE) will be executed on each stopping node. If you have other applications running in the same JVM along with GridGain, those applications will be stopped as well.

Specified by:

stopNodes in interface Grid

Parameters:

ids - IDs defining nodes to stop.

Throws:

GridException - In case of error.

restartNodes

public void restartNodes()
                  throws GridException

Restarts nodes satisfying optional set of predicates.

NOTE: this command only works for grid nodes started with GridGain ggstart.sh or ggstart.bat scripts.

Specified by:

restartNodes in interface Grid

Throws:

GridException - In case of error.

restartNodes

public void restartNodes(Collection<UUID> ids)
                  throws GridException

Restarts nodes defined by provided IDs.

NOTE: this command only works for grid nodes started with GridGain ggstart.sh or ggstart.bat scripts.

Specified by:

restartNodes in interface Grid

Parameters:

ids - IDs defining nodes to restart.

Throws:

GridException - In case of error.

eventUserRecordable

public boolean eventUserRecordable(int type)

Checks if the event type is user-recordable.

Specified by:

eventUserRecordable in interface GridEx

Parameters:

type - Event type to check.

Returns:

true if passed event should be recorded, false - otherwise.

allEventsUserRecordable

public boolean allEventsUserRecordable(int[] types)

Checks whether all provided events are user-recordable.

Note that this method supports only predefined GridGain events.

Specified by:

allEventsUserRecordable in interface GridEx

Parameters:

types - Event types.

Returns:

Whether all events are recordable.

cache

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

Gets the cache instance for the given name, if one does not exist IllegalArgumentException will be thrown. Note that in case named cache instance is used as GGFS data or meta cache, IllegalStateException will be thrown.

Specified by:

cache in interface Grid

Type Parameters:

K - Key type.

V - Value type.

Parameters:

name - Cache name.

Returns:

Cache instance for given name.

See Also:

GridGgfsConfiguration, GridGgfsConfiguration.getDataCacheName(), GridGgfsConfiguration.getMetaCacheName()

caches

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

Gets all configured caches. Caches that are used as GGFS meta and data caches will not be returned in resulting collection.

Specified by:

caches in interface Grid

Returns:

All configured caches.

See Also:

GridGgfsConfiguration, GridGgfsConfiguration.getDataCacheName(), GridGgfsConfiguration.getMetaCacheName()

cachex

public <K,V> GridCache<K,V> cachex(@Nullable
                          String name)

Gets the cache instance for the given name if one is configured or null otherwise returning even non-public caches.

Specified by:

cachex in interface GridEx

Type Parameters:

K - Key type.

V - Value type.

Parameters:

name - Cache name.

Returns:

Cache instance for given name or null if one does not exist.

cachex

public <K,V> GridCache<K,V> cachex()

Gets default cache instance if one is configured or null otherwise returning even non-public caches. The GridCacheProjection.name() method on default instance returns null.

Specified by:

cachex in interface GridEx

Type Parameters:

K - Key type.

V - Value type.

Returns:

Default cache instance.

cachesx

public Collection<GridCache<?,?>> cachesx(GridPredicate<? super GridCache<?,?>>[] p)

Gets configured cache instance that satisfy all provided predicates including non-public caches. If no predicates provided - all configured caches will be returned.

Specified by:

cachesx in interface GridEx

Parameters:

p - Predicates. If none provided - all configured caches will be returned.

Returns:

Configured cache instances that satisfy all provided predicates.

dataLoader

public <K,V> GridDataLoader<K,V> dataLoader(@Nullable
                                   String cacheName)

Gets a new instance of data loader associated with given cache name. Data loader is responsible for loading external data into in-memory data grid. For more information refer to GridDataLoader documentation.

Specified by:

dataLoader in interface Grid

Parameters:

cacheName - Cache name (null for default cache).

Returns:

Data loader.

ggfs

public GridGgfs ggfs(String name)

Gets an instance of GGFS - GridGain In-Memory File System, if one is not configured then IllegalArgumentException will be thrown.

GGFS is fully compliant with Hadoop FileSystem APIs and can be plugged into Hadoop installations. For more information refer to documentation on Hadoop integration shipped with GridGain.

Specified by:

ggfs in interface Grid

Parameters:

name - GGFS name.

Returns:

GGFS instance.

ggfss

public Collection<GridGgfs> ggfss()

Gets all instances of the grid file systems.

Specified by:

ggfss in interface Grid

Returns:

Collection of grid file systems instances.

mapKeysToNodes

public <K> Map<GridNode,Collection<K>> mapKeysToNodes(String cacheName,
                                             @Nullable
                                             Collection<? extends K> keys)
                                           throws GridException

This method provides ability to detect which cache keys are mapped to which nodes on cache instance with given name. Use it to determine which nodes are storing which keys prior to sending jobs that access these keys.

This method works as following:

• For local caches it returns only local node mapped to all keys.
• For fully replicated caches, GridCacheAffinityFunction is used to determine which keys are mapped to which groups of nodes.
• For partitioned caches, the returned map represents node-to-key affinity.

Specified by:

mapKeysToNodes in interface Grid

Parameters:

cacheName - Cache name, if null, then default cache instance is used.

keys - Cache keys to map to nodes.

Returns:

Map of nodes to cache keys or empty map if there are no alive nodes for this cache.

Throws:

GridException - If failed to map cache keys.

mapKeyToNode

@Nullable
public <K> GridNode mapKeyToNode(String cacheName,
                                 K key)
                      throws GridException

This method provides ability to detect which cache keys are mapped to which nodes on cache instance with given name. Use it to determine which nodes are storing which keys prior to sending jobs that access these keys.

This method works as following:

• For local caches it returns only local node ID.
• For fully replicated caches first node ID returned by GridCacheAffinityFunction is returned.
• For partitioned caches, the returned node ID is the primary node for the key.

Specified by:

mapKeyToNode in interface Grid

Parameters:

cacheName - Cache name, if null, then default cache instance is used.

key - Cache key to map to a node.

Returns:

Primary node for the key or null if cache with given name is not present in the grid.

Throws:

GridException - If failed to map key.

resetMetrics

public void resetMetrics()

Resets local I/O, job, and task execution metrics.

Specified by:

resetMetrics in interface Grid

streamer

public GridStreamer streamer(@Nullable
                    String name)

Gets an instance of streamer by name, if one does not exist then IllegalArgumentException will be thrown.

Specified by:

streamer in interface Grid

Parameters:

name - Streamer name.

Returns:

Streamer for given name.

streamers

public Collection<GridStreamer> streamers()

Gets all instances of streamers.

Specified by:

streamers in interface Grid

Returns:

Collection of all streamer instances.

forLocal

public GridProjection forLocal()

Gets monadic projection consisting from the local node.

Specified by:

forLocal in interface Grid

Returns:

Monadic projection consisting from the local node.

product

public GridProduct product()

Gets information about product as well as license management capabilities.

Specified by:

product in interface Grid

Returns:

Instance of product.

scheduler

public GridScheduler scheduler()

Gets an instance of cron-based scheduler.

Specified by:

scheduler in interface Grid

Returns:

Instance of scheduler.

security

public GridSecurity security()

Gets an instance of GridSecurity interface. Available in enterprise edition only.

Specified by:

security in interface Grid

Returns:

Instance of GridSecurity interface.

dr

public GridDr dr()

Gets an instance of Data Center Replication.

Specified by:

dr in interface Grid

Returns:

Instance of Data Center Replication.

compatibleVersions

public Collection<String> compatibleVersions()

Gets list of compatible versions.

Specified by:

compatibleVersions in interface GridEx

Returns:

Compatible versions.

licenseGracePeriodLeft

public long licenseGracePeriodLeft()

Specified by:

licenseGracePeriodLeft in interface GridEx

Returns:

Grace period left in minutes if bursting or -1 otherwise.

close

public void close()
           throws GridException

Closes this instance of grid. This method is identical to calling G.stop(gridName, true).

The method is invoked automatically on objects managed by the try-with-resources statement.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Grid

Throws:

GridException - If failed to stop grid.

toString

public String toString()

Overrides:

toString in class Object