org.wso2.carbon.data.provider.websocket

Class WebSocketProvider

java.lang.Object

org.wso2.carbon.data.provider.websocket.WebSocketProvider

All Implemented Interfaces:

DataProvider

public class WebSocketProvider
extends Object
implements DataProvider

Constructor Summary

Constructors

Constructor and Description
WebSocketProvider()

Method Summary

Modifier and Type	Method and Description
boolean	configValidator(ProviderConfig providerConfig) Provider configuration validator.
DataSetMetadata	dataSetMetadata() Get the data provider meta data object.
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	start() Start pushing data to the client from the data sources.
void	stop() Stop pushing data to the client and disconnect.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketProvider

public WebSocketProvider()

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.

Specified by:

init in interface DataProvider

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.

start

public void start()

Description copied from interface: DataProvider

Start pushing data to the client from the data sources.

Specified by:

start in interface DataProvider

stop

public void stop()

Description copied from interface: DataProvider

Stop pushing data to the client and disconnect.

Specified by:

stop in interface DataProvider

configValidator

public boolean configValidator(ProviderConfig providerConfig)
                        throws DataProviderException

Description copied from interface: DataProvider

Provider configuration validator.

Specified by:

configValidator in interface DataProvider

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.

Specified by:

providerName in interface DataProvider

Returns:

name of the data provider.

dataSetMetadata

public DataSetMetadata dataSetMetadata()

Description copied from interface: DataProvider

Get the data provider meta data object.

Specified by:

dataSetMetadata in interface DataProvider

Returns:

meta data of the data provider.

providerConfig

public String providerConfig()

Description copied from interface: DataProvider

Get the data provider configuration.

Specified by:

providerConfig in interface DataProvider

Returns:

configuration of the data provider.