Package io.siddhi.core

Interface SiddhiAppRuntime

All Known Implementing Classes:

SiddhiAppRuntimeImpl

public interface SiddhiAppRuntime

Keep streamDefinitions, partitionRuntimes, queryRuntimes of an SiddhiApp and streamJunctions and inputHandlers used.

Method Summary

Modifier and Type	Method	Description
void	addCallback(String queryName, QueryCallback callback)
void	addCallback(String streamId, StreamCallback streamCallback)
void	clearAllRevisions()
SiddhiDebugger	debug()
void	enablePlayBack(boolean playBackEnabled, Long idleTime, Long incrementInMilliseconds)	To enable and disable Siddhi App playback mode on runtime along with optional parameters.
Map<String,io.siddhi.query.api.definition.AggregationDefinition>	getAggregationDefinitionMap()	Get the aggregation definition map.
InputHandler	getInputHandler(String streamId)
String	getName()
io.siddhi.query.api.definition.Attribute[]	getOnDemandQueryOutputAttributes(io.siddhi.query.api.execution.query.OnDemandQuery onDemandQuery)
io.siddhi.query.api.definition.Attribute[]	getOnDemandQueryOutputAttributes(String onDemandQuery)
Map<String,Map<String,io.siddhi.query.api.definition.AbstractDefinition>>	getPartitionedInnerStreamDefinitionMap()
Collection<PartitionRuntime>	getPartitions()
Collection<QueryRuntime>	getQueries()
Set<String>	getQueryNames()	Get the names of the available queries.
io.siddhi.query.api.SiddhiApp	getSiddhiApp()
Collection<List<Sink>>	getSinks()
Collection<List<Source>>	getSources()
Level	getStatisticsLevel()	Method to check the Siddhi App statistics level enabled.
io.siddhi.query.api.definition.Attribute[]	getStoreQueryOutputAttributes(io.siddhi.query.api.execution.query.StoreQuery storeQuery)	Deprecated.
io.siddhi.query.api.definition.Attribute[]	getStoreQueryOutputAttributes(String storeQuery)	Deprecated.
Map<String,io.siddhi.query.api.definition.StreamDefinition>	getStreamDefinitionMap()	Get the stream definition map.
Map<String,io.siddhi.query.api.definition.TableDefinition>	getTableDefinitionMap()	Get the table definition map.
TableInputHandler	getTableInputHandler(String tableId)
Collection<Table>	getTables()
Collection<Trigger>	getTiggers()
Set<String>	getWarnings()	Method to get Siddhi App runtime warnings.
Map<String,io.siddhi.query.api.definition.WindowDefinition>	getWindowDefinitionMap()	Get the window definition map.
Collection<Window>	getWindows()
void	handleExceptionWith(com.lmax.disruptor.ExceptionHandler<Object> exceptionHandler)
void	handleRuntimeExceptionWith(ExceptionListener exceptionListener)
PersistenceReference	persist()
Event[]	query(io.siddhi.query.api.execution.query.OnDemandQuery storeQuery)
Event[]	query(io.siddhi.query.api.execution.query.StoreQuery storeQuery)	Deprecated.
Event[]	query(String onDemandQuery)
void	removeCallback(QueryCallback streamCallback)
void	removeCallback(StreamCallback streamCallback)
void	restore(byte[] snapshot)
String	restoreLastRevision()
void	restoreRevision(String revision)
void	setPurgingEnabled(boolean purgingEnabled)
void	setStatisticsLevel(Level level)	To enable, disable and change Siddhi App statistics level on runtime.
void	shutdown()
byte[]	snapshot()
void	start()
void	startSources()
void	startWithoutSources()

Method Detail

getName

String getName()

getSiddhiApp

io.siddhi.query.api.SiddhiApp getSiddhiApp()

getStreamDefinitionMap

Map<String,io.siddhi.query.api.definition.StreamDefinition> getStreamDefinitionMap()

Get the stream definition map.

Returns:

Map of StreamDefinitions.

getTableDefinitionMap

Map<String,io.siddhi.query.api.definition.TableDefinition> getTableDefinitionMap()

Get the table definition map.

Returns:

Map of TableDefinitions.

getWindowDefinitionMap

Map<String,io.siddhi.query.api.definition.WindowDefinition> getWindowDefinitionMap()

Get the window definition map.

Returns:

Map of WindowDefinitions.

getAggregationDefinitionMap

Map<String,io.siddhi.query.api.definition.AggregationDefinition> getAggregationDefinitionMap()

Get the aggregation definition map.

Returns:

Map of AggregationDefinitions.

getQueryNames

Set<String> getQueryNames()

Get the names of the available queries.

Returns:

string set of query names.

getPartitionedInnerStreamDefinitionMap

Map<String,Map<String,io.siddhi.query.api.definition.AbstractDefinition>> getPartitionedInnerStreamDefinitionMap()

getSources

Collection<List<Source>> getSources()

getSinks

Collection<List<Sink>> getSinks()

getTables

Collection<Table> getTables()

getWindows

Collection<Window> getWindows()

getTiggers

Collection<Trigger> getTiggers()

getQueries

Collection<QueryRuntime> getQueries()

getPartitions

Collection<PartitionRuntime> getPartitions()

addCallback

void addCallback(String streamId,
                 StreamCallback streamCallback)

addCallback

void addCallback(String queryName,
                 QueryCallback callback)

removeCallback

void removeCallback(StreamCallback streamCallback)

removeCallback

void removeCallback(QueryCallback streamCallback)

query

Event[] query(String onDemandQuery)

query

@Deprecated
Event[] query(io.siddhi.query.api.execution.query.StoreQuery storeQuery)

Deprecated.

query

Event[] query(io.siddhi.query.api.execution.query.OnDemandQuery storeQuery)

getStoreQueryOutputAttributes

@Deprecated
io.siddhi.query.api.definition.Attribute[] getStoreQueryOutputAttributes(String storeQuery)

Deprecated.

getStoreQueryOutputAttributes

@Deprecated
io.siddhi.query.api.definition.Attribute[] getStoreQueryOutputAttributes(io.siddhi.query.api.execution.query.StoreQuery storeQuery)

Deprecated.

getOnDemandQueryOutputAttributes

io.siddhi.query.api.definition.Attribute[] getOnDemandQueryOutputAttributes(String onDemandQuery)

getOnDemandQueryOutputAttributes

io.siddhi.query.api.definition.Attribute[] getOnDemandQueryOutputAttributes(io.siddhi.query.api.execution.query.OnDemandQuery onDemandQuery)

getInputHandler

InputHandler getInputHandler(String streamId)

getTableInputHandler

TableInputHandler getTableInputHandler(String tableId)

setPurgingEnabled

void setPurgingEnabled(boolean purgingEnabled)

start

void start()

startWithoutSources

void startWithoutSources()

startSources

void startSources()

shutdown

void shutdown()

debug

SiddhiDebugger debug()

persist

PersistenceReference persist()

snapshot

byte[] snapshot()

restore

void restore(byte[] snapshot)
      throws CannotRestoreSiddhiAppStateException

Throws:

CannotRestoreSiddhiAppStateException

restoreRevision

void restoreRevision(String revision)
              throws CannotRestoreSiddhiAppStateException

Throws:

CannotRestoreSiddhiAppStateException

restoreLastRevision

String restoreLastRevision()
                    throws CannotRestoreSiddhiAppStateException

Throws:

CannotRestoreSiddhiAppStateException

clearAllRevisions

void clearAllRevisions()
                throws CannotClearSiddhiAppStateException

Throws:

CannotClearSiddhiAppStateException

handleExceptionWith

void handleExceptionWith(com.lmax.disruptor.ExceptionHandler<Object> exceptionHandler)

handleRuntimeExceptionWith

void handleRuntimeExceptionWith(ExceptionListener exceptionListener)

getStatisticsLevel

Level getStatisticsLevel()

Method to check the Siddhi App statistics level enabled.

Returns:

Level value of Siddhi App statistics state

setStatisticsLevel

void setStatisticsLevel(Level level)

To enable, disable and change Siddhi App statistics level on runtime.

Parameters:

level - whether statistics is OFF, BASIC or DETAIL

enablePlayBack

void enablePlayBack(boolean playBackEnabled,
                    Long idleTime,
                    Long incrementInMilliseconds)

To enable and disable Siddhi App playback mode on runtime along with optional parameters.

Parameters:

playBackEnabled - whether playback is enabled or not

idleTime -

incrementInMilliseconds -

getWarnings

Set<String> getWarnings()

Method to get Siddhi App runtime warnings.

Returns:

list of recorded runtime warnings.