org.gridgain.grid.kernal

Class GridJobSessionImpl

java.lang.Object

org.gridgain.grid.kernal.GridJobSessionImpl

All Implemented Interfaces:

GridComputeTaskSession, GridTaskSessionInternal

public class GridJobSessionImpl
extends Object
implements GridTaskSessionInternal

Job session implementation.

Constructor Summary

Constructors

Constructor and Description
GridJobSessionImpl(GridKernalContext ctx, GridTaskSessionImpl ses, GridUuid jobId)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttributeListener(GridComputeTaskSessionAttributeListener lsnr, boolean rewind) Add listener for the session attributes.
<K,V> V	getAttribute(K key) Gets an attribute set by GridComputeTaskSession.setAttribute(Object, Object) or GridComputeTaskSession.setAttributes(Map) method.
Map<?,?>	getAttributes() Gets all attributes.
String	getCheckpointSpi()
ClassLoader	getClassLoader() Gets class loader responsible for loading all classes within task.
long	getEndTime() Gets end of computation time for the task.
GridUuid	getId() Gets session ID of the task being executed.
GridUuid	getJobId()
GridComputeJobSibling	getJobSibling(GridUuid jobId) Gets job sibling for a given ID.
Collection<GridComputeJobSibling>	getJobSiblings() Gets a collection of all grid job siblings.
long	getStartTime() Gets start of computation time for the task.
String	getTaskClassName() Returns task class name.
String	getTaskName() Gets task name of the task this session belongs to.
UUID	getTaskNodeId() Gets ID of the node on which task execution originated.
Collection<UUID>	getTopology() Gets a collection of grid nodes IDs.
boolean	isClosed()
boolean	isFullSupport()
boolean	isTaskNode()
<T> T	loadCheckpoint(String key) Loads job's state previously saved via GridComputeTaskSession.saveCheckpoint(String, Object, GridComputeTaskSessionScope, long) method from an underlying storage for a given key.
void	onClosed() Closes session.
Collection<GridComputeJobSibling>	refreshJobSiblings() Refreshes collection of job siblings.
boolean	removeAttributeListener(GridComputeTaskSessionAttributeListener lsnr) Removes given listener.
boolean	removeCheckpoint(String key) Removes previously saved job's state for a given key from an underlying storage.
void	saveCheckpoint(String key, Object state) Saves intermediate state of a job or task to a storage.
void	saveCheckpoint(String key, Object state, GridComputeTaskSessionScope scope, long timeout) Saves intermediate state of a job to a storage.
void	saveCheckpoint(String key, Object state, GridComputeTaskSessionScope scope, long timeout, boolean overwrite) Saves intermediate state of a job or task to a storage.
GridTaskSessionInternal	session()
void	setAttribute(Object key, Object val) Sets session attributed.
void	setAttributes(Map<?,?> attrs) Sets task attributes.
String	toString()
<K,V> V	waitForAttribute(K key) Waits for the specified attribute to be set.
<K,V> V	waitForAttribute(K key, long timeout) Waits for the specified attribute to be set.
<K,V> boolean	waitForAttribute(K key, V val) Waits for the specified attribute to be set or updated with given value.
<K,V> boolean	waitForAttribute(K key, V val, long timeout) Waits for the specified attribute to be set or updated with given value.
Map<?,?>	waitForAttributes(Collection<?> keys) Waits for the specified attributes to be set.
Map<?,?>	waitForAttributes(Collection<?> keys, long timeout) Waits for the specified attributes to be set.
boolean	waitForAttributes(Map<?,?> attrs) Waits for the specified attributes to be set or updated with given values.
boolean	waitForAttributes(Map<?,?> attrs, long timeout) Waits for the specified attributes to be set or updated with given values.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridJobSessionImpl

public GridJobSessionImpl(GridKernalContext ctx,
                  GridTaskSessionImpl ses,
                  GridUuid jobId)

Parameters:

ctx - Kernal context.

ses - Task session.

jobId - Job ID.

Method Detail

session

public GridTaskSessionInternal session()

Specified by:

session in interface GridTaskSessionInternal

Returns:

Task session.

getJobId

public GridUuid getJobId()

Specified by:

getJobId in interface GridTaskSessionInternal

Returns:

Job ID (possibly null).

onClosed

public void onClosed()

Closes session.

Specified by:

onClosed in interface GridTaskSessionInternal

isClosed

public boolean isClosed()

Specified by:

isClosed in interface GridTaskSessionInternal

Returns:

Checks if session is closed.

isTaskNode

public boolean isTaskNode()

Specified by:

isTaskNode in interface GridTaskSessionInternal

Returns:

True if task node.

getCheckpointSpi

public String getCheckpointSpi()

Specified by:

getCheckpointSpi in interface GridTaskSessionInternal

Returns:

Checkpoint SPI name.

getTaskName

public String getTaskName()

Gets task name of the task this session belongs to.

Specified by:

getTaskName in interface GridComputeTaskSession

Returns:

Task name of the task this session belongs to.

getTaskClassName

public String getTaskClassName()

Returns task class name.

Returns:

Task class name.

getTaskNodeId

public UUID getTaskNodeId()

Gets ID of the node on which task execution originated.

Specified by:

getTaskNodeId in interface GridComputeTaskSession

Returns:

ID of the node on which task execution originated.

getStartTime

public long getStartTime()

Gets start of computation time for the task.

Specified by:

getStartTime in interface GridComputeTaskSession

Returns:

Start of computation time for the task.

getEndTime

public long getEndTime()

Gets end of computation time for the task. No job within the task will be allowed to execute passed this time.

Specified by:

getEndTime in interface GridComputeTaskSession

Returns:

End of computation time for the task.

getId

public GridUuid getId()

Gets session ID of the task being executed.

Specified by:

getId in interface GridComputeTaskSession

Returns:

Session ID of the task being executed.

getClassLoader

public ClassLoader getClassLoader()

Gets class loader responsible for loading all classes within task.

Note that for classes that were loaded remotely from other nodes methods Class.getResource(String) or ClassLoader.getResource(String) will always return null. Use Class.getResourceAsStream(String) or ClassLoader.getResourceAsStream(String) instead.

Specified by:

getClassLoader in interface GridComputeTaskSession

Returns:

Class loader responsible for loading all classes within task.

refreshJobSiblings

public Collection<GridComputeJobSibling> refreshJobSiblings()
                                                     throws GridException

Refreshes collection of job siblings. This method has no effect when invoked on originating node, as the list of siblings is always most recent. However, when using continuous mapping (see GridComputeTaskContinuousMapper), list of siblings on remote node may not be fresh. In that case, this method will re-request list of siblings from originating node.

Specified by:

refreshJobSiblings in interface GridComputeTaskSession

Returns:

Refreshed collection of job siblings.

Throws:

GridException - If refresh failed.

getJobSiblings

public Collection<GridComputeJobSibling> getJobSiblings()
                                                 throws GridException

Gets a collection of all grid job siblings. Job siblings are grid jobs that are executing within the same task.

If task uses continuous mapper (i.e. it injected into task class) then job siblings will be requested from task node for each apply.

Specified by:

getJobSiblings in interface GridComputeTaskSession

Returns:

Collection of grid job siblings executing within this task.

Throws:

GridException - If job siblings can not be received from task node.

getJobSibling

public GridComputeJobSibling getJobSibling(GridUuid jobId)
                                    throws GridException

Gets job sibling for a given ID.

If task uses continuous mapper (i.e. it injected into task class) then job sibling will be requested from task node for each apply.

Specified by:

getJobSibling in interface GridComputeTaskSession

Parameters:

jobId - Job ID to get the sibling for.

Returns:

Grid job sibling for a given ID.

Throws:

GridException - If job sibling can not be received from task node.

setAttribute

public void setAttribute(Object key,
                @Nullable
                Object val)
                  throws GridException

Sets session attributed. Note that task session is distributed and this attribute will be propagated to all other jobs within this task and task itself - i.e., to all accessors of this session. Other jobs then will be notified by GridComputeTaskSessionAttributeListener callback than an attribute has changed.

This method is no-op if the session has finished.

Specified by:

setAttribute in interface GridComputeTaskSession

Parameters:

key - Attribute key.

val - Attribute value. Can be null.

Throws:

GridException - If sending of attribute message failed.

getAttribute

public <K,V> V getAttribute(K key)

Gets an attribute set by GridComputeTaskSession.setAttribute(Object, Object) or GridComputeTaskSession.setAttributes(Map) method. Note that this attribute could have been set by another job on another node.

This method is no-op if the session has finished.

Specified by:

getAttribute in interface GridComputeTaskSession

Type Parameters:

K - Attribute key type.

V - Attribute value type.

Parameters:

key - Attribute key.

Returns:

Gets task attribute for given name.

setAttributes

public void setAttributes(Map<?,?> attrs)
                   throws GridException

Sets task attributes. This method exists so one distributed replication operation will take place for the whole group of attributes passed in. Use it for performance reasons, rather than GridComputeTaskSession.setAttribute(Object, Object) method, whenever you need to set multiple attributes.

This method is no-op if the session has finished.

Specified by:

setAttributes in interface GridComputeTaskSession

Parameters:

attrs - Attributes to set.

Throws:

GridException - If sending of attribute message failed.

getAttributes

public Map<?,?> getAttributes()

Gets all attributes.

Specified by:

getAttributes in interface GridComputeTaskSession

Returns:

All session attributes.

addAttributeListener

public void addAttributeListener(GridComputeTaskSessionAttributeListener lsnr,
                        boolean rewind)

Add listener for the session attributes.

Specified by:

addAttributeListener in interface GridComputeTaskSession

Parameters:

lsnr - Listener to add.

rewind - true value will result in calling given listener for all already received attributes, while false value will result only in new attribute notification. Settings rewind to true allows for a simple mechanism that prevents the loss of notifications for the attributes that were previously received or received while this method was executing.

removeAttributeListener

public boolean removeAttributeListener(GridComputeTaskSessionAttributeListener lsnr)

Removes given listener.

Specified by:

removeAttributeListener in interface GridComputeTaskSession

Parameters:

lsnr - Listener to remove.

Returns:

true if listener was removed, false otherwise.

waitForAttribute

public <K,V> V waitForAttribute(K key)
                   throws InterruptedException

Waits for the specified attribute to be set. If this attribute is already in session this method will return immediately.

Specified by:

waitForAttribute in interface GridComputeTaskSession

Type Parameters:

K - Attribute key type.

V - Attribute value type.

Parameters:

key - Attribute key to wait for.

Returns:

Value of newly set attribute.

Throws:

InterruptedException - Thrown if wait was interrupted.

waitForAttribute

public <K,V> boolean waitForAttribute(K key,
                             @Nullable
                             V val)
                         throws InterruptedException

Waits for the specified attribute to be set or updated with given value. Note that this method will block even if attribute is set for as long as its value is not equal to the specified.

Specified by:

waitForAttribute in interface GridComputeTaskSession

Type Parameters:

K - Attribute key type.

V - Attribute value type.

Parameters:

key - Attribute key to wait for.

val - Attribute value to wait for. Can be null.

Returns:

Whether or not key/value pair has been received.

Throws:

InterruptedException - Thrown if wait was interrupted.

waitForAttribute

public <K,V> V waitForAttribute(K key,
                       long timeout)
                   throws InterruptedException

Waits for the specified attribute to be set. If this attribute is already in session this method will return immediately.

Specified by:

waitForAttribute in interface GridComputeTaskSession

Type Parameters:

K - Attribute key type.

V - Attribute value type.

Parameters:

key - Attribute key to wait for.

timeout - Timeout in milliseconds to wait for. 0 means indefinite wait.

Returns:

Value of newly set attribute.

Throws:

InterruptedException - Thrown if wait was interrupted.

waitForAttribute

public <K,V> boolean waitForAttribute(K key,
                             @Nullable
                             V val,
                             long timeout)
                         throws InterruptedException

Waits for the specified attribute to be set or updated with given value. Note that this method will block even if attribute is set for as long as its value is not equal to the specified.

Specified by:

waitForAttribute in interface GridComputeTaskSession

Type Parameters:

K - Attribute key type.

V - Attribute value type.

Parameters:

key - Attribute key to wait for.

val - Attribute value to wait for. Can be null.

timeout - Timeout in milliseconds to wait for. 0 means indefinite wait.

Returns:

Whether or not specified key/value pair has been set.

Throws:

InterruptedException - Thrown if wait was interrupted.

waitForAttributes

public Map<?,?> waitForAttributes(Collection<?> keys)
                           throws InterruptedException

Waits for the specified attributes to be set. If these attributes are already in session this method will return immediately.

Specified by:

waitForAttributes in interface GridComputeTaskSession

Parameters:

keys - Attribute keys to wait for.

Returns:

Attribute values mapped by their keys.

Throws:

InterruptedException - Thrown if wait was interrupted.

waitForAttributes

public boolean waitForAttributes(Map<?,?> attrs)
                          throws InterruptedException

Waits for the specified attributes to be set or updated with given values. Note that this method will block even if attributes are set for as long as their values are not equal to the specified.

Specified by:

waitForAttributes in interface GridComputeTaskSession

Parameters:

attrs - Key/value pairs to wait for.

Returns:

Whether or not key/value pairs have been set.

Throws:

InterruptedException - Thrown if wait was interrupted.

waitForAttributes

public Map<?,?> waitForAttributes(Collection<?> keys,
                         long timeout)
                           throws InterruptedException

Waits for the specified attributes to be set. If these attributes are already in session this method will return immediately.

Specified by:

waitForAttributes in interface GridComputeTaskSession

Parameters:

keys - Attribute keys to wait for.

timeout - Timeout in milliseconds to wait for. 0 means indefinite wait.

Returns:

Attribute values mapped by their keys.

Throws:

InterruptedException - Thrown if wait was interrupted.

waitForAttributes

public boolean waitForAttributes(Map<?,?> attrs,
                        long timeout)
                          throws InterruptedException

Waits for the specified attributes to be set or updated with given values. Note that this method will block even if attributes are set for as long as their values are not equal to the specified.

Specified by:

waitForAttributes in interface GridComputeTaskSession

Parameters:

attrs - Key/value pairs to wait for.

timeout - Timeout in milliseconds to wait for. 0 means indefinite wait.

Returns:

Whether or not key/value pair has been set.

Throws:

InterruptedException - Thrown if wait was interrupted.

saveCheckpoint

public void saveCheckpoint(String key,
                  Object state)
                    throws GridException

Saves intermediate state of a job or task to a storage. The storage implementation is defined by GridCheckpointSpi implementation used.

Long running jobs may decide to store intermediate state to protect themselves from failures. This way whenever a job fails over to another node, it can load its previously saved state via GridComputeTaskSession.loadCheckpoint(String) method and continue with execution.

This method defaults checkpoint scope to GridComputeTaskSessionScope.SESSION_SCOPE and implementation will automatically remove the checkpoint at the end of the session. It is analogous to calling saveCheckpoint(String, Serializable, GridCheckpointScope.SESSION_SCOPE, 0.

Specified by:

saveCheckpoint in interface GridComputeTaskSession

Parameters:

key - Key to be used to load this checkpoint in future.

state - Intermediate job state to save.

Throws:

GridException - If failed to save intermediate job state.

See Also:

GridComputeTaskSession.loadCheckpoint(String), GridComputeTaskSession.removeCheckpoint(String), GridCheckpointSpi

saveCheckpoint

public void saveCheckpoint(String key,
                  Object state,
                  GridComputeTaskSessionScope scope,
                  long timeout)
                    throws GridException

Saves intermediate state of a job to a storage. The storage implementation is defined by GridCheckpointSpi implementation used.

Long running jobs may decide to store intermediate state to protect themselves from failures. This way whenever a job fails over to another node, it can load its previously saved state via GridComputeTaskSession.loadCheckpoint(String) method and continue with execution.

The life time of the checkpoint is determined by its timeout and scope. If GridComputeTaskSessionScope.GLOBAL_SCOPE is used, the checkpoint will outlive its session, and can only be removed by calling GridCheckpointSpi.removeCheckpoint(String) from Grid or another task or job.

Specified by:

saveCheckpoint in interface GridComputeTaskSession

Parameters:

key - Key to be used to load this checkpoint in future.

state - Intermediate job state to save.

scope - Checkpoint scope. If equal to GridComputeTaskSessionScope.SESSION_SCOPE, then state will automatically be removed at the end of task execution. Otherwise, if scope is GridComputeTaskSessionScope.GLOBAL_SCOPE then state will outlive its session and can be removed by calling GridComputeTaskSession.removeCheckpoint(String) from another task or whenever timeout expires.

timeout - Maximum time this state should be kept by the underlying storage. Value 0 means that timeout will never expire.

Throws:

GridException - If failed to save intermediate job state.

See Also:

GridComputeTaskSession.loadCheckpoint(String), GridComputeTaskSession.removeCheckpoint(String), GridCheckpointSpi

saveCheckpoint

public void saveCheckpoint(String key,
                  Object state,
                  GridComputeTaskSessionScope scope,
                  long timeout,
                  boolean overwrite)
                    throws GridException

Saves intermediate state of a job or task to a storage. The storage implementation is defined by GridCheckpointSpi implementation used.

Long running jobs may decide to store intermediate state to protect themselves from failures. This way whenever a job fails over to another node, it can load its previously saved state via GridComputeTaskSession.loadCheckpoint(String) method and continue with execution.

The life time of the checkpoint is determined by its timeout and scope. If GridComputeTaskSessionScope.GLOBAL_SCOPE is used, the checkpoint will outlive its session, and can only be removed by calling GridCheckpointSpi.removeCheckpoint(String) from Grid or another task or job.

Specified by:

saveCheckpoint in interface GridComputeTaskSession

Parameters:

key - Key to be used to load this checkpoint in future.

state - Intermediate job state to save.

scope - Checkpoint scope. If equal to GridComputeTaskSessionScope.SESSION_SCOPE, then state will automatically be removed at the end of task execution. Otherwise, if scope is GridComputeTaskSessionScope.GLOBAL_SCOPE then state will outlive its session and can be removed by calling GridComputeTaskSession.removeCheckpoint(String) from another task or whenever timeout expires.

timeout - Maximum time this state should be kept by the underlying storage. Value 0 means that timeout will never expire.

overwrite - Whether or not overwrite checkpoint if it already exists.

Throws:

GridException - If failed to save intermediate job state.

See Also:

GridComputeTaskSession.loadCheckpoint(String), GridComputeTaskSession.removeCheckpoint(String), GridCheckpointSpi

loadCheckpoint

public <T> T loadCheckpoint(String key)
                 throws GridException

Loads job's state previously saved via GridComputeTaskSession.saveCheckpoint(String, Object, GridComputeTaskSessionScope, long) method from an underlying storage for a given key. If state was not previously saved, then null will be returned. The storage implementation is defined by GridCheckpointSpi implementation used.

Long running jobs may decide to store intermediate state to protect themselves from failures. This way whenever a job starts, it can load its previously saved state and continue with execution.

Specified by:

loadCheckpoint in interface GridComputeTaskSession

Type Parameters:

T - Type of the checkpoint state.

Parameters:

key - Key for intermediate job state to load.

Returns:

Previously saved state or null if no state was found for a given key.

Throws:

GridException - If failed to load job state.

See Also:

GridComputeTaskSession.removeCheckpoint(String), GridCheckpointSpi

removeCheckpoint

public boolean removeCheckpoint(String key)
                         throws GridException

Removes previously saved job's state for a given key from an underlying storage. The storage implementation is defined by GridCheckpointSpi implementation used.

Long running jobs may decide to store intermediate state to protect themselves from failures. This way whenever a job starts, it can load its previously saved state and continue with execution.

Specified by:

removeCheckpoint in interface GridComputeTaskSession

Parameters:

key - Key for intermediate job state to load.

Returns:

true if job state was removed, false if state was not found.

Throws:

GridException - If failed to remove job state.

See Also:

GridComputeTaskSession.loadCheckpoint(String), GridCheckpointSpi

getTopology

public Collection<UUID> getTopology()

Gets a collection of grid nodes IDs.

Specified by:

getTopology in interface GridComputeTaskSession

Returns:

Collection of grid nodes IDs for the task's split.

isFullSupport

public boolean isFullSupport()

Specified by:

isFullSupport in interface GridTaskSessionInternal

Returns:

True if checkpoints and attributes are enabled.

toString

public String toString()

Overrides:

toString in class Object