com.xatkit.core.platform.action

Class RuntimeArtifactAction<T extends RuntimePlatform>

java.lang.Object

com.xatkit.core.platform.action.RuntimeAction<T>

com.xatkit.core.platform.action.RuntimeArtifactAction<T>

Type Parameters:

T - the concrete RuntimePlatform subclass type containing the action

All Implemented Interfaces:

Callable<RuntimeActionResult>

Direct Known Subclasses:

RuntimeMessageAction

public abstract class RuntimeArtifactAction<T extends RuntimePlatform>
extends RuntimeAction<T>

An abstract RuntimeAction.

See Also:

RuntimePlatform, RuntimeContexts

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MESSAGE_DELAY The default value of the MESSAGE_DELAY_KEY configuration key (0).
static String	MESSAGE_DELAY_KEY The Configuration key used to specify the delay (in milliseconds) before sending a message.

Fields inherited from class com.xatkit.core.platform.action.RuntimeAction

runtimePlatform, session

Constructor Summary

Constructors

Constructor and Description
RuntimeArtifactAction(T runtimePlatform, XatkitSession session) Constructs a new RuntimeArtifactAction with the provided runtimePlatform and session.

Method Summary

Modifier and Type	Method and Description
protected void	beforeDelay(int delayValue) A hook that is executed before any delay specified by MESSAGE_DELAY_KEY.
RuntimeActionResult	call() Runs the RuntimeArtifactAction and returns its result wrapped in a RuntimeActionResult.
protected abstract XatkitSession	getClientSession() Returns the XatkitSession associated to the client of the artifact to send.
void	init() Retrieve the XatkitSession associated to the client of the artifact and merges it with the current one.

Methods inherited from class com.xatkit.core.platform.action.RuntimeAction

compute, getSession

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_DELAY_KEY

public static String MESSAGE_DELAY_KEY

The Configuration key used to specify the delay (in milliseconds) before sending a message.

This property is set by default to 0, meaning that the bot sends message directly when they are ready.

See Also:

DEFAULT_MESSAGE_DELAY

DEFAULT_MESSAGE_DELAY

public static int DEFAULT_MESSAGE_DELAY

The default value of the MESSAGE_DELAY_KEY configuration key (0).

See Also:

MESSAGE_DELAY_KEY

Constructor Detail

RuntimeArtifactAction

public RuntimeArtifactAction(T runtimePlatform,
                             XatkitSession session)

Constructs a new RuntimeArtifactAction with the provided runtimePlatform and session.

Parameters:

runtimePlatform - the RuntimePlatform containing this action

session - the XatkitSession associated to this action

Throws:

NullPointerException - if the provided runtimePlatform or session is null

See Also:

XatkitSession, RuntimeContexts

Method Detail

init

public void init()

Retrieve the XatkitSession associated to the client of the artifact and merges it with the current one.

This method relies on getClientSession() to retrieve the XatkitSession associated to the client of the artifact, and merges the current session with the client one if they are different. This allows to pass client-independent context variables (e.g. from RuntimeEventProviders) to new client sessions.

Overrides:

init in class RuntimeAction<T extends RuntimePlatform>

Throws:

XatkitException - if the provided session is different from the getClientSession() and the merge operation between the contexts failed

call

public RuntimeActionResult call()

Runs the RuntimeArtifactAction and returns its result wrapped in a RuntimeActionResult.

This method handles IOExceptions by trying to send again the artifact after waiting <number_of_retries>*500 ms, in case the issue is related to network stability. The default number of retries is 3. If the artifact cannot be sent after 3 retries the thrown IOException is wrapped in the returned RuntimeActionResult and handled as a regular exception.

The returned RuntimeActionResult.getExecutionTime() value includes all the attempts to send the artifact.

This method should not be called manually, and is handled by the ExecutionService component that manages and executes RuntimeActions.

This method does not throw any Exception if the underlying RuntimeAction's computation does not complete. Exceptions thrown during the RuntimeArtifactAction's computation can be accessed through the RuntimeActionResult.getThrownException() method.

Specified by:

call in interface Callable<RuntimeActionResult>

Overrides:

call in class RuntimeAction<T extends RuntimePlatform>

Returns:

the RuntimeActionResult containing the raw result of the computation and monitoring information

See Also:

ExecutionService, RuntimeActionResult

beforeDelay

protected void beforeDelay(int delayValue)

A hook that is executed before any delay specified by MESSAGE_DELAY_KEY.

This method can be extended by concrete sub-classes if an action must be performed before a potential delay (e .g. notifying a client application to display writing dots).

Parameters:

delayValue - the value of the delay (in ms)

getClientSession

protected abstract XatkitSession getClientSession()

Returns the XatkitSession associated to the client of the artifact to send.

This method is used by the RuntimeArtifactAction constructor to pass client-independent context variables (e.g. from RuntimeEventProviders) to the client session.

Returns:

the XatkitSession associated to the client of the artifact to send