XatkitCore (Xatkit Runtime 4.0.1-SNAPSHOT API)

java.lang.Object
- com.xatkit.core.XatkitCore

```
public class XatkitCore
extends Object
```
The core component of the xatkit framework.
This class is constructed from an ExecutionModel, that defines the Intent to Action bindings that are executed by the application. Constructing an instance of this class will load the RuntimePlatforms used by the provided ExecutionModel, and enable the corresponding RuntimeActions. It also creates an instance of EventDefinitionRegistry that can be accessed to retrieve and manage EventDefinition .

See Also:

EventDefinitionRegistry, RuntimePlatformRegistry, ExecutionService, RuntimePlatform

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ABSTRACT_PLATFORM_BINDINGS_PREFIX` The `Configuration` key prefix to store the abstract platform bindings.
`static String`	`CONFIGURATION_FOLDER_PATH_KEY` The `Configuration` key to store the configuration folder path.
`static String`	`CUSTOM_LIBRARIES_KEY_PREFIX` The `Configuration` key prefix to store the custom library paths.
`static String`	`CUSTOM_PLATFORMS_KEY_PREFIX` The `Configuration` key prefix to store the custom platform paths.
`static String`	`EXECUTION_MODEL_KEY` The `Configuration` key to store the `ExecutionModel` to use.
`protected ResourceSet`	`executionResourceSet` The `ResourceSet` used to load the `ExecutionModel` and the referenced models.
`protected ExecutionService`	`executionService` The `ExecutionService` used to handle `EventInstance`s and execute the associated `RuntimeAction`s.

Constructor Summary

Constructors
Constructor and Description

XatkitCore(Configuration configuration)
Constructs a new XatkitCore instance from the provided configuration.

Constructors
Constructor and Description
`XatkitCore(Configuration configuration)` Constructs a new `XatkitCore` instance from the provided `configuration`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearXatkitSessions()` Invalidates all the `XatkitSession`s and clear the session registry.
`protected void`	`finalize()` Logs a warning message and stops the running services if the `XatkitCore` hasn't been closed properly.
`EventDefinitionRegistry`	`getEventDefinitionRegistry()` Returns the `EventDefinitionRegistry` associated to this instance.
`protected com.xatkit.execution.ExecutionModel`	`getExecutionModel(Configuration configuration)` Retrieves the `ExecutionModel` from the provided `property`.
`ExecutionService`	`getExecutionService()` Returns the underlying `ExecutionService`.
`Formatter`	`getFormatter(String formatterName)` Returns the `Formatter` associated to the provided `formatterName`.
`IntentRecognitionProvider`	`getIntentRecognitionProvider()` Returns the underlying `IntentRecognitionProvider`.
`XatkitSession`	`getOrCreateXatkitSession(String sessionId)` Retrieves or creates the `XatkitSession` associated to the provided `sessionId`.
`RuntimePlatformRegistry`	`getRuntimePlatformRegistry()` Returns the `RuntimePlatformRegistry` associated to this instance.
`XatkitServer`	`getXatkitServer()` Returns the `XatkitServer` used to capture incoming webhooks.
`XatkitSession`	`getXatkitSession(String sessionId)` Returns the `XatkitSession` associated to the provided `sessionId`
`Iterable<XatkitSession>`	`getXatkitSessions()`
`boolean`	`isShutdown()` Returns whether the `XatkitCore` client is shutdown.
`void`	`registerFormatter(String formatterName, Formatter formatter)` Registers the provided `formatter` with the given `formatterName`.
`void`	`shutdown()` Shuts down the `XatkitCore` and the underlying engines.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXECUTION_MODEL_KEY
```
public static String EXECUTION_MODEL_KEY
```
    The Configuration key to store the ExecutionModel to use.
    
    See Also:
    
    XatkitCore(Configuration)
  - CONFIGURATION_FOLDER_PATH_KEY
```
public static String CONFIGURATION_FOLDER_PATH_KEY
```
    The Configuration key to store the configuration folder path.
  - CUSTOM_PLATFORMS_KEY_PREFIX
```
public static String CUSTOM_PLATFORMS_KEY_PREFIX
```
    The Configuration key prefix to store the custom platform paths.
    This prefix is used to specify the paths of the custom platforms that are needed by the provided ExecutionModel. Note that custom platform path properties are only required if the ExecutionModel defines an alias for the imported platform models. ExecutionModels relying on absolute paths are directly loaded from the file system, but are not portable.
    Custom platform properties must be set following this pattern: CUSTOM_PLATFORMS_KEY_PREFIX + <platform alias> = <platform path>.
  - CUSTOM_LIBRARIES_KEY_PREFIX
```
public static String CUSTOM_LIBRARIES_KEY_PREFIX
```
    The Configuration key prefix to store the custom library paths.
    This prefix is used to specify the paths of the custom libraries that are needed by the provided ExecutionModel. Note that custom library path properties are only required if the ExecutionModel defines an alias for the imported library models. ExecutionModels relying on absolute paths are directly loaded from the file system, but are not portable.
    Custom library properties must be set following this pattern: CUSTOM_LIBRARIES_KEY_PREFIX + <library alias> = <library path>.
  - ABSTRACT_PLATFORM_BINDINGS_PREFIX
```
public static String ABSTRACT_PLATFORM_BINDINGS_PREFIX
```
    The Configuration key prefix to store the abstract platform bindings.
    This prefix is used to specify the path of the concrete RuntimePlatform to bind to their abstract definition in the provided execution model. Note that each used abstract platform needs to be bound separately, following this pattern ABSTRACT_PLATFORM_BINDINGS_PREFIX + <abstract platform name> = <concrete platform path>.
  - executionResourceSet
```
protected ResourceSet executionResourceSet
```
    The ResourceSet used to load the ExecutionModel and the referenced models.
    The executionResourceSet is initialized with the initializeExecutionResourceSet() method, that loads the core platforms models from the classpath, and dynamically retrieves the custom platforms and library models.
    
    See Also:
    
    CUSTOM_PLATFORMS_KEY_PREFIX, CUSTOM_LIBRARIES_KEY_PREFIX
  - executionService
```
protected ExecutionService executionService
```
    The ExecutionService used to handle EventInstances and execute the associated RuntimeActions.
    
    See Also:
    
    ExecutionService.handleEventInstance(EventInstance, XatkitSession), RuntimeAction
- Constructor Detail
  - XatkitCore
```
public XatkitCore(Configuration configuration)
```
    Constructs a new XatkitCore instance from the provided configuration.
    The provided configuration must provide values for the following key (note that additional values may be required according to the used RuntimeEventProviders and RuntimePlatforms):
    - xatkit.execution.model: the ExecutionModel defining the Intent to Action bindings (or the string representing its location)
    Parameters:
    
    configuration - the Configuration to construct the instance from
    
    Throws:
    
    NullPointerException - if the provided configuration or one of the mandatory values is null
    
    XatkitException - if the framework is not able to retrieve the ExecutionModel
    
    See Also:
    
    ExecutionModel
- Method Detail
  - registerFormatter
```
public void registerFormatter(String formatterName,
                              Formatter formatter)
```
    Registers the provided formatter with the given formatterName.
    
    Parameters:
    
    formatterName - the name of the formatter
    
    formatter - the Formatter to register
  - getFormatter
```
public Formatter getFormatter(String formatterName)
```
    Returns the Formatter associated to the provided formatterName.
    
    Parameters:
    
    formatterName - the name of the Formatter to retrieve
    
    Returns:
    
    the Formatter
    
    Throws:
    
    XatkitException - if there is no Formatter associated to the provided formatterName.
  - getExecutionModel
```
protected com.xatkit.execution.ExecutionModel getExecutionModel(Configuration configuration)
```
    Retrieves the ExecutionModel from the provided property.
    This method checks if the provided property is already an in-memory ExecutionModel instance, or if it is defined by a String or an URI representing the path of the model. In that case, the method attempts to load the model at the provided location and returns it.
    This method supports loading of model path defined by Strings and URIs. Support for additional types is planned in the next releases.
    
    Parameters:
    
    configuration - the Configuration to retrieve the ExecutionModel from
    
    Returns:
    
    the ExecutionModel from the provided property
    
    Throws:
    
    XatkitException - if the provided property type is not handled, if the underlying Resource cannot be loaded or if it does not contain an ExecutionModel top-level element, or if the loaded ExecutionModel is empty.
    
    NullPointerException - if the provided property is null
  - getExecutionService
```
public ExecutionService getExecutionService()
```
    Returns the underlying ExecutionService.
    
    Returns:
    
    the underlying ExecutionService
  - getIntentRecognitionProvider
```
public IntentRecognitionProvider getIntentRecognitionProvider()
```
    Returns the underlying IntentRecognitionProvider.
    Note: this method is designed to ease debugging and testing, direct interactions with the IntentRecognitionProvider API may create consistency issues. In particular, xatkit does not ensure that RuntimeActions will be triggered in case of direct queries to the IntentRecognitionProvider API.
    
    Returns:
    
    the underlying IntentRecognitionProvider
  - getEventDefinitionRegistry
```
public EventDefinitionRegistry getEventDefinitionRegistry()
```
    Returns the EventDefinitionRegistry associated to this instance.
    This registry is used to cache EventDefinitions and IntentDefinitions from the input ExecutionModel and provides utility methods to retrieve specific EventDefinition and IntentDefinition and clear the cache.
    
    Returns:
    
    the EventDefinitionRegistry associated to this instance
  - getRuntimePlatformRegistry
```
public RuntimePlatformRegistry getRuntimePlatformRegistry()
```
    Returns the RuntimePlatformRegistry associated to this instance.
    This registry is used to cache loaded RuntimePlatforms, and provides utility method to retrieve, unregister, and clear them.
    
    Returns:
    
    the RuntimePlatformRegistry associated to this instance
  - getXatkitServer
```
public XatkitServer getXatkitServer()
```
    Returns the XatkitServer used to capture incoming webhooks.
    
    Returns:
    
    the XatkitServer used to capture incoming webhooks
  - shutdown
```
public void shutdown()
```
    Shuts down the XatkitCore and the underlying engines.
    This method shuts down the underlying IntentRecognitionProvider, unloads and shuts down all the RuntimePlatforms associated to this instance, unregisters the EventDefinition from the associated EventDefinitionRegistry, shuts down the ExecutionService, and stops the XatkitServer.
    Note: calling this method invalidates the IntentRecognitionProvider connection, and thus shuts down intent recognition features. New RuntimeActions cannot be processed either.
    
    See Also:
    
    IntentRecognitionProvider.shutdown(), RuntimePlatform.shutdown(), EventDefinitionRegistry.unregisterEventDefinition(EventDefinition), ExecutionService.shutdown(), XatkitServer.stop()
  - isShutdown
```
public boolean isShutdown()
```
    Returns whether the XatkitCore client is shutdown.
    This class is considered as shutdown if its underlying ExecutionService, IntentRecognitionProvider, and XatkitServer are shutdown.
    
    Returns:
    
    true if the XatkitCore client is shutdown, false otherwise
  - getOrCreateXatkitSession
```
public XatkitSession getOrCreateXatkitSession(String sessionId)
```
    Retrieves or creates the XatkitSession associated to the provided sessionId.
    If the XatkitSession does not exist a new one is created using IntentRecognitionProvider.createSession(String).
    
    Parameters:
    
    sessionId - the identifier to get or retrieve a session from
    
    Returns:
    
    the XatkitSession associated to the provided sessionId
    
    Throws:
    
    NullPointerException - if the provided sessionId is null
  - getXatkitSession
```
public XatkitSession getXatkitSession(String sessionId)
```
    Returns the XatkitSession associated to the provided sessionId
    
    Parameters:
    
    sessionId - the identifier to retrieve the session from
    
    Returns:
    
    the XatkitSession associated to the provided sessionId
    
    Throws:
    
    NullPointerException - if the provided sessionId is null
  - getXatkitSessions
```
public Iterable<XatkitSession> getXatkitSessions()
```
  - clearXatkitSessions
```
public void clearXatkitSessions()
```
    Invalidates all the XatkitSessions and clear the session registry.
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Logs a warning message and stops the running services if the XatkitCore hasn't been closed properly.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable - if an error occurred when stopping the running services.

Class XatkitCore

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXECUTION_MODEL_KEY

CONFIGURATION_FOLDER_PATH_KEY

CUSTOM_PLATFORMS_KEY_PREFIX

CUSTOM_LIBRARIES_KEY_PREFIX

ABSTRACT_PLATFORM_BINDINGS_PREFIX

executionResourceSet

executionService

Constructor Detail

XatkitCore

Method Detail

registerFormatter

getFormatter

getExecutionModel

getExecutionService

getIntentRecognitionProvider

getEventDefinitionRegistry

getRuntimePlatformRegistry

getXatkitServer

shutdown

isShutdown

getOrCreateXatkitSession

getXatkitSession

getXatkitSessions

clearXatkitSessions

finalize