nl.nn.adapterframework.jdbc

Class JdbcFacade

java.lang.Object

nl.nn.adapterframework.jndi.JndiBase

nl.nn.adapterframework.jdbc.JdbcFacade

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, IXAEnabled, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

JdbcListener, JdbcMessageBrowser, JdbcSenderBase, Locker, SimpleJdbcListener, Storage

public class JdbcFacade
extends JndiBase
implements HasPhysicalDestination, IXAEnabled, HasStatistics

Provides functions for JDBC connections. N.B. Note on using XA transactions: If transactions are used, make sure that the database user can access the table SYS.DBA_PENDING_TRANSACTIONS. If not, transactions present when the server goes down cannot be properly recovered, resulting in exceptions like:

   The error code was XAER_RMERR. The exception stack trace follows: javax.transaction.xa.XAException
        at oracle.jdbc.xa.OracleXAResource.recover(OracleXAResource.java:508)
   

Since:

4.1

Author:

Gerrit van Brakel

Nested Class Summary

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

Fields inherited from class nl.nn.adapterframework.jndi.JndiBase

log

Constructor Summary

Constructors

Constructor and Description
JdbcFacade()

Method Summary

Modifier and Type	Method and Description
void	configure()
String	getAuthAlias()
Connection	getConnection() Obtains a connection to the datasource.
Connection	getConnectionWithTimeout(int timeout)
protected DataSource	getDatasource()
String	getDatasourceInfo()
String	getDatasourceName()
IDbmsSupport	getDbmsSupport()
protected String	getLogPrefix()
protected String	getPassword()
String	getPhysicalDestinationName() Returns the name and location of the database that this objects operates on.
String	getUsername()
boolean	isConnectionsArePooled()
boolean	isTransacted() indicates implementing object is under transaction control, using XA-transactions
void	iterateOverStatistics(StatisticsKeeperIterationHandler hski, Object data, HasStatistics.Action action)
void	setAuthAlias(String authAlias) Authentication alias used to authenticate when connecting to database
void	setConnectionsArePooled(boolean b) informs the sender that the obtained connection is from a pool (and thus connections are reused and never closed)
void	setDatasourceName(String datasourceName) JNDI name of datasource to be used, can be configured via jmsRealm, too
void	setDbmsSupportFactory(IDbmsSupportFactory dbmsSupportFactory)
void	setJmsRealm(String jmsRealmName) Deprecated.
void	setPassword(String password) Password for authentication when connecting to database, when none found from authAlias
void	setTransacted(boolean transacted) controls the use of transactions
void	setUsername(String username) User name for authentication when connecting to database, when none found from authAlias

Methods inherited from class nl.nn.adapterframework.jndi.JndiBase

close, getContext, getJndiEnv, setAuthentication, setCredentials, setInitialContextFactoryName, setJndiAuthAlias, setJndiContextPrefix, setJndiProperties, setName, setPrincipal, setProviderURL, setSecurityProtocol, setUrlPkgPrefixes, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

getDomain

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Constructor Detail

JdbcFacade

public JdbcFacade()

Method Detail

getLogPrefix

protected String getLogPrefix()

configure

public void configure()
               throws ConfigurationException

Specified by:

configure in interface IConfigurable

Overrides:

configure in class JndiBase

Throws:

ConfigurationException

getDatasource

protected DataSource getDatasource()
                            throws JdbcException

Throws:

JdbcException

getDatasourceInfo

public String getDatasourceInfo()
                         throws JdbcException

Throws:

JdbcException

setDbmsSupportFactory

public void setDbmsSupportFactory(IDbmsSupportFactory dbmsSupportFactory)

getDbmsSupport

public IDbmsSupport getDbmsSupport()

getConnection

public Connection getConnection()
                         throws JdbcException

Obtains a connection to the datasource.

Throws:

JdbcException

getConnectionWithTimeout

public Connection getConnectionWithTimeout(int timeout)
                                    throws JdbcException,
                                           TimeoutException

Throws:

JdbcException

TimeoutException

iterateOverStatistics

public void iterateOverStatistics(StatisticsKeeperIterationHandler hski,
                                  Object data,
                                  HasStatistics.Action action)
                           throws SenderException

Specified by:

iterateOverStatistics in interface HasStatistics

Throws:

SenderException

setJmsRealm

@Deprecated
 @ConfigurationWarning(value="We discourage the use of jmsRealms for datasources. To specify a datasource other then the default, use the datasourceName attribute directly, instead of referring to a realm")
public void setJmsRealm(String jmsRealmName)

Deprecated.

Description copied from class: JndiBase

loads JNDI (and other) properties from a JmsRealm

Overrides:

setJmsRealm in class JndiBase

See Also:

JmsRealm

getPhysicalDestinationName

public String getPhysicalDestinationName()

Returns the name and location of the database that this objects operates on.

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

See Also:

HasPhysicalDestination.getPhysicalDestinationName()

setDatasourceName

public void setDatasourceName(String datasourceName)

JNDI name of datasource to be used, can be configured via jmsRealm, too

Default value

getDatasourceName

public String getDatasourceName()

setAuthAlias

public void setAuthAlias(String authAlias)

Authentication alias used to authenticate when connecting to database

getAuthAlias

public String getAuthAlias()

setUsername

public void setUsername(String username)

User name for authentication when connecting to database, when none found from authAlias

getUsername

public String getUsername()

setPassword

public void setPassword(String password)

Password for authentication when connecting to database, when none found from authAlias

getPassword

protected String getPassword()

setTransacted

public void setTransacted(boolean transacted)

controls the use of transactions

isTransacted

public boolean isTransacted()

Description copied from interface: IXAEnabled

indicates implementing object is under transaction control, using XA-transactions

Specified by:

isTransacted in interface IXAEnabled

setConnectionsArePooled

public void setConnectionsArePooled(boolean b)

informs the sender that the obtained connection is from a pool (and thus connections are reused and never closed)

Default value

true

isConnectionsArePooled

public boolean isConnectionsArePooled()