org.wso2.carbon.data.provider

Interface DataProvider

All Known Implementing Classes:

AbstractDataProvider, AbstractRDBMSDataProvider, RDBMSBatchDataProvider, RDBMSStreamingDataProvider

public interface DataProvider

Data provider interface.

Method Summary

Modifier and Type	Method and Description
boolean	configValidator(ProviderConfig providerConfig) Provider configuration validator.
DataProvider	init(String sessionID, ProviderConfig providerConfig) Initialize the instance with the session id.
void	start() Start pushing data to the client from the data sources.
void	stop() Stop pushing data to the client and disconnect.

Method Detail

init

DataProvider init(String sessionID,
                  ProviderConfig providerConfig)
           throws DataProviderException

Initialize the instance with the session id.

Parameters:

sessionID - Session id of the session associated with the connection.

Throws:

DataProviderException

start

void start()

Start pushing data to the client from the data sources.

stop

void stop()

Stop pushing data to the client and disconnect.

configValidator

boolean configValidator(ProviderConfig providerConfig)
                 throws DataProviderException

Provider configuration validator.

Parameters:

providerConfig - provider configuration get from the client.

Returns:

validation results.

Throws:

DataProviderException - if the validation failed due to exception.