org.gridgain.grid.kernal

Class GridProjectionAdapter

java.lang.Object

org.gridgain.grid.util.lang.GridMetadataAwareAdapter

org.gridgain.grid.kernal.GridProjectionAdapter

All Implemented Interfaces:

Externalizable, Serializable, GridMetadataAware, GridProjection, GridProjectionEx

Direct Known Subclasses:

GridKernal

public class GridProjectionAdapter
extends GridMetadataAwareAdapter
implements GridProjectionEx, Externalizable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected GridKernalContext	ctx

Constructor Summary

Constructors

Modifier	Constructor and Description
	GridProjectionAdapter() Required by Externalizable.
protected	GridProjectionAdapter(GridProjection parent, GridKernalContext ctx, UUID subjId, GridPredicate<GridNode> p)
protected	GridProjectionAdapter(GridProjection parent, GridKernalContext ctx, UUID subjId, Set<UUID> ids)

Method Summary

Methods

Modifier and Type	Method and Description
GridCompute	compute() Gets compute functionality over this grid projection.
GridEvents	events() Gets events functionality over this grid projection.
GridProjection	forAttribute(String name, String val) Creates projection for nodes containing given name and value specified in user attributes.
GridProjection	forCache(String cacheName, String... cacheNames) Creates projection for all nodes that have cache with specified name running.
GridProjection	forDaemons() Gets projection consisting from the daemon nodes in this projection.
GridProjection	forHost(GridNode node) Gets grid projection consisting from the nodes in this projection residing on the same host as given node.
GridProjection	forNode(GridNode node, GridNode... nodes) Creates a grid projection for the given node.
GridProjection	forNodeId(UUID id, UUID... ids) Creates a grid projection for a node with specified ID.
GridProjection	forNodeIds(Collection<UUID> ids) Creates a grid projection over nodes with specified node IDs.
GridProjection	forNodes(Collection<? extends GridNode> nodes) Creates a grid projection over a given set of nodes.
GridProjection	forOthers(GridNode node, GridNode... nodes) Creates a grid projection for nodes other than given nodes.
GridProjection	forOthers(GridProjection prj) Creates a grid projection for nodes not included into given projection.
GridProjection	forPredicate(GridPredicate<GridNode> p) Creates a grid projection which includes all nodes that pass the given predicate filter.
GridProjection	forRandom() Creates grid projection with one random node from current projection.
GridProjection	forRemotes() Gets grid projection consisting from the nodes in this projection excluding the local node.
GridProjection	forStreamer(String streamerName, String... streamerNames) Creates projection for all nodes that have streamer with specified name running.
GridProjectionEx	forSubjectId(UUID subjId) Creates projection for specified subject ID.
Grid	grid() Gets instance of grid.
protected void	guard() ctx.gateway().readLock()
protected void	lightCheck() ctx.gateway().lightCheck()
GridMessaging	message() Gets messaging functionality over this grid projection.
GridProjectionMetrics	metrics() Gets a metrics snapshot for this projection.
GridNode	node() Gets first node from the list of nodes in this projection.
GridNode	node(UUID id) Gets a node for given ID from this grid projection.
Collection<GridNode>	nodes() Gets read-only collections of nodes in this projection.
GridPredicate<GridNode>	predicate() Gets predicate that defines a subset of nodes for this projection.
void	readExternal(ObjectInput in)
protected Object	readResolve() Reconstructs object on demarshalling.
protected void	setKernalContext(GridKernalContext ctx) Sets kernal context.
protected void	unguard() ctx.gateway().readUnlock()
void	writeExternal(ObjectOutput out)

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, toString, wait, wait, wait

Field Detail

ctx

protected transient GridKernalContext ctx

Constructor Detail

GridProjectionAdapter

public GridProjectionAdapter()

Required by Externalizable.

GridProjectionAdapter

protected GridProjectionAdapter(@Nullable
                     GridProjection parent,
                     @Nullable
                     GridKernalContext ctx,
                     @Nullable
                     UUID subjId,
                     @Nullable
                     GridPredicate<GridNode> p)

Parameters:

parent - Parent of this projection.

ctx - Grid kernal context.

p - Predicate.

GridProjectionAdapter

protected GridProjectionAdapter(@Nullable
                     GridProjection parent,
                     @Nullable
                     GridKernalContext ctx,
                     @Nullable
                     UUID subjId,
                     Set<UUID> ids)

Parameters:

parent - Parent of this projection.

ctx - Grid kernal context.

ids - Node IDs.

Method Detail

guard

protected void guard()

ctx.gateway().readLock()

unguard

protected void unguard()

ctx.gateway().readUnlock()

lightCheck

protected void lightCheck()

ctx.gateway().lightCheck()

setKernalContext

protected void setKernalContext(GridKernalContext ctx)

Sets kernal context.

Parameters:

ctx - Kernal context to set.

grid

public final Grid grid()

Gets instance of grid.

Specified by:

grid in interface GridProjection

Returns:

Grid instance.

compute

public final GridCompute compute()

Gets compute functionality over this grid projection. All operations on the returned GridCompute instance will only include nodes from this projection.

Specified by:

compute in interface GridProjection

Returns:

Compute instance over this grid projection.

message

public final GridMessaging message()

Gets messaging functionality over this grid projection. All operations on the returned GridMessaging instance will only include nodes from this projection.

Specified by:

message in interface GridProjection

Returns:

Messaging instance over this grid projection.

events

public final GridEvents events()

Gets events functionality over this grid projection. All operations on the returned GridEvents instance will only include nodes from this projection.

Specified by:

events in interface GridProjection

Returns:

Events instance over this grid projection.

metrics

public final GridProjectionMetrics metrics()
                                    throws GridException

Gets a metrics snapshot for this projection.

Specified by:

metrics in interface GridProjection

Returns:

Grid project metrics snapshot.

Throws:

GridException - If projection is empty.

nodes

public final Collection<GridNode> nodes()

Gets read-only collections of nodes in this projection.

Specified by:

nodes in interface GridProjection

Returns:

All nodes in this projection.

node

public final GridNode node(UUID id)

Gets a node for given ID from this grid projection.

Specified by:

node in interface GridProjection

Parameters:

id - Node ID.

Returns:

Node with given ID from this projection or null if such node does not exist in this projection.

node

public GridNode node()

Gets first node from the list of nodes in this projection. This method is specifically useful for projection over one node only.

Specified by:

node in interface GridProjection

Returns:

First node from the list of nodes in this projection or null if projection is empty.

predicate

public final GridPredicate<GridNode> predicate()

Gets predicate that defines a subset of nodes for this projection.

Specified by:

predicate in interface GridProjection

Returns:

Predicate that defines a subset of nodes for this projection.

forPredicate

public final GridProjection forPredicate(GridPredicate<GridNode> p)

Creates a grid projection which includes all nodes that pass the given predicate filter.

Specified by:

forPredicate in interface GridProjection

Parameters:

p - Predicate filter for nodes to include into this projection.

Returns:

Grid projection for nodes that passed the predicate filter.

forAttribute

public final GridProjection forAttribute(String name,
                          @Nullable
                          String val)

Creates projection for nodes containing given name and value specified in user attributes.

User attributes for every node are optional and can be specified in grid node configuration. See GridConfiguration.getUserAttributes() for more information.

Specified by:

forAttribute in interface GridProjection

Parameters:

name - Name of the attribute.

val - Optional attribute value to match.

Returns:

Grid projection for nodes containing specified attribute.

forNode

public final GridProjection forNode(GridNode node,
                     GridNode... nodes)

Creates a grid projection for the given node.

Specified by:

forNode in interface GridProjection

Parameters:

node - Node to get projection for.

nodes - Optional additional nodes to include into projection.

Returns:

Grid projection for the given node.

forNodes

public final GridProjection forNodes(Collection<? extends GridNode> nodes)

Creates a grid projection over a given set of nodes.

Specified by:

forNodes in interface GridProjection

Parameters:

nodes - Collection of nodes to create a projection from.

Returns:

Projection over provided grid nodes.

forNodeId

public final GridProjection forNodeId(UUID id,
                       UUID... ids)

Creates a grid projection for a node with specified ID.

Specified by:

forNodeId in interface GridProjection

Parameters:

id - Node ID to get projection for.

ids - Optional additional node IDs to include into projection.

Returns:

Projection over node with specified node ID.

forNodeIds

public final GridProjection forNodeIds(Collection<UUID> ids)

Creates a grid projection over nodes with specified node IDs.

Specified by:

forNodeIds in interface GridProjection

Parameters:

ids - Collection of node IDs.

Returns:

Projection over nodes with specified node IDs.

forOthers

public final GridProjection forOthers(GridNode node,
                       GridNode... nodes)

Creates a grid projection for nodes other than given nodes.

Specified by:

forOthers in interface GridProjection

Parameters:

node - Node to exclude from new grid projection.

nodes - Optional additional nodes to exclude from projection.

Returns:

Projection that will contain all nodes that original projection contained excluding given nodes.

forOthers

public GridProjection forOthers(GridProjection prj)

Creates a grid projection for nodes not included into given projection.

Specified by:

forOthers in interface GridProjection

Parameters:

prj - Projection to exclude from new grid projection.

Returns:

Projection for nodes not included into given projection.

forRemotes

public final GridProjection forRemotes()

Gets grid projection consisting from the nodes in this projection excluding the local node.

Specified by:

forRemotes in interface GridProjection

Returns:

Grid projection consisting from the nodes in this projection excluding the local node, if any.

forCache

public final GridProjection forCache(@Nullable
                      String cacheName,
                      @Nullable
                      String... cacheNames)

Creates projection for all nodes that have cache with specified name running.

Specified by:

forCache in interface GridProjection

Parameters:

cacheName - Cache name.

cacheNames - Optional additional cache names to include into projection.

Returns:

Projection over nodes that have specified cache running.

forStreamer

public final GridProjection forStreamer(@Nullable
                         String streamerName,
                         @Nullable
                         String... streamerNames)

Creates projection for all nodes that have streamer with specified name running.

Specified by:

forStreamer in interface GridProjection

Parameters:

streamerName - Streamer name.

streamerNames - Optional additional streamer names to include into projection.

Returns:

Projection over nodes that have specified streamer running.

forHost

public final GridProjection forHost(GridNode node)

Gets grid projection consisting from the nodes in this projection residing on the same host as given node.

Specified by:

forHost in interface GridProjection

Parameters:

node - Node residing on the host for which projection is created.

Returns:

Projection for nodes residing on the same host as passed in node.

forDaemons

public final GridProjection forDaemons()

Gets projection consisting from the daemon nodes in this projection.

Daemon nodes are the usual grid nodes that participate in topology but not visible on the main APIs, i.e. they are not part of any projections. The only way to see daemon nodes is to use this method.

Daemon nodes are used primarily for management and monitoring functionality that is build on GridGain and needs to participate in the topology but also needs to be excluded from "normal" topology so that it won't participate in task execution or in-memory data grid storage.

Specified by:

forDaemons in interface GridProjection

Returns:

Grid projection consisting from the daemon nodes in this projection.

forRandom

public final GridProjection forRandom()

Creates grid projection with one random node from current projection.

Specified by:

forRandom in interface GridProjection

Returns:

Grid projection with one random node from current projection.

forSubjectId

public GridProjectionEx forSubjectId(UUID subjId)

Creates projection for specified subject ID.

Specified by:

forSubjectId in interface GridProjectionEx

Parameters:

subjId - Subject ID.

Returns:

Internal projection.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

readResolve

protected Object readResolve()
                      throws ObjectStreamException

Reconstructs object on demarshalling.

Returns:

Reconstructed object.

Throws:

ObjectStreamException - Thrown in case of demarshalling error.