Package org.frankframework.jdbc

Class JdbcFacade

java.lang.Object
org.frankframework.jdbc.JdbcFacade
All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IScopeProvider, IXAEnabled, NameAware, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle
Direct Known Subclasses:
AbstractJdbcMessageBrowser, AbstractJdbcSender, JdbcListener, Locker, SimpleJdbcListener, Tibet2DatabaseStorage
@DestinationType(JDBC) public class JdbcFacade extends Object implements HasPhysicalDestination, IXAEnabled, ConfigurableLifecycle, FrankElement, NameAware
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

  • Field Details

    • log

      protected org.apache.logging.log4j.Logger log

  • Constructor Details

    • JdbcFacade

      public JdbcFacade()

  • Method Details

    • getLogPrefix

      protected String getLogPrefix()

    • configure

      public void configure() throws ConfigurationException
      Description copied from interface: IConfigurable
      Configure this component.

      configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

      In the case of a container, this will propagate the configure signal to all components that apply.

      Specified by:
      configure in interface IConfigurable
      Throws:
      ConfigurationException - in case it was not able to configure the component.

    • start

      public void start()
      Specified by:
      start in interface ConfigurableLifecycle
      Specified by:
      start in interface org.springframework.context.Lifecycle

    • stop

      public void stop()
      Specified by:
      stop in interface org.springframework.context.Lifecycle

    • isRunning

      public boolean isRunning()
      Specified by:
      isRunning in interface org.springframework.context.Lifecycle

    • getDatasource

      @Nonnull protected DataSource getDatasource() throws JdbcException
      Throws:
      JdbcException

    • setDbmsSupportFactory

      public void setDbmsSupportFactory(DbmsSupportFactory dbmsSupportFactory)

    • getDbmsSupport

      public IDbmsSupport getDbmsSupport()

    • getConnection

      protected Connection getConnection() throws JdbcException
      Obtains a connection to the datasource.
      Throws:
      JdbcException

    • getConnectionWithTimeout

      public Connection getConnectionWithTimeout(int timeout) throws JdbcException, TimeoutException
      Throws:
      JdbcException
      TimeoutException

    • getPhysicalDestinationName

      public String getPhysicalDestinationName()
      Returns the name and location of the database that this objects operates on. If no previous connection was made or it cannot determine the destination it returns 'unknown'
      Specified by:
      getPhysicalDestinationName in interface HasPhysicalDestination
      See Also:

    • setName

      public void setName(String name)
      Name of the sender or the listener
      Specified by:
      setName in interface NameAware

    • setDatasourceName

      public void setDatasourceName(String datasourceName)
      JNDI name of datasource to be used, can be configured via jmsRealm, too
      Default value
      "jdbc.datasource.default"

    • getDatasourceName

      public String getDatasourceName()

    • setAuthAlias

      public void setAuthAlias(String authAlias)
      Authentication alias used to authenticate when connecting to database

    • setUsername

      public void setUsername(String username)
      User name for authentication when connecting to database, when none found from authAlias

    • 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()