org.wso2.carbon.data.provider.rdbms

Class AbstractRDBMSDataProvider

java.lang.Object

org.wso2.carbon.data.provider.AbstractDataProvider

org.wso2.carbon.data.provider.rdbms.AbstractRDBMSDataProvider

All Implemented Interfaces:

DataProvider

Direct Known Subclasses:

RDBMSBatchDataProvider, RDBMSStreamingDataProvider

public class AbstractRDBMSDataProvider
extends AbstractDataProvider

RDBMS data provider abstract class.

Constructor Summary

Constructors

Constructor and Description
AbstractRDBMSDataProvider()

Method Summary

Modifier and Type	Method and Description
static void	cleanupConnection(ResultSet rs, Statement stmt, Connection conn)
boolean	configValidator(ProviderConfig providerConfig) Provider configuration validator.
DataSetMetadata	dataSetMetadata() Get the data provider meta data object.
int	getColumnCount()
static Connection	getConnection(String dataSourceName) get connection object for the instance.
String	getGreaterThanWhereSQLQuery()
DataSetMetadata	getMetadata() Get the meta data of the RDBMS provider.
DataSetMetadata.Types	getMetadataTypes(String dataType) Get metadata type(linear,ordinal,time) for the given data type of the data base.
String	getPurgingQuery()
RDBMSDataProviderConfBean	getRdbmsDataProviderConfBean()
RDBMSDataProviderConf	getRdbmsProviderConfig()
String	getRecordLimitQuery()
String	getTotalRecordCountQuery()
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	purging()
boolean	querySanitizingValidator(String query, String tableName)
void	setProviderConfig(ProviderConfig providerConfig) Set the provider configuration, child class will be maintained its own provider configuration bean object.

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

init, publishToEndPoint, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRDBMSDataProvider

public AbstractRDBMSDataProvider()

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.

getConnection

public static Connection getConnection(String dataSourceName)
                                throws SQLException,
                                       org.wso2.carbon.datasource.core.exception.DataSourceException

get connection object for the instance.

Returns:

java.sql.Connection object for the dataProvider Configuration

Throws:

SQLException

org.wso2.carbon.datasource.core.exception.DataSourceException

cleanupConnection

public static void cleanupConnection(ResultSet rs,
                                     Statement stmt,
                                     Connection conn)

getMetadataTypes

public DataSetMetadata.Types getMetadataTypes(String dataType)

Get metadata type(linear,ordinal,time) for the given data type of the data base.

Parameters:

dataType - String data type name provided by the result set metadata

Returns:

String metadata type

querySanitizingValidator

public boolean querySanitizingValidator(String query,
                                        String tableName)

getRecordLimitQuery

public String getRecordLimitQuery()

getPurgingQuery

public String getPurgingQuery()

getTotalRecordCountQuery

public String getTotalRecordCountQuery()

getColumnCount

public int getColumnCount()

getGreaterThanWhereSQLQuery

public String getGreaterThanWhereSQLQuery()

getRdbmsProviderConfig

public RDBMSDataProviderConf getRdbmsProviderConfig()

getRdbmsDataProviderConfBean

public RDBMSDataProviderConfBean getRdbmsDataProviderConfBean()

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.

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

purging

public void purging()

Specified by:

purging in class AbstractDataProvider