Class JobStealingFailoverSpi
- java.lang.Object
- 
- org.apache.ignite.spi.IgniteSpiAdapter
- 
- org.apache.ignite.spi.failover.jobstealing.JobStealingFailoverSpi
 
 
- 
- All Implemented Interfaces:
- FailoverSpi,- IgniteSpi
 
 @IgniteSpiMultipleInstancesSupport(true) @IgniteSpiConsistencyChecked(optional=true) public class JobStealingFailoverSpi extends IgniteSpiAdapter implements FailoverSpi Job stealing failover SPI needs to always be used in conjunction withJobStealingCollisionSpiSPI. WhenJobStealingCollisionSpireceives a steal request and rejects jobs so they can be routed to the appropriate node, it is the responsibility of thisJobStealingFailoverSpiSPI to make sure that the job is indeed re-routed to the node that has sent the initial request to steal it.JobStealingFailoverSpiknows where to route a job based on theJobStealingCollisionSpi.THIEF_NODE_ATTRjob context attribute (seeComputeJobContext). Prior to rejecting a job,JobStealingCollisionSpiwill populate this attribute with the ID of the node that wants to steal this job. ThenJobStealingFailoverSpiwill read the value of this attribute and route the job to the node specified.If failure is caused by a node crash, and not by steal request, then this SPI behaves identically to AlwaysFailoverSpi, and tries to find the next balanced node to fail-over a job to.ConfigurationMandatoryThis SPI has no mandatory configuration parameters.OptionalThis SPI has following optional configuration parameters:- Maximum failover attempts for a single job (see setMaximumFailoverAttempts(int)).
 JobStealingFailoverSpi.JobStealingFailoverSpi spi = new JobStealingFailoverSpi(); // Override maximum failover attempts. spi.setMaximumFailoverAttempts(5); IgniteConfiguration cfg = new IgniteConfiguration(); // Override default failover SPI. cfg.setFailoverSpiSpi(spi); // Starts grid. G.start(cfg); Here is an example of how to configureJobStealingFailoverSpifrom Spring XML configuration file.<property name="failoverSpi"> <bean class="org.apache.ignite.spi.failover.jobstealing.JobStealingFailoverSpi"> <property name="maximumFailoverAttempts" value="5"/> </bean> </property>  
 For information about Spring framework visit www.springframework.org- See Also:
- FailoverSpi
 
- 
- 
Field SummaryFields Modifier and Type Field Description static intDFLT_MAX_FAILOVER_ATTEMPTSMaximum number of attempts to execute a failed job on another node (default is5).- 
Fields inherited from class org.apache.ignite.spi.IgniteSpiAdapterignite, igniteInstanceName
 
- 
 - 
Constructor SummaryConstructors Constructor Description JobStealingFailoverSpi()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description ClusterNodefailover(FailoverContext ctx, List<ClusterNode> top)This method is called when methodComputeTask.result(org.apache.ignite.compute.ComputeJobResult, List)returns valueComputeJobResultPolicy.FAILOVERpolicy indicating that the result of job execution must be failed over.protected List<String>getConsistentAttributeNames()Returns back a list of attributes that should be consistent for this SPI.intgetMaximumFailoverAttempts()Map<String,Object>getNodeAttributes()This method is called before SPI starts (before methodIgniteSpi.spiStart(String)is called).intgetTotalFailedOverJobsCount()Get total number of jobs that were failed over including stolen ones.intgetTotalStolenJobsCount()Get total number of jobs that were stolen.JobStealingFailoverSpisetMaximumFailoverAttempts(int maxFailoverAttempts)Sets maximum number of attempts to execute a failed job on another node.JobStealingFailoverSpisetName(String name)Sets SPI name.voidspiStart(String igniteInstanceName)This method is called to start SPI.voidspiStop()This method is called to stop SPI.StringtoString()- 
Methods inherited from class org.apache.ignite.spi.IgniteSpiAdapteraddTimeoutObject, assertParameter, checkConfigurationConsistency0, clientFailureDetectionTimeout, configInfo, createSpiAttributeName, failureDetectionTimeout, failureDetectionTimeoutEnabled, failureDetectionTimeoutEnabled, getExceptionRegistry, getLocalNode, getName, getSpiContext, ignite, initFailureDetectionTimeout, injectables, injectResources, isNodeStopping, onBeforeStart, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextDestroyed0, onContextInitialized, onContextInitialized0, registerMBean, removeTimeoutObject, started, startInfo, startStopwatch, stopInfo, unregisterMBean
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.ignite.spi.IgniteSpigetName, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextInitialized
 
- 
 
- 
- 
- 
Field Detail- 
DFLT_MAX_FAILOVER_ATTEMPTSpublic static final int DFLT_MAX_FAILOVER_ATTEMPTS Maximum number of attempts to execute a failed job on another node (default is5).- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getMaximumFailoverAttemptspublic int getMaximumFailoverAttempts() - Returns:
- Maximum number of attempts to execute a failed job on another node.
 
 - 
setMaximumFailoverAttempts@IgniteSpiConfiguration(optional=true) public JobStealingFailoverSpi setMaximumFailoverAttempts(int maxFailoverAttempts) Sets maximum number of attempts to execute a failed job on another node. If job gets stolen and thief node exists then it is not considered as failed job. If not specified,DFLT_MAX_FAILOVER_ATTEMPTSvalue will be used.Note this value must be identical for all grid nodes in the grid. - Parameters:
- maxFailoverAttempts- Maximum number of attempts to execute a failed job on another node.
- Returns:
- thisfor chaining.
 
 - 
getTotalFailedOverJobsCountpublic int getTotalFailedOverJobsCount() Get total number of jobs that were failed over including stolen ones.- Returns:
- Total number of failed over jobs.
 
 - 
getTotalStolenJobsCountpublic int getTotalStolenJobsCount() Get total number of jobs that were stolen.- Returns:
- Total number of stolen jobs.
 
 - 
getNodeAttributespublic Map<String,Object> getNodeAttributes() throws IgniteSpiException This method is called before SPI starts (before methodIgniteSpi.spiStart(String)is called). It allows SPI implementation to add attributes to a local node. Kernal collects these attributes from all SPI implementations loaded up and then passes it to discovery SPI so that they can be exchanged with other nodes.- Specified by:
- getNodeAttributesin interface- IgniteSpi
- Overrides:
- getNodeAttributesin class- IgniteSpiAdapter
- Returns:
- Map of local node attributes this SPI wants to add.
- Throws:
- IgniteSpiException- Throws in case of any error.
 
 - 
spiStartpublic void spiStart(String igniteInstanceName) throws IgniteSpiException This method is called to start SPI. After this method returns successfully kernel assumes that SPI is fully operational.- Specified by:
- spiStartin interface- IgniteSpi
- Parameters:
- igniteInstanceName- Name of Ignite instance this SPI is being started for (- nullfor default Ignite instance).
- Throws:
- IgniteSpiException- Throws in case of any error during SPI start.
 
 - 
spiStoppublic void spiStop() throws IgniteSpiExceptionThis 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:
- spiStopin interface- IgniteSpi
- Throws:
- IgniteSpiException- Thrown in case of any error during SPI stop.
 
 - 
failoverpublic ClusterNode failover(FailoverContext ctx, List<ClusterNode> top) This method is called when methodComputeTask.result(org.apache.ignite.compute.ComputeJobResult, List)returns valueComputeJobResultPolicy.FAILOVERpolicy 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 suppliedtopologyto retry job execution on it. For best performance it is advised thatFailoverContext.getBalancedNode(List)method is used to select node for execution of failed job.- Specified by:
- failoverin interface- FailoverSpi
- 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 nullif new node cannot be picked. If job failover fails (returnsnull) the whole task will be failed.
 
 - 
getConsistentAttributeNamesprotected List<String> getConsistentAttributeNames() Returns back a list of attributes that should be consistent for this SPI. Consistency means that remote node has to have the same attribute with the same value.- Overrides:
- getConsistentAttributeNamesin class- IgniteSpiAdapter
- Returns:
- List or attribute names.
 
 - 
setNamepublic JobStealingFailoverSpi setName(String name) Sets SPI name.- Overrides:
- setNamein class- IgniteSpiAdapter
- Parameters:
- name- SPI name.
- Returns:
- thisfor chaining.
 
 
- 
 
-