org.sape.carbon.services.sql.connection
Interface NamedDataSourceConnectionFactoryConfiguration

All Superinterfaces:

ComponentConfiguration, Configuration

public interface NamedDataSourceConnectionFactoryConfiguration

extends ComponentConfiguration

Configuration Interface for NamedDataSourceConnectionFactory. The JndiUserId, JndiPassword, DataSourceUserId and DataSourcePassword are all optional - but may be required by the Vendor's implementation, or your setup of JNDI + DataSource + JDBC.

Since:

carbon 1.0

Version:

$Revision: 1.8 $($Author: dvoet $ / $Date: 2003/05/05 21:21:37 $)
Copyright 2002 Sapient

Author:

Chris Herron, March 2002

Field Summary

Fields inherited from interface org.sape.carbon.core.component.ComponentConfiguration

ComponentTemplateName

Method Summary

String	getDataSourcePassword() (Optional) Gets the name of the datasource password to authenticate with.
String	getDataSourceUserId() (Optional) Gets the name of the datasource id to authenticate with.
String	getInitialContextFactory() Gets the name of the initial context factory used to retreive the datasource.
String	getJndiName() Gets the JNDI name of the datasource to retreive.
String	getJndiPassword() (Optional) Gets the name of the jndi password to authenticate with.
String	getJndiUserId() (Optional) Gets the name of the jndi user to authenticate with.
String	getProviderUrl() Gets the provider Url for the datasource.
void	setDataSourcePassword(String dataSourcePassword) (Optional) Sets the name of the datasource password to authenticate with.
void	setDataSourceUserId(String dataSourceUserId) (Optional) Sets the name of the datasource id to authenticate with.
void	setInitialContextFactory(Class initialContextFactory) Sets the name of the initial context factory used to retreive the datasource.
void	setJndiName(String jndiName) Sets the JNDI name of the datasource to retreive.
void	setJndiPassword(String jndiPassword) (Optional) Sets the name of the jndi password to authenticate with.
void	setJndiUserId(String jndiUserId) (Optional) Sets the name of the jndi user to authenticate with.
void	setProviderUrl(String providerUrl) Sets the provider Url for the datasource.

Methods inherited from interface org.sape.carbon.core.component.ComponentConfiguration

getComponentDescription, getComponentTemplateName, getFunctionalImplementationClass, getFunctionalInterface, setComponentDescription, setComponentTemplateName, setFunctionalImplementationClass, setFunctionalInterface

Methods inherited from interface org.sape.carbon.core.config.Configuration

clone, getConfigurationInterface, getConfigurationName, getDataStructure, getRootElement, isConfigurationWritable, setConfigurationName, setConfigurationReadOnly

Method Detail

getJndiName

public String getJndiName()

Gets the JNDI name of the datasource to retreive.

Returns:

JNDI name of the datasource to retreive

setJndiName

public void setJndiName(String jndiName)

Sets the JNDI name of the datasource to retreive.

Parameters:

jndiName - JNDI name of the datasource to retreive

getInitialContextFactory

public String getInitialContextFactory()

Gets the name of the initial context factory used to retreive the datasource.

Returns:

name of the initial context factory

setInitialContextFactory

public void setInitialContextFactory(Class initialContextFactory)

Sets the name of the initial context factory used to retreive the datasource.

Parameters:

initialContextFactory - name of the initial context factory

getProviderUrl

public String getProviderUrl()

Gets the provider Url for the datasource.

Returns:

the provider Url

setProviderUrl

public void setProviderUrl(String providerUrl)

Sets the provider Url for the datasource.

Parameters:

providerUrl - the provider Url

getJndiUserId

public String getJndiUserId()

(Optional) Gets the name of the jndi user to authenticate with.

Returns:

name of the jndi user to authenticate with

setJndiUserId

public void setJndiUserId(String jndiUserId)

(Optional) Sets the name of the jndi user to authenticate with.

Parameters:

jndiUserId - name of the jndi user to authenticate with

getJndiPassword

public String getJndiPassword()

(Optional) Gets the name of the jndi password to authenticate with.

Returns:

name of the jndi password to authenticate with

setJndiPassword

public void setJndiPassword(String jndiPassword)

(Optional) Sets the name of the jndi password to authenticate with.

Parameters:

jndiPassword - name of the jndi password to authenticate with

getDataSourceUserId

public String getDataSourceUserId()

(Optional) Gets the name of the datasource id to authenticate with.

Returns:

name of the datasource id to authenticate with

setDataSourceUserId

public void setDataSourceUserId(String dataSourceUserId)

(Optional) Sets the name of the datasource id to authenticate with.

Parameters:

dataSourceUserId - name of the datasource id to authenticate with

getDataSourcePassword

public String getDataSourcePassword()

(Optional) Gets the name of the datasource password to authenticate with.

Returns:

name of the datasource password to authenticate with

setDataSourcePassword

public void setDataSourcePassword(String dataSourcePassword)

(Optional) Sets the name of the datasource password to authenticate with.

Parameters:

dataSourcePassword - name of the datasource password to authenticate with