Package org.jboss.jca.adapters.jdbc

Class BaseWrapperManagedConnectionFactory

java.lang.Object
org.jboss.jca.adapters.jdbc.BaseWrapperManagedConnectionFactory
All Implemented Interfaces:
jakarta.resource.spi.ManagedConnectionFactory, jakarta.resource.spi.ResourceAdapterAssociation, jakarta.resource.spi.ValidatingManagedConnectionFactory, Serializable, Statistics
Direct Known Subclasses:
LocalManagedConnectionFactory, XAManagedConnectionFactory
public abstract class BaseWrapperManagedConnectionFactory extends Object implements jakarta.resource.spi.ManagedConnectionFactory, jakarta.resource.spi.ValidatingManagedConnectionFactory, jakarta.resource.spi.ResourceAdapterAssociation, Statistics, Serializable
BaseWrapperManagedConnectionFactory
Author:
David Jencks, Adrian Brock, Weston Price, Jesper Pedersen
See Also:

  • Field Details

    • TRACK_STATEMENTS_FALSE_INT

      public static final int TRACK_STATEMENTS_FALSE_INT
      Track statements - false
      See Also:

    • TRACK_STATEMENTS_TRUE_INT

      public static final int TRACK_STATEMENTS_TRUE_INT
      Track statements - true
      See Also:

    • TRACK_STATEMENTS_NOWARN_INT

      public static final int TRACK_STATEMENTS_NOWARN_INT
      Track statements - no warning
      See Also:

    • TRACK_STATEMENTS_FALSE

      public static final String TRACK_STATEMENTS_FALSE
      Track statements - false
      See Also:

    • TRACK_STATEMENTS_TRUE

      public static final String TRACK_STATEMENTS_TRUE
      Track statements - true
      See Also:

    • TRACK_STATEMENTS_NOWARN

      public static final String TRACK_STATEMENTS_NOWARN
      Track statements - no warning
      See Also:

    • log

      protected final AdaptersLogger log
      The logger

    • bundle

      protected static AdaptersBundle bundle
      The bundle

    • userName

      protected String userName
      The user name

    • password

      protected String password
      The password

    • transactionIsolation

      protected int transactionIsolation
      The transaction isolation level

    • preparedStatementCacheSize

      protected Integer preparedStatementCacheSize
      The prepared statement cache size

    • doQueryTimeout

      protected boolean doQueryTimeout
      Query timeout enabled

    • poolValidationLoggingEnabled

      protected boolean poolValidationLoggingEnabled

    • newConnectionSQL

      protected String newConnectionSQL
      The variable newConnectionSQL holds an SQL statement which if not null is executed when a new Connection is obtained for a new ManagedConnection.

    • checkValidConnectionSQL

      protected String checkValidConnectionSQL
      The variable checkValidConnectionSQL holds an sql statement that may be executed whenever a managed connection is removed from the pool, to check that it is still valid. This requires setting up an mbean to execute it when notified by the ConnectionManager.

    • validConnectionCheckerClassName

      protected String validConnectionCheckerClassName
      The classname used to check whether a connection is valid

    • validConnectionCheckerProps

      protected final Properties validConnectionCheckerProps
      The properties injected in the class used to check whether a connection is valid

    • connectionChecker

      protected ValidConnectionChecker connectionChecker
      The instance of the valid connection checker

    • staleConnectionChecker

      protected StaleConnectionChecker staleConnectionChecker
      The instance of the stale connection checker

    • staleConnectionCheckerProps

      protected final Properties staleConnectionCheckerProps
      The properties injected in the stale connection checker

    • trackStatements

      protected int trackStatements
      Track statement

    • sharePS

      protected Boolean sharePS
      Whether to share cached prepared statements

    • isTransactionQueryTimeout

      protected Boolean isTransactionQueryTimeout
      Transaction query timeout

    • queryTimeout

      protected Integer queryTimeout
      Query timeout

    • urlDelimiter

      protected String urlDelimiter
      The variable urlDelimiter holds the url delimiter information to be used for HA DS configuration .

    • urlSelectorStrategyClassName

      protected String urlSelectorStrategyClassName
      URL selector strategy class name

  • Constructor Details

    • BaseWrapperManagedConnectionFactory

      public BaseWrapperManagedConnectionFactory()
      Constructor

  • Method Details

    • getResourceAdapter

      public jakarta.resource.spi.ResourceAdapter getResourceAdapter()
      Specified by:
      getResourceAdapter in interface jakarta.resource.spi.ResourceAdapterAssociation

    • setResourceAdapter

      public void setResourceAdapter(jakarta.resource.spi.ResourceAdapter ra)
      Specified by:
      setResourceAdapter in interface jakarta.resource.spi.ResourceAdapterAssociation

    • getLogWriter

      public PrintWriter getLogWriter() throws jakarta.resource.ResourceException
      Specified by:
      getLogWriter in interface jakarta.resource.spi.ManagedConnectionFactory
      Throws:
      jakarta.resource.ResourceException

    • setLogWriter

      public void setLogWriter(PrintWriter v) throws jakarta.resource.ResourceException
      Specified by:
      setLogWriter in interface jakarta.resource.spi.ManagedConnectionFactory
      Throws:
      jakarta.resource.ResourceException

    • createConnectionFactory

      public Object createConnectionFactory(jakarta.resource.spi.ConnectionManager cm) throws jakarta.resource.ResourceException
      Specified by:
      createConnectionFactory in interface jakarta.resource.spi.ManagedConnectionFactory
      Throws:
      jakarta.resource.ResourceException

    • createConnectionFactory

      public Object createConnectionFactory() throws jakarta.resource.ResourceException
      Specified by:
      createConnectionFactory in interface jakarta.resource.spi.ManagedConnectionFactory
      Throws:
      jakarta.resource.ResourceException

    • getUserName

      public String getUserName()
      Get the user name
      Returns:
      The value

    • setUserName

      public void setUserName(String userName)
      Set the user name
      Parameters:
      userName - The value

    • getPassword

      public String getPassword()
      Get the password
      Returns:
      The value

    • setPassword

      public void setPassword(String password)
      Set the password
      Parameters:
      password - The value

    • getPreparedStatementCacheSize

      public Integer getPreparedStatementCacheSize()
      Get the prepared statement cache size
      Returns:
      The value

    • setPreparedStatementCacheSize

      public void setPreparedStatementCacheSize(Integer size)
      Set the prepared statement cache size
      Parameters:
      size - The value

    • getSharePreparedStatements

      public Boolean getSharePreparedStatements()
      Get the prepared statement share status
      Returns:
      The value

    • setSharePreparedStatements

      public void setSharePreparedStatements(Boolean sharePS)
      Set the prepared statement share status
      Parameters:
      sharePS - The value

    • getTransactionIsolation

      public String getTransactionIsolation()
      Get the transaction isolation level
      Returns:
      The value

    • setTransactionIsolation

      public void setTransactionIsolation(String transactionIsolation)
      Set the transaction isolation level
      Parameters:
      transactionIsolation - The value

    • getNewConnectionSQL

      public String getNewConnectionSQL()
      Get the new connection SQL statement
      Returns:
      The value

    • setNewConnectionSQL

      public void setNewConnectionSQL(String newConnectionSQL)
      Set the new connection SQL statement
      Parameters:
      newConnectionSQL - The value

    • getCheckValidConnectionSQL

      public String getCheckValidConnectionSQL()
      Get the check valid connection SQL statement
      Returns:
      The value

    • setCheckValidConnectionSQL

      public void setCheckValidConnectionSQL(String checkValidConnectionSQL)
      Set the check valid connection SQL statement
      Parameters:
      checkValidConnectionSQL - The value

    • getStaleConnectionCheckerClassName

      public String getStaleConnectionCheckerClassName()
      Get the stale connection checker class name
      Returns:
      The value

    • setStaleConnectionCheckerClassName

      public void setStaleConnectionCheckerClassName(String staleConnectionCheckerClassName)
      Set the stale connection checker class name
      Parameters:
      staleConnectionCheckerClassName - The staleConnectionCheckerClassName

    • getStaleConnectionClassLoader

      public ClassLoader getStaleConnectionClassLoader()
      Get the stale connection checker module name
      Returns:
      The value

    • setStaleConnectionCheckerClassLoader

      public void setStaleConnectionCheckerClassLoader(ClassLoader staleConnectionCheckerClassLoader)
      Set the stale connection checker module name
      Parameters:
      staleConnectionCheckerClassLoader - The staleConnectionCheckerModuleName

    • getTrackStatements

      public String getTrackStatements()
      Get the track statement value
      Returns:
      The value

    • setTrackStatements

      public void setTrackStatements(String value)
      Set the track statement value
      Parameters:
      value - The value

    • getExceptionSorterClassName

      public String getExceptionSorterClassName()
      Get the exception sorter class name
      Returns:
      The value

    • setExceptionSorterClassName

      public void setExceptionSorterClassName(String exceptionSorterClassName)
      Set the exception sorter class name
      Parameters:
      exceptionSorterClassName - The value

    • getExceptionSorterClassLoader

      public ClassLoader getExceptionSorterClassLoader()
      Get the exception sorter module name
      Returns:
      The value

    • setExceptionSorterClassLoader

      public void setExceptionSorterClassLoader(ClassLoader exceptionSorterClassLoader)
      Set the exception sorter module name
      Parameters:
      exceptionSorterClassLoader - The value

    • getValidConnectionCheckerClassName

      public String getValidConnectionCheckerClassName()
      Get the valid connection checker class name
      Returns:
      The value

    • setValidConnectionCheckerClassName

      public void setValidConnectionCheckerClassName(String validConnectionCheckerClassName)
      Set the valid connection checker class name
      Parameters:
      validConnectionCheckerClassName - The value

    • getValidConnectionCheckerClassLoader

      public ClassLoader getValidConnectionCheckerClassLoader()
      Get the valid connection checker class loader
      Returns:
      The value

    • setValidConnectionCheckerClassLoader

      public void setValidConnectionCheckerClassLoader(ClassLoader validConnectionCheckerClassLoader)
      Set the valid connection checker class name
      Parameters:
      validConnectionCheckerClassLoader - The value

    • isTransactionQueryTimeout

      public Boolean isTransactionQueryTimeout()
      Is transaction query timeout set
      Returns:
      The value

    • setTransactionQueryTimeout

      public void setTransactionQueryTimeout(Boolean value)
      Set transaction query timeout
      Parameters:
      value - The value

    • getQueryTimeout

      public Integer getQueryTimeout()
      Get the query timeout
      Returns:
      The value

    • setQueryTimeout

      public void setQueryTimeout(Integer timeout)
      Set the query timeout
      Parameters:
      timeout - The value

    • getUseTryLock

      public Integer getUseTryLock()
      Get the use try lock value
      Returns:
      The value

    • setUseTryLock

      public void setUseTryLock(Integer useTryLock)
      Set the use try lock value
      Parameters:
      useTryLock - The value

    • isDoLocking

      public boolean isDoLocking()
      Are we doing locking
      Returns:
      true if locking, otherwise false

    • setSpy

      public void setSpy(Boolean v)
      Set the spy value
      Parameters:
      v - The value

    • getSpy

      public Boolean getSpy()
      Get the spy value
      Returns:
      The value

    • setJndiName

      public void setJndiName(String v)
      Set the jndi name value
      Parameters:
      v - The value

    • getJndiName

      public String getJndiName()
      Get the jndi name value
      Returns:
      The value

    • getReauthEnabled

      public Boolean getReauthEnabled()
      Get reauth enabled
      Returns:
      The value

    • setReauthEnabled

      public void setReauthEnabled(Boolean v)
      Set reauth enabled
      Parameters:
      v - The value

    • getReauthPluginClassName

      public String getReauthPluginClassName()
      Get reauth plugin class name
      Returns:
      The value

    • setReauthPluginClassName

      public void setReauthPluginClassName(String v)
      Set reauth plugin class name
      Parameters:
      v - The value

    • getReauthPluginProperties

      public String getReauthPluginProperties()
      Get reauth plugin properties
      Returns:
      The value

    • setReauthPluginProperties

      public void setReauthPluginProperties(String v)
      Set reauth plugin properties
      Parameters:
      v - The value

    • getConnectionListenerClassName

      public String getConnectionListenerClassName()
      Get connection listener class name
      Returns:
      The value

    • setConnectionListenerClassName

      public void setConnectionListenerClassName(String v)
      Set connection listener class name
      Parameters:
      v - The value

    • getConnectionListenerProperties

      public String getConnectionListenerProperties()
      Get connection listener properties
      Returns:
      The value

    • setConnectionListenerProperties

      public void setConnectionListenerProperties(String v)
      Set connection listener properties
      Parameters:
      v - The value

    • getURLDelimiter

      public String getURLDelimiter()
      Get the url delimiter
      Returns:
      The value

    • setURLDelimiter

      public void setURLDelimiter(String urlDelimiter)
      Set the url delimiter.
      Parameters:
      urlDelimiter - The value

    • getUrlSelectorStrategyClassName

      public String getUrlSelectorStrategyClassName()
      Get the url selector strategy class name
      Returns:
      The value

    • setUrlSelectorStrategyClassName

      public void setUrlSelectorStrategyClassName(String urlSelectorStrategyClassName)
      Set the url selector strategy class name
      Parameters:
      urlSelectorStrategyClassName - The value

    • getStatistics

      public JdbcStatisticsPlugin getStatistics()
      Get the statistics plugin
      Specified by:
      getStatistics in interface Statistics
      Returns:
      The value

    • isJTA

      public Boolean isJTA()
      Get the JTA status
      Returns:
      The value

    • setJTA

      public void setJTA(Boolean v)
      Set the JTA status
      Parameters:
      v - The value

    • getInvalidConnections

      public Set<BaseWrapperManagedConnection> getInvalidConnections(Set connectionSet) throws jakarta.resource.ResourceException
      Get the invalid connections
      Specified by:
      getInvalidConnections in interface jakarta.resource.spi.ValidatingManagedConnectionFactory
      Parameters:
      connectionSet - The connection set
      Returns:
      The invalid connections
      Throws:
      jakarta.resource.ResourceException - Thrown if an error occurs

    • getConnectionProperties

      protected Properties getConnectionProperties(Properties connectionProps, Subject subject, jakarta.resource.spi.ConnectionRequestInfo cri) throws jakarta.resource.ResourceException
      Gets full set of connection properties, i.e. whatever is provided in config plus "user" and "password" from subject/cri.

      Note that the set is used to match connections to datasources as well as to create new managed connections.

      In fact, we have a problem here. Theoretically, there is a possible name collision between config properties and "user"/"password".

      Parameters:
      connectionProps - The connection properties
      subject - The subject
      cri - The connection request info
      Returns:
      The properties
      Throws:
      jakarta.resource.ResourceException - Thrown if an error occurs

    • isExceptionFatal

      public boolean isExceptionFatal(SQLException e)
      Is the exception fatal
      Parameters:
      e - The exception
      Returns:
      True if fatal; otherwise false

    • setPoolValidationLoggingEnabled

      public void setPoolValidationLoggingEnabled(boolean poolValidationLoggingEnabled)

    • getValidConnectionCheckerProps

      public final Properties getValidConnectionCheckerProps()
      Get the validConnectionCheckerProps.
      Returns:
      the validConnectionCheckerProps.

    • getStaleConnectionCheckerProps

      public final Properties getStaleConnectionCheckerProps()
      Get the staleConnectionCheckerProps.
      Returns:
      the staleConnectionCheckerProps.

    • getExceptionSorterProps

      public final Properties getExceptionSorterProps()
      Get the exceptionSorterProps.
      Returns:
      the exceptionSorterProps.

    • getValidConnectionCheckerProperties

      public final String getValidConnectionCheckerProperties()
      Get the validConnectionCheckerProperties.
      Returns:
      the validConnectionCheckerProperties.

    • setValidConnectionCheckerProperties

      public final void setValidConnectionCheckerProperties(String validConnectionCheckerProperties)
      Set the validConnectionCheckerProperties.
      Parameters:
      validConnectionCheckerProperties - The validConnectionCheckerProperties to set.

    • getStaleConnectionCheckerProperties

      public final String getStaleConnectionCheckerProperties()
      Get the staleConnectionCheckerProperties.
      Returns:
      the staleConnectionCheckerProperties.

    • setStaleConnectionCheckerProperties

      public final void setStaleConnectionCheckerProperties(String staleConnectionCheckerProperties)
      Set the staleConnectionCheckerProperties.
      Parameters:
      staleConnectionCheckerProperties - The staleConnectionCheckerProperties to set.

    • getExceptionSorterProperties

      public final String getExceptionSorterProperties()
      Get the exceptionSorterProperties.
      Returns:
      the exceptionSorterProperties.

    • setExceptionSorterProperties

      public final void setExceptionSorterProperties(String exceptionSorterProperties)
      Set the exceptionSorterProperties.
      Parameters:
      exceptionSorterProperties - The exceptionSorterProperties to set.

    • getClassLoaderPlugin

      public final ClassLoaderPlugin getClassLoaderPlugin()
      Get the clPlugin.
      Returns:
      the clPlugin.

    • setClassLoaderPlugin

      public final void setClassLoaderPlugin(ClassLoaderPlugin clPlugin)
      Set the clPlugin.
      Parameters:
      clPlugin - The clPlugin to set.

    • setOriginalTCCLn

      public final void setOriginalTCCLn(ClassLoader cl)
      Set the originalTCCL.
      Parameters:
      cl - The clPlugin to set.