com.xatkit.core.platform.io

Class RuntimeEventProvider<T extends RuntimePlatform>

java.lang.Object

com.xatkit.core.platform.io.RuntimeEventProvider<T>

Type Parameters:

T - the concrete RuntimePlatform subclass type containing the provider

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

WebhookEventProvider

public abstract class RuntimeEventProvider<T extends RuntimePlatform>
extends Object
implements Runnable

An abstract class representing user input providers.

Concrete implementations of this class are dynamically instantiated by the XatkitCore component, and use it to notify the engine about new messages to handle. Note that RuntimeEventProvider instances are started in a dedicated Thread.

Instances of this class can be configured using the Configuration-based constructor, that enable to pass additional parameters to the constructor.

Field Summary

Fields

Modifier and Type	Field and Description
protected T	runtimePlatform The RuntimePlatform subclass containing this action.
protected XatkitCore	xatkitCore The XatkitCore instance used to handle events.

Constructor Summary

Constructors

Constructor and Description
RuntimeEventProvider(T runtimePlatform) Constructs a new RuntimeEventProvider with the provided runtimePlatform.
RuntimeEventProvider(T runtimePlatform, Configuration configuration) Constructs a new RuntimeEventProvider with the provided runtimePlatform and configuration.

Method Summary

Modifier and Type	Method and Description
void	broadcastEventInstance(com.xatkit.intent.EventInstance eventInstance)
void	close() Closes the RuntimeEventProvider and releases internal resources.
T	getRuntimePlatform() Returns the RuntimePlatform containing this RuntimeEventProvider.
void	sendEventInstance(com.xatkit.intent.EventInstance eventInstance, XatkitSession session) Sends the provided eventInstance and session for computation to the Xatkit core component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Field Detail

xatkitCore

protected XatkitCore xatkitCore

The XatkitCore instance used to handle events.

This attribute is a shortcut for runtimePlatform.getXatkitCore().

runtimePlatform

protected T extends RuntimePlatform runtimePlatform

The RuntimePlatform subclass containing this action.

Constructor Detail

RuntimeEventProvider

public RuntimeEventProvider(T runtimePlatform)

Constructs a new RuntimeEventProvider with the provided runtimePlatform.

Note: this constructor should be used by RuntimeEventProviders that do not require additional parameters to be initialized. In that case see RuntimeEventProvider(RuntimePlatform, Configuration).

Parameters:

runtimePlatform - the RuntimePlatform containing this RuntimeEventProvider

Throws:

NullPointerException - if the provided runtimePlatform is null

RuntimeEventProvider

public RuntimeEventProvider(T runtimePlatform,
                            Configuration configuration)

Constructs a new RuntimeEventProvider with the provided runtimePlatform and configuration.

Note: this constructor will be called by xatkit internal engine when initializing the XatkitCore component. Subclasses implementing this constructor typically need additional parameters to be initialized, that can be provided in the configuration.

Parameters:

runtimePlatform - the RuntimePlatform containing this RuntimeEventProvider

configuration - the Configuration used to initialize the RuntimeEventProvider

Throws:

NullPointerException - if the provided runtimePlatform is null

Method Detail

getRuntimePlatform

public T getRuntimePlatform()

Returns the RuntimePlatform containing this RuntimeEventProvider.

Returns:

the RuntimePlatform containing this RuntimeEventProvider

sendEventInstance

public void sendEventInstance(com.xatkit.intent.EventInstance eventInstance,
                              XatkitSession session)

Sends the provided eventInstance and session for computation to the Xatkit core component.

This method sets the triggeredBy field of the provided eventInstance with the name of the containing platform of this provider.

This method can be extended to perform specific checks before triggering actions (e.g. ensure that a specific context variable has been set).

Parameters:

eventInstance - the EventInstance to send to the Xatkit core component

session - the XatkitSession associated to the provided eventInstance

broadcastEventInstance

public void broadcastEventInstance(com.xatkit.intent.EventInstance eventInstance)

close

public void close()

Closes the RuntimeEventProvider and releases internal resources.

This method should be overridden by concrete subclasses that manipulate internal resources that require to be explicitly closed.