Package com.techempower.data.jdbc

Class JndiConnectorFactory

java.lang.Object

com.techempower.data.jdbc.JndiConnectorFactory

All Implemented Interfaces:

Asynchronous, ConnectorFactory, Configurable

public class JndiConnectorFactory
extends Object
implements ConnectorFactory, Configurable, Asynchronous

An implementation of ConnectorFactory that is a thin wrapper around a connection pool defined in the servlet container (Resin, Tomcat, etc.) and fetched via JNDI.

The following attributes are read from the properties file for configuring this component:

• [prefix]Enabled - whether this ConnectorFactory is enabled.
• [prefix]Name - JNDI name defined in servlet container.

The remaining configuration for the data source is in the servlet container's configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor	Description
JndiConnectorFactory(TechEmpowerApplication application, String propertyPrefix)	Deprecated, for removal: This API element is subject to removal in a future version.
JndiConnectorFactory(String propertyPrefix)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	begin()	Start this Asynchronous component.
void	configure(EnhancedProperties rawProps)	Configure this component.
void	determineDatabaseAffinity()
void	determineIdentifierQuoteString()
void	end()	Stop this Asynchronous component.
ConnectionMonitor	getConnectionMonitor()	Gets a ConnectionMonitor.
DatabaseAffinity	getDatabaseAffinity()
String	getIdentifierQuoteString()
boolean	isEnabled()	Is this Connector Factory enabled? In nearly all cases, this would be true; but it will be false for applications that do not connect to a database at all.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PROPERTY_PREFIX

public static final String DEFAULT_PROPERTY_PREFIX

See Also:

• Constant Field Values

Constructor Details

JndiConnectorFactory

public JndiConnectorFactory(String propertyPrefix)

Constructor. If the propertyPrefix is passed as an empty String, the default "db.Jndi." will be used.

For a JNDI data source, configuration is done in the servlet container.

Parameters:

propertyPrefix - the prefix to apply to all property names in the conf file; default is "db.Jndi."

JndiConnectorFactory

@Deprecated(forRemoval=true)
public JndiConnectorFactory(TechEmpowerApplication application,
 String propertyPrefix)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

configure

public void configure(EnhancedProperties rawProps)

Configure this component. For a JNDI data source, configuration is done in the servlet container.

Specified by:

configure in interface Configurable

determineIdentifierQuoteString

public void determineIdentifierQuoteString()

Specified by:

determineIdentifierQuoteString in interface ConnectorFactory

begin

public void begin()

Start this Asynchronous component.

Specified by:

begin in interface Asynchronous

end

public void end()

Stop this Asynchronous component.

Specified by:

end in interface Asynchronous

isEnabled

public boolean isEnabled()

Is this Connector Factory enabled? In nearly all cases, this would be true; but it will be false for applications that do not connect to a database at all.

Specified by:

isEnabled in interface ConnectorFactory

getConnectionMonitor

public ConnectionMonitor getConnectionMonitor()
                                       throws SQLException

Gets a ConnectionMonitor.

Specified by:

getConnectionMonitor in interface ConnectorFactory

Throws:

SQLException

getIdentifierQuoteString

public String getIdentifierQuoteString()

Specified by:

getIdentifierQuoteString in interface ConnectorFactory

getDatabaseAffinity

public DatabaseAffinity getDatabaseAffinity()

Specified by:

getDatabaseAffinity in interface ConnectorFactory

determineDatabaseAffinity

public void determineDatabaseAffinity()