org.gridgain.grid.kernal.managers

Class GridManagerAdapter<T extends GridSpi>

java.lang.Object

org.gridgain.grid.kernal.managers.GridManagerAdapter<T>

Type Parameters:

T - SPI wrapped by this manager.

All Implemented Interfaces:

GridComponent, GridManager

Direct Known Subclasses:

GridCheckpointManager, GridCollisionManager, GridDeploymentManager, GridDiscoveryManager, GridEventStorageManager, GridFailoverManager, GridIndexingManager, GridIoManager, GridLoadBalancerManager, GridSwapSpaceManager

public abstract class GridManagerAdapter<T extends GridSpi>
extends Object
implements GridManager

Convenience adapter for grid managers.

Field Summary

Fields

Modifier and Type	Field and Description
protected GridKernalContext	ctx Kernal context.
protected GridLogger	log Logger.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GridManagerAdapter(GridKernalContext ctx, T... spis)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSpiAttributes(Map<String,Object> attrs) Adds attributes from underlying SPI to map of all attributes.
protected void	assertParameter(boolean cond, String condDesc) Throws exception with uniform error message if given parameter's assertion condition is false.
Object	collectDiscoveryData(UUID nodeId) Gets discovery data object that will be sent to new node during discovery process.
boolean	enabled()
protected T	getSpi() Gets wrapped SPI.
protected T	getSpi(String name)
protected T[]	getSpis()
void	onDiscoveryDataReceived(Object data) Receives discovery data object from remote nodes (called on new node during discovery process).
void	onKernalStart() Callback that notifies that kernal has successfully started, including all managers and processors.
protected void	onKernalStart0()
void	onKernalStop(boolean cancel) Callback to notify that kernal is about to stop.
protected void	onKernalStop0(boolean cancel)
void	printMemoryStats() Prints memory statistics (sizes of internal structures, etc.).
protected String	startInfo()
protected void	startSpi() Starts wrapped SPI.
protected String	stopInfo()
protected void	stopSpi() Stops wrapped SPI.
String	toString()
GridNodeValidationResult	validateNode(GridNode 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 java.lang.Object

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

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

start, stop

Field Detail

ctx

@GridToStringExclude
protected final GridKernalContext ctx

Kernal context.

log

@GridToStringExclude
protected final GridLogger log

Logger.

Constructor Detail

GridManagerAdapter

protected GridManagerAdapter(GridKernalContext ctx,
                  T... spis)

Parameters:

ctx - Kernal context.

spis - Specific SPI instance.

Method Detail

getSpi

protected final T getSpi()

Gets wrapped SPI.

Returns:

Wrapped SPI.

getSpi

protected final T getSpi(@Nullable
       String name)

Parameters:

name - SPI name

Returns:

SPI for given name. If null or empty, then 1st SPI on the list is returned.

enabled

public boolean enabled()

Specified by:

enabled in interface GridManager

Returns:

Returns true if at least one SPI does not have a NO-OP implementation, false otherwise.

getSpis

protected final T[] getSpis()

Returns:

Configured SPI's.

addSpiAttributes

public final void addSpiAttributes(Map<String,Object> attrs)
                            throws GridException

Adds attributes from underlying SPI to map of all attributes.

Specified by:

addSpiAttributes in interface GridManager

Parameters:

attrs - Map of all attributes gotten from SPI's so far.

Throws:

GridException - Wrapper for exception thrown by underlying SPI.

startSpi

protected final void startSpi()
                       throws GridException

Starts wrapped SPI.

Throws:

GridException - If wrapped SPI could not be started.

stopSpi

protected final void stopSpi()
                      throws GridException

Stops wrapped SPI.

Throws:

GridException - If underlying SPI could not be stopped.

startInfo

protected final String startInfo()

Returns:

Uniformly formatted ack string.

stopInfo

protected final String stopInfo()

Returns:

Uniformly formatted ack string.

onKernalStart

public final void onKernalStart()
                         throws GridException

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

Specified by:

onKernalStart in interface GridComponent

Throws:

GridException - Thrown in case of any errors.

onKernalStop

public final void onKernalStop(boolean cancel)

Callback to notify that kernal is about to stop.

Specified by:

onKernalStop in interface GridComponent

Parameters:

cancel - Flag indicating whether jobs should be canceled.

collectDiscoveryData

@Nullable
public Object collectDiscoveryData(UUID nodeId)

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

Specified by:

collectDiscoveryData in interface GridComponent

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(Object data)

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

Specified by:

onDiscoveryDataReceived in interface GridComponent

Parameters:

data - Discovery data object or null if nothing was sent for this component.

onKernalStart0

protected void onKernalStart0()
                       throws GridException

Throws:

GridException - If failed.

onKernalStop0

protected void onKernalStop0(boolean cancel)

Parameters:

cancel - Cancel flag.

assertParameter

protected final void assertParameter(boolean cond,
                   String condDesc)
                              throws GridException

Throws exception with uniform error message if given parameter's assertion condition is false.

Parameters:

cond - Assertion condition to check.

condDesc - Description of failed condition. Note that this description should include JavaBean name of the property (not a variable name) as well condition in Java syntax like, for example:

      ...
      assertParameter(dirPath != null, "dirPath != null");
      ...
      

Note that in case when variable name is the same as JavaBean property you can just copy Java condition expression into description as a string.

Throws:

GridException - Thrown if given condition is false

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

validateNode

@Nullable
public GridNodeValidationResult validateNode(GridNode 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

Parameters:

node - Joining node.

Returns:

Validation result or null in case of success.

toString

public final String toString()

Overrides:

toString in class Object