org.gridgain.grid.spi.loadbalancing.affinity
Class GridAffinityJobAdapter<A extends Serializable,G extends Serializable>

java.lang.Object
  org.gridgain.grid.GridJobAdapter<G>
      org.gridgain.grid.spi.loadbalancing.affinity.GridAffinityJobAdapter<A,G>

Type Parameters:

A - Affinity key type.

G - Job argument type.

All Implemented Interfaces:

Serializable, GridJob, GridAffinityJob<A>

public abstract class GridAffinityJobAdapter<A extends Serializable,G extends Serializable>
extends GridJobAdapter<G>
implements GridAffinityJob<A>

Convenience adapter for GridAffinityJob interface that provides default implementation of GridJob.cancel() method and allows to add arguments.

Here is example of how job affinity adapter could be used:

 public class MyGridAffinityJob extends GridAffinityJobAdapter<Integer, Serializable> {
    public MyGridAffinityJob(Integer cacheKey) {
        // Pass cache key as a job argument.
        super(cacheKey);
    }

    public Serializable execute() throws GridException {
        ...
        // Access data by the same key returned
        // in 'getAffinityKey()' method.
        mycache.get(getAffinityKey());
        ...
    }
 }
 

For more information and examples, see GridAffinityLoadBalancingSpi.



See Also:

Documentation
Email Support
Online Forums
Issue Tracking

Author: 2005-2008 Copyright © GridGain Systems. All Rights Reserved. ver. 2.0.3

	Nikita Ivanov, GridGain Systems nivanov@gridgain.com
	Dmitriy Setrakyan, GridGain Systems dsetrakyan@gridgain.com
	Alexander Magdenko, GridGain Systems amagdenko@gridgain.com
	Boris Suchodoev, GridGain Systems bsuchodoev@gridgain.com
	Denis Kharlamov, GridGain Systems dkharlamov@gridgain.com
	close

See Also:

Serialized Form

Constructor Summary

protected	GridAffinityJobAdapter() No-arg constructor.
protected	GridAffinityJobAdapter(A affKey) Creates affinity job with a given key.
protected	GridAffinityJobAdapter(A affKey, G... args) Creates a fully initialized affinity job with a given key and specified job argument(s).

Method Summary

A	getAffinityKey() Gets affinity key for this job.
void	setAffinityKey(A affKey) Sets affinity key.

Methods inherited from class org.gridgain.grid.GridJobAdapter

addArgument, cancel, getAllArguments, getArgument, getArgument, isCancelled, setArgument

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.GridJob

cancel, execute

Constructor Detail

GridAffinityJobAdapter

protected GridAffinityJobAdapter()

No-arg constructor.

Note that job argument(s) and affinity key will be null. Please use GridJobAdapter.setArgument(Serializable) to set job argument(s) and GridAffinityJobAdapter.setAffinityKey(Serializable) to set affinity key.

GridAffinityJobAdapter

protected GridAffinityJobAdapter(A affKey)

Creates affinity job with a given key.

Note that job argument(s) and affinity key will be null. Please use GridJobAdapter.setArgument(Serializable) to set job argument(s).

Parameters:

affKey - Affinity key.

GridAffinityJobAdapter

protected GridAffinityJobAdapter(A affKey,
                                 G... args)

Creates a fully initialized affinity job with a given key and specified job argument(s).

Parameters:

affKey - Affinity key.

args - Job arguments.

Method Detail

getAffinityKey

public A getAffinityKey()

Gets affinity key for this job.

Specified by:

getAffinityKey in interface GridAffinityJob<A extends Serializable>

Returns:

Affinity key for this job.

setAffinityKey

public void setAffinityKey(A affKey)

Sets affinity key.

Parameters:

affKey - Affinity key