org.wso2.siddhi.core

Class SiddhiManager

java.lang.Object

org.wso2.siddhi.core.SiddhiManager

public class SiddhiManager
extends Object

This is the main interface class of Siddhi where users will interact when using Siddhi as a library.

Constructor Summary

Constructors

Constructor and Description
SiddhiManager() Creates a Siddhi Manager instance with default SiddhiContext.

Method Summary

Modifier and Type	Method and Description
ExecutionPlanRuntime	createExecutionPlanRuntime(org.wso2.siddhi.query.api.ExecutionPlan executionPlan) Method to add stream definitions, partitions and queries of an execution plan
ExecutionPlanRuntime	createExecutionPlanRuntime(String executionPlan) Method to add execution plan in the form of a string.
ExecutionPlanRuntime	getExecutionPlanRuntime(String executionPlanName) Method to retrieve already submitted execution plan by providing the name.
void	persist() Method used persist state of current Siddhi Manager instance.
void	restoreLastState() Method used to restore state of Current Siddhi Manager instance.
void	setDataSource(String dataSourceName, DataSource dataSource) Method used to add Carbon DataSources to Siddhi Manager to utilize them for event tables.
void	setExtension(String name, Class clazz) Method used to register extensions to the Siddhi Manager.
void	setPersistenceStore(PersistenceStore persistenceStore) Method to set persistence for the Siddhi Manager instance.
void	setStatisticsConfiguration(StatisticsConfiguration statisticsConfiguration) Method to integrate Carbon Metrics into Siddhi
void	shutdown() Method to shutdown Siddhi Manager
void	validateExecutionPlan(org.wso2.siddhi.query.api.ExecutionPlan executionPlan) Method to validate provided ExecutionPlan object.
void	validateExecutionPlan(String executionPlan) Method to validate provided String representation of Execution Plan.

Methods inherited from class java.lang.Object

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

Constructor Detail

SiddhiManager

public SiddhiManager()

Creates a Siddhi Manager instance with default SiddhiContext. This is the only method to create a new Siddhi Manager instance which is the main interface when you use Siddhi as a library.

Method Detail

createExecutionPlanRuntime

public ExecutionPlanRuntime createExecutionPlanRuntime(org.wso2.siddhi.query.api.ExecutionPlan executionPlan)

Method to add stream definitions, partitions and queries of an execution plan

Parameters:

executionPlan - executionPlan which contains stream definitions,queries and partitions

Returns:

executionPlanRuntime corresponding to the given executionPlan

createExecutionPlanRuntime

public ExecutionPlanRuntime createExecutionPlanRuntime(String executionPlan)

Method to add execution plan in the form of a string. You can add valid set of Siddhi queries as a String to this method and receive ExecutionPlanRuntime object representing the queries.

Parameters:

executionPlan - String representation of Siddhi queries

Returns:

Execution Plan Runtime

getExecutionPlanRuntime

public ExecutionPlanRuntime getExecutionPlanRuntime(String executionPlanName)

Method to retrieve already submitted execution plan by providing the name.

Parameters:

executionPlanName - Name of the required Execution Plan

Returns:

Execution Plan Runtime representing the provided name

validateExecutionPlan

public void validateExecutionPlan(org.wso2.siddhi.query.api.ExecutionPlan executionPlan)

Method to validate provided ExecutionPlan object. Method will throw ExecutionPlanValidationException if submitted Execution Plan has errors.

Parameters:

executionPlan - Execution plan to be validated.

validateExecutionPlan

public void validateExecutionPlan(String executionPlan)

Method to validate provided String representation of Execution Plan. Method will throw ExecutionPlanValidationException if submitted Siddhi queries have errors.

Parameters:

executionPlan - execution plan

setPersistenceStore

public void setPersistenceStore(PersistenceStore persistenceStore)

Method to set persistence for the Siddhi Manager instance. InMemoryPersistenceStore is the default persistence store implementation users can utilize.

Parameters:

persistenceStore - Persistence Store implementation to be used.

setExtension

public void setExtension(String name,
                         Class clazz)

Method used to register extensions to the Siddhi Manager. But extension classes should be present in classpath.

Parameters:

name - Name of the extension as mentioned in .siddhiext

clazz - Class name of the implementation

setDataSource

public void setDataSource(String dataSourceName,
                          DataSource dataSource)

Method used to add Carbon DataSources to Siddhi Manager to utilize them for event tables.

Parameters:

dataSourceName - Name of the DataSource

dataSource - Object representing DataSource

setStatisticsConfiguration

public void setStatisticsConfiguration(StatisticsConfiguration statisticsConfiguration)

Method to integrate Carbon Metrics into Siddhi

Parameters:

statisticsConfiguration - statistics configuration

shutdown

public void shutdown()

Method to shutdown Siddhi Manager

persist

public void persist()

Method used persist state of current Siddhi Manager instance. This will internally call all ExecutionPlanRuntimes within Siddhi Manager.

restoreLastState

public void restoreLastState()

Method used to restore state of Current Siddhi Manager instance. This will internally call all ExecutionPlanRuntimes within Siddhi Manager.