Package org.wso2.carbon.data.provider.siddhi

Class SiddhiProvider

java.lang.Object

org.wso2.carbon.data.provider.AbstractDataProvider

org.wso2.carbon.data.provider.siddhi.SiddhiProvider

All Implemented Interfaces:

DataProvider

public class SiddhiProvider
extends AbstractDataProvider

Constructor Summary

Constructors

Constructor	Description
SiddhiProvider()

Method Summary

Modifier and Type	Method	Description
boolean	configValidator(ProviderConfig providerConfig)	Provider configuration validator.
DataSetMetadata	dataSetMetadata()	Get the data provider meta data object.
DataSetMetadata	getMetadata()	Get the meta data of the RDBMS provider.
SiddhiDataProviderConfig	getSiddhiDataProviderConfig()
DataProvider	init(String topic, String sessionId, com.google.gson.JsonElement jsonElement)	Initialize the instance with the session id.
String	providerConfig()	Get the data provider configuration.
String	providerName()	Get the data provider name.
void	publish(String topic, String sessionId)
void	publishWithPagination(com.google.gson.JsonElement jsonElement, String topic, String sessionId)
void	purging()
void	setProviderConfig(ProviderConfig providerConfig)	Set the provider configuration, child class will be maintained its own provider configuration bean object.
void	stop()	Stop pushing data to the client and disconnect.

Methods inherited from class org.wso2.carbon.data.provider.AbstractDataProvider

init, publishToEndPoint, start

Methods inherited from class java.lang.Object

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

Constructor Detail

SiddhiProvider

public SiddhiProvider()

Method Detail

init

public DataProvider init(String topic,
                         String sessionId,
                         com.google.gson.JsonElement jsonElement)
                  throws DataProviderException

Description copied from interface: DataProvider

Initialize the instance with the session id.

Parameters:

topic - to receive topic messages, data provider send event with this topic.

sessionId - data provider send event for this session.

jsonElement - provider configuration message in json format.

Returns:

data provider initialized with provider configuration.

Throws:

DataProviderException - if there any initialization failures.

configValidator

public boolean configValidator(ProviderConfig providerConfig)
                        throws DataProviderException

Description copied from interface: DataProvider

Provider configuration validator.

Specified by:

configValidator in interface DataProvider

Specified by:

configValidator in class AbstractDataProvider

Parameters:

providerConfig - provider configuration get from the client.

Returns:

validation results.

Throws:

DataProviderException - if the validation failed due to exception.

providerName

public String providerName()

Description copied from interface: DataProvider

Get the data provider name.

Returns:

name of the data provider.

dataSetMetadata

public DataSetMetadata dataSetMetadata()

Description copied from interface: DataProvider

Get the data provider meta data object.

Returns:

meta data of the data provider.

providerConfig

public String providerConfig()

Description copied from interface: DataProvider

Get the data provider configuration.

Returns:

configuration of the data provider.

publish

public void publish(String topic,
                    String sessionId)

Specified by:

publish in class AbstractDataProvider

publishWithPagination

public void publishWithPagination(com.google.gson.JsonElement jsonElement,
                                  String topic,
                                  String sessionId)

purging

public void purging()

Specified by:

purging in class AbstractDataProvider

setProviderConfig

public void setProviderConfig(ProviderConfig providerConfig)

Description copied from class: AbstractDataProvider

Set the provider configuration, child class will be maintained its own provider configuration bean object.

Specified by:

setProviderConfig in class AbstractDataProvider

Parameters:

providerConfig - client provided configuration.

getMetadata

public DataSetMetadata getMetadata()

Description copied from class: AbstractDataProvider

Get the meta data of the RDBMS provider.

Specified by:

getMetadata in class AbstractDataProvider

Returns:

rdbms meta data object.

stop

public void stop()

Description copied from interface: DataProvider

Stop pushing data to the client and disconnect.

Specified by:

stop in interface DataProvider

Overrides:

stop in class AbstractDataProvider

getSiddhiDataProviderConfig

public SiddhiDataProviderConfig getSiddhiDataProviderConfig()