org.wso2.carbon.data.provider

Class AbstractDataProvider

java.lang.Object

org.wso2.carbon.data.provider.AbstractDataProvider

All Implemented Interfaces:

DataProvider

Direct Known Subclasses:

AbstractRDBMSDataProvider

public abstract class AbstractDataProvider
extends Object
implements DataProvider

Abstract data provider class.

Constructor Summary

Constructors

Constructor and Description
AbstractDataProvider()

Method Summary

Modifier and Type	Method and Description
abstract boolean	configValidator(ProviderConfig providerConfig) Provider configuration validator.
abstract DataSetMetadata	getMetadata() Get the meta data of the RDBMS provider.
DataProvider	init(String sessionID, ProviderConfig providerConfig) Initialize the instance with the session id.
abstract void	publish(String sessionID)
void	publishToEndPoint(ArrayList<Object[]> data, String sessionID)
abstract void	purging()
abstract void	setProviderConfig(ProviderConfig providerConfig) Set the provider configuration, child class will be maintained its own provider configuration bean object.
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

AbstractDataProvider

public AbstractDataProvider()

Method Detail

init

public DataProvider init(String sessionID,
                         ProviderConfig providerConfig)
                  throws DataProviderException

Description copied from interface: DataProvider

Initialize the instance with the session id.

Specified by:

init in interface DataProvider

Parameters:

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

Throws:

DataProviderException

stop

public void stop()

Description copied from interface: DataProvider

Stop pushing data to the client and disconnect.

Specified by:

stop in interface DataProvider

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

publishToEndPoint

public void publishToEndPoint(ArrayList<Object[]> data,
                              String sessionID)

configValidator

public abstract 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.

publish

public abstract void publish(String sessionID)

purging

public abstract void purging()

setProviderConfig

public abstract void setProviderConfig(ProviderConfig providerConfig)

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

Parameters:

providerConfig - client provided configuration.

getMetadata

public abstract DataSetMetadata getMetadata()

Get the meta data of the RDBMS provider.

Returns:

rdbms meta data object.