org.gridgain.grid.spi

Interface GridSpiContext

public interface GridSpiContext

SPI context provides common functionality for all SPI implementations.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLocalEventListener(GridLocalEventListener lsnr, int... types) Adds an event listener for local events.
void	addMessageListener(GridMessageListener lsnr, String topic) Register a message listener to receive messages sent by remote nodes.
GridSecuritySubject	authenticatedSubject(UUID subjId) Gets security subject based on subject ID.
Collection<GridSecuritySubject>	authenticatedSubjects() Gets collection of authenticated subjects together with their permissions.
<K> boolean	containsKey(String cacheName, K key) Returns true if this cache contains a mapping for the specified key.
void	deregisterPort(int port, GridPortProtocol proto) Deregisters closed port.
void	deregisterPorts() Deregisters all closed ports.
<K,V> V	get(String cacheName, K key) Gets object from cache.
boolean	isEventRecordable(int... types) Checks whether all provided event types are recordable.
GridNode	localNode() Gets local grid node.
GridNode	node(UUID nodeId) Gets a node instance based on its ID.
Collection<GridNode>	nodes() Gets a collection of all grid nodes.
int	partition(String cacheName, Object key) Calculates partition number for given key.
boolean	pingNode(UUID nodeId) Pings a remote node.
<K,V> V	put(String cacheName, K key, V val, long ttl) Puts object in cache.
<K,V> V	putIfAbsent(String cacheName, K key, V val, long ttl) Puts object into cache if there was no previous object associated with given key.
boolean	readDelta(UUID nodeId, Class<?> msgCls, ByteBuffer buf) Reads delta for provided node and message type.
<T> T	readFromOffheap(String spaceName, int part, Object key, byte[] keyBytes, ClassLoader ldr) Reads object from off-heap.
<T> T	readFromSwap(String spaceName, GridSwapKey key, ClassLoader ldr) Reads object from swap.
void	recordEvent(GridEvent evt) Records local event.
void	registerPort(int port, GridPortProtocol proto) Registers open port.
Collection<GridNode>	remoteNodes() Gets a collection of remote grid nodes.
<K,V> V	remove(String cacheName, K key) Removes object from cache.
boolean	removeFromOffheap(String spaceName, int part, Object key, byte[] keyBytes) Removes data from off-heap memory.
void	removeFromSwap(String spaceName, Object key, ClassLoader ldr) Removes object from swap.
boolean	removeLocalEventListener(GridLocalEventListener lsnr) Removes local event listener.
boolean	removeMessageListener(GridMessageListener lsnr, String topic) Removes a previously registered message listener.
void	send(GridNode node, Serializable msg, String topic) Sends a message to a remote node.
GridNodeValidationResult	validateNode(GridNode node) Validates that new node can join grid topology, this method is called on coordinator node before new node joins topology.
boolean	writeDelta(UUID nodeId, Class<?> msgCls, ByteBuffer buf) Writes delta for provided node and message type.
void	writeToOffheap(String spaceName, int part, Object key, byte[] keyBytes, Object val, byte[] valBytes, ClassLoader ldr) Writes data to off-heap memory.
void	writeToSwap(String spaceName, Object key, Object val, ClassLoader ldr) Writes object to swap.

Method Detail

remoteNodes

Collection<GridNode> remoteNodes()

Gets a collection of remote grid nodes. Remote nodes are discovered via underlying GridDiscoverySpi implementation used. Unlike nodes(), this method does not include local grid node.

Returns:

Collection of remote grid nodes.

See Also:

localNode(), nodes(), GridDiscoverySpi

nodes

Collection<GridNode> nodes()

Gets a collection of all grid nodes. Remote nodes are discovered via underlying GridDiscoverySpi implementation used. Unlike remoteNodes(), this method does include local grid node.

Returns:

Collection of remote grid nodes.

See Also:

localNode(), remoteNodes(), GridDiscoverySpi

localNode

GridNode localNode()

Gets local grid node. Instance of local node is provided by underlying GridDiscoverySpi implementation used.

Returns:

Local grid node.

See Also:

GridDiscoverySpi

node

@Nullable
GridNode node(UUID nodeId)

Gets a node instance based on its ID.

Parameters:

nodeId - ID of a node to get.

Returns:

Node for a given ID or null is such not has not been discovered.

See Also:

GridDiscoverySpi

pingNode

boolean pingNode(UUID nodeId)

Pings a remote node. The underlying communication is provided via GridDiscoverySpi.pingNode(UUID) implementation.

Discovery SPIs usually have some latency in discovering failed nodes. Hence, communication to remote nodes may fail at times if an attempt was made to establish communication with a failed node. This method can be used to check if communication has failed due to node failure or due to some other reason.

Parameters:

nodeId - ID of a node to ping.

Returns:

true if node for a given ID is alive, false otherwise.

See Also:

GridDiscoverySpi

send

void send(GridNode node,
        Serializable msg,
        String topic)
          throws GridSpiException

Sends a message to a remote node. The underlying communication mechanism is defined by GridCommunicationSpi implementation used.

Parameters:

node - Node to send a message to.

msg - Message to send.

topic - Topic to send message to.

Throws:

GridSpiException - If failed to send a message to remote node.

addMessageListener

void addMessageListener(GridMessageListener lsnr,
                      String topic)

Register a message listener to receive messages sent by remote nodes. The underlying communication mechanism is defined by GridCommunicationSpi implementation used.

This method can be used by jobs to communicate with other nodes in the grid. Remote nodes can send messages by calling send(GridNode, Serializable, String) method.

Parameters:

lsnr - Message listener to register.

topic - Topic to register listener for.

removeMessageListener

boolean removeMessageListener(GridMessageListener lsnr,
                            String topic)

Removes a previously registered message listener.

Parameters:

lsnr - Message listener to remove.

topic - Topic to unregister listener for.

Returns:

true of message listener was removed, false if it was not previously registered.

addLocalEventListener

void addLocalEventListener(GridLocalEventListener lsnr,
                         int... types)

Adds an event listener for local events.

Parameters:

lsnr - Event listener for local events.

types - Optional types for which this listener will be notified. If no types are provided this listener will be notified for all local events.

See Also:

GridEvent

removeLocalEventListener

boolean removeLocalEventListener(GridLocalEventListener lsnr)

Removes local event listener.

Parameters:

lsnr - Local event listener to remove.

Returns:

true if listener was removed, false otherwise.

isEventRecordable

boolean isEventRecordable(int... types)

Checks whether all provided event types are recordable.

Parameters:

types - Event types to check.

Returns:

Whether or not all provided event types are recordable..

recordEvent

void recordEvent(GridEvent evt)

Records local event.

Parameters:

evt - Local grid event to record.

registerPort

void registerPort(int port,
                GridPortProtocol proto)

Registers open port.

Parameters:

port - Port.

proto - Protocol.

deregisterPort

void deregisterPort(int port,
                  GridPortProtocol proto)

Deregisters closed port.

Parameters:

port - Port.

proto - Protocol.

deregisterPorts

void deregisterPorts()

Deregisters all closed ports.

get

@Nullable
<K,V> V get(String cacheName,
                   K key)
      throws GridException

Gets object from cache.

Parameters:

cacheName - Cache name.

key - Object key.

Returns:

Cached object.

Throws:

GridException - Thrown if any exception occurs.

put

@Nullable
<K,V> V put(String cacheName,
                   K key,
                   V val,
                   long ttl)
      throws GridException

Puts object in cache.

Type Parameters:

K - Key type.

V - Value type.

Parameters:

cacheName - Cache name.

key - Object key.

val - Cached object.

ttl - Time to live, 0 means the entry will never expire.

Returns:

Previous value associated with specified key, possibly null.

Throws:

GridException - Thrown if any exception occurs.

putIfAbsent

@Nullable
<K,V> V putIfAbsent(String cacheName,
                           K key,
                           V val,
                           long ttl)
              throws GridException

Puts object into cache if there was no previous object associated with given key.

Type Parameters:

K - Cache key type.

V - Cache value type.

Parameters:

cacheName - Cache name.

key - Cache key.

val - Cache value.

ttl - Time to live.

Returns:

Either existing value or null if there was no value for given key.

Throws:

GridException - If put failed.

remove

@Nullable
<K,V> V remove(String cacheName,
                      K key)
         throws GridException

Removes object from cache.

Type Parameters:

K - Key type.

V - Value type.

Parameters:

cacheName - Cache name.

key - Object key.

Returns:

Previous value associated with specified key, possibly null.

Throws:

GridException - Thrown if any exception occurs.

containsKey

<K> boolean containsKey(String cacheName,
                      K key)

Returns true if this cache contains a mapping for the specified key.

Type Parameters:

K - Key type.

Parameters:

cacheName - Cache name.

key - Object key.

Returns:

true if this cache contains a mapping for the specified key.

writeToSwap

void writeToSwap(String spaceName,
               Object key,
               @Nullable
               Object val,
               @Nullable
               ClassLoader ldr)
                 throws GridException

Writes object to swap.

Parameters:

spaceName - Swap space name.

key - Key.

val - Value.

ldr - Class loader (optional).

Throws:

GridException - If any exception occurs.

readFromSwap

@Nullable
<T> T readFromSwap(String spaceName,
                          GridSwapKey key,
                          @Nullable
                          ClassLoader ldr)
               throws GridException

Reads object from swap.

Parameters:

spaceName - Swap space name.

key - Key.

ldr - Class loader (optional).

Returns:

Swapped value.

Throws:

GridException - If any exception occurs.

readFromOffheap

@Nullable
<T> T readFromOffheap(@Nullable
                             String spaceName,
                             int part,
                             Object key,
                             @Nullable
                             byte[] keyBytes,
                             @Nullable
                             ClassLoader ldr)
                  throws GridException

Reads object from off-heap.

Parameters:

spaceName - Off-heap space name.

part - Partition.

key - Key.

keyBytes - Key bytes.

ldr - Class loader for unmarshalling.

Returns:

Value.

Throws:

GridException - If failed.

writeToOffheap

void writeToOffheap(@Nullable
                  String spaceName,
                  int part,
                  Object key,
                  @Nullable
                  byte[] keyBytes,
                  Object val,
                  @Nullable
                  byte[] valBytes,
                  @Nullable
                  ClassLoader ldr)
                    throws GridException

Writes data to off-heap memory.

Parameters:

spaceName - Off-heap space name.

part - Partition.

key - Key.

keyBytes - Optional key bytes.

val - Value.

valBytes - Optional value bytes.

ldr - Class loader.

Throws:

GridException - If failed.

removeFromOffheap

boolean removeFromOffheap(@Nullable
                        String spaceName,
                        int part,
                        Object key,
                        @Nullable
                        byte[] keyBytes)
                          throws GridException

Removes data from off-heap memory.

Parameters:

spaceName - Off-heap space name.

part - Partition.

key - Key.

keyBytes - Optional key bytes.

Returns:

true If succeeded.

Throws:

GridException - If failed.

partition

int partition(String cacheName,
            Object key)

Calculates partition number for given key.

Parameters:

cacheName - Cache name.

key - Key.

Returns:

Partition.

removeFromSwap

void removeFromSwap(String spaceName,
                  Object key,
                  @Nullable
                  ClassLoader ldr)
                    throws GridException

Removes object from swap.

Parameters:

spaceName - Swap space name.

key - Key.

ldr - Class loader (optional).

Throws:

GridException - If any exception occurs.

validateNode

@Nullable
GridNodeValidationResult validateNode(GridNode node)

Validates that new node can join grid topology, this method is called on coordinator node before new node joins topology.

Parameters:

node - Joining node.

Returns:

Validation result or null in case of success.

writeDelta

boolean writeDelta(UUID nodeId,
                 Class<?> msgCls,
                 ByteBuffer buf)

Writes delta for provided node and message type.

Parameters:

nodeId - Node ID.

msgCls - Message type.

buf - Buffer to write to.

Returns:

Whether delta was fully written.

readDelta

boolean readDelta(UUID nodeId,
                Class<?> msgCls,
                ByteBuffer buf)

Reads delta for provided node and message type.

Parameters:

nodeId - Node ID.

msgCls - Message type.

buf - Buffer to read from.

Returns:

Whether delta was fully read.

authenticatedSubjects

Collection<GridSecuritySubject> authenticatedSubjects()
                                                      throws GridException

Gets collection of authenticated subjects together with their permissions.

Returns:

Collection of authenticated subjects.

Throws:

GridException

authenticatedSubject

GridSecuritySubject authenticatedSubject(UUID subjId)
                                         throws GridException

Gets security subject based on subject ID.

Parameters:

subjId - Subject ID.

Returns:

Authorized security subject.

Throws:

GridException