org.gridgain.grid.spi.failover.never

Class GridNeverFailoverSpi

java.lang.Object

org.gridgain.grid.spi.GridSpiAdapter

org.gridgain.grid.spi.failover.never.GridNeverFailoverSpi

All Implemented Interfaces:

GridFailoverSpi, GridNeverFailoverSpiMBean, GridSpi, GridSpiManagementMBean

@GridSpiMultipleInstancesSupport(value=true)
public class GridNeverFailoverSpi
extends GridSpiAdapter
implements GridFailoverSpi, GridNeverFailoverSpiMBean

This class provides failover SPI implementation that never fails over. This implementation never fails over a failed job by always returning null out of GridFailoverSpi.failover(GridFailoverContext, List) method.

Configuration

Mandatory

This SPI has no mandatory configuration parameters.

Optional

This SPI has no optional configuration parameters.

Here is a Java example on how to configure grid with GridNeverFailoverSpi:

 GridNeverFailoverSpi spi = new GridNeverFailoverSpi();

 GridConfiguration cfg = new GridConfiguration();

 // Override default failover SPI.
 cfg.setFailoverSpiSpi(spi);

 // Starts grid.
 G.start(cfg);
 

Here is an example on how to configure grid with GridNeverFailoverSpi from Spring XML configuration file:

 <property name="failoverSpi">
     <bean class="org.gridgain.grid.spi.failover.never.GridNeverFailoverSpi"/>
 </property>
 

For information about Spring framework visit www.springframework.org

See Also:

GridFailoverSpi

Constructor Summary

Constructors

Constructor and Description
GridNeverFailoverSpi()

Method Summary

Methods

Modifier and Type	Method and Description
GridNode	failover(GridFailoverContext ctx, List<GridNode> top) This method is called when method GridComputeTask.result(GridComputeJobResult, List) returns value GridComputeJobResultPolicy.FAILOVER policy indicating that the result of job execution must be failed over.
void	spiStart(String gridName) This method is called to start SPI.
void	spiStop() This method is called to stop SPI.
String	toString()

Methods inherited from class org.gridgain.grid.spi.GridSpiAdapter

assertParameter, checkConfigurationConsistency0, configInfo, createSpiAttributeName, getConsistentAttributeNames, getGridGainHome, getLocalNodeId, getName, getNodeAttributes, getSpiContext, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, injectables, onContextDestroyed, onContextDestroyed0, onContextInitialized, onContextInitialized0, registerMBean, setName, startInfo, startStopwatch, stopInfo, unregisterMBean

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.spi.GridSpi

getName, getNodeAttributes, onContextDestroyed, onContextInitialized

Methods inherited from interface org.gridgain.grid.spi.GridSpiManagementMBean

getGridGainHome, getLocalNodeId, getName, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted

Constructor Detail

GridNeverFailoverSpi

public GridNeverFailoverSpi()

Method Detail

spiStart

public void spiStart(String gridName)
              throws GridSpiException

This method is called to start SPI. After this method returns successfully kernel assumes that SPI is fully operational.

Specified by:

spiStart in interface GridSpi

Parameters:

gridName - Name of grid instance this SPI is being started for (null for default grid).

Throws:

GridSpiException - Throws in case of any error during SPI start.

spiStop

public void spiStop()
             throws GridSpiException

This method is called to stop SPI. After this method returns kernel assumes that this SPI is finished and all resources acquired by it are released.

Note that this method can be called at any point including during recovery of failed start. It should make no assumptions on what state SPI will be in when this method is called.

Specified by:

spiStop in interface GridSpi

Throws:

GridSpiException - Thrown in case of any error during SPI stop.

failover

public GridNode failover(GridFailoverContext ctx,
                List<GridNode> top)

This method is called when method GridComputeTask.result(GridComputeJobResult, List) returns value GridComputeJobResultPolicy.FAILOVER policy indicating that the result of job execution must be failed over. Implementation of this method should examine failover context and choose one of the grid nodes from supplied topology to retry job execution on it. For best performance it is advised that GridFailoverContext.getBalancedNode(List) method is used to select node for execution of failed job.

Specified by:

failover in interface GridFailoverSpi

Parameters:

ctx - Failover context.

top - Collection of all grid nodes within task topology (may include failed node).

Returns:

New node to route this job to or null if new node cannot be picked. If job failover fails (returns null) the whole task will be failed.

toString

public String toString()

Overrides:

toString in class Object