org.pentaho.platform.api.data
Interface IDatasourceService

All Known Implementing Classes:

AbstractTenantAwareDatasourceService, BaseDatasourceService, JndiDatasourceService, NonPooledDatasourceService, NonPooledOrJndiDatasourceService, PooledDatasourceService, PooledOrJndiDatasourceService, TenantAwareLoginParsingDatasourceService, TenantAwareSessionVariableDatasourceService

public interface IDatasourceService

This interface defines Pentaho's DatasourceService API

Author:

Ramaiz Mansoor (rmansoor@pentaho.org)

Field Summary

static java.lang.String	IDATASOURCE_SERVICE
static java.lang.String	JDBC_DATASOURCE
static java.lang.String	JDBC_POOL

Method Summary

void	clearCache() This method clears the JNDI DS cache.
void	clearDataSource(java.lang.String dsName) This method clears the JNDI DS cache.
javax.sql.DataSource	getDataSource(java.lang.String dsName) Since JNDI is supported different ways in different app servers, it's nearly impossible to have a ubiquitous way to look up a datasource.
java.lang.String	getDSBoundName(java.lang.String dsName) Since JNDI is supported different ways in different app servers, it's nearly impossible to have a ubiquitous way to look up a datasource.
java.lang.String	getDSUnboundName(java.lang.String dsName) Since JNDI is supported different ways in different app servers, it's nearly impossible to have a ubiquitous way to look up a datasource.

Field Detail

JDBC_POOL

static final java.lang.String JDBC_POOL

See Also:

Constant Field Values

JDBC_DATASOURCE

static final java.lang.String JDBC_DATASOURCE

See Also:

Constant Field Values

IDATASOURCE_SERVICE

static final java.lang.String IDATASOURCE_SERVICE

See Also:

Constant Field Values

Method Detail

clearCache

void clearCache()

This method clears the JNDI DS cache. The need exists because after a JNDI connection edit the old DS must be removed from the cache.

clearDataSource

void clearDataSource(java.lang.String dsName)

This method clears the JNDI DS cache. The need exists because after a JNDI connection edit the old DS must be removed from the cache.

getDataSource

javax.sql.DataSource getDataSource(java.lang.String dsName)
                                   throws DatasourceServiceException

Since JNDI is supported different ways in different app servers, it's nearly impossible to have a ubiquitous way to look up a datasource. This method is intended to hide all the lookups that may be required to find a jndi name.

Parameters:

dsName - The Datasource name

Returns:

DataSource if there is one bound in JNDI

Throws:

javax.naming.NamingException

DatasourceServiceException

getDSBoundName

java.lang.String getDSBoundName(java.lang.String dsName)
                                throws DatasourceServiceException

Since JNDI is supported different ways in different app servers, it's nearly impossible to have a ubiquitous way to look up a datasource. This method is intended to hide all the lookups that may be required to find a jndi name, and return the actual bound name.

Parameters:

dsName - The Datasource name (like SampleData)

Returns:

The bound DS name if it is bound in JNDI (like "jdbc/SampleData")

Throws:

javax.naming.NamingException

DatasourceServiceException

getDSUnboundName

java.lang.String getDSUnboundName(java.lang.String dsName)

Since JNDI is supported different ways in different app servers, it's nearly impossible to have a ubiquitous way to look up a datasource. This method is intended to extract just the regular name of a specified JNDI source.

Parameters:

dsName - The Datasource name (like "jdbc/SampleData")

Returns:

The unbound DS name (like "SampleData")