Package io.micronaut.configuration.jdbc.tomcat

Class DatasourceConfiguration

  • All Implemented Interfaces:
    BasicJdbcConfiguration, java.io.Serializable, java.lang.Cloneable, org.apache.tomcat.jdbc.pool.PoolConfiguration
    @EachProperty(value="datasources",
              primary="default")
public class DatasourceConfiguration
extends org.apache.tomcat.jdbc.pool.PoolProperties
implements BasicJdbcConfiguration
    Allows the configuration of Tomcat JDBC data sources. All properties on PoolProperties are available to be configured. If the url, driver class, username, or password are missing, sensible defaults will be provided when possible. If no configuration beyond the datasource name is provided, an in memory datasource will be configured based on the available drivers on the classpath.
    Since:
    1.0
    Author:
    James Kleeh
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.tomcat.jdbc.pool.PoolProperties

        org.apache.tomcat.jdbc.pool.PoolProperties.InterceptorDefinition, org.apache.tomcat.jdbc.pool.PoolProperties.InterceptorProperty

    • Field Summary

      • Fields inherited from class org.apache.tomcat.jdbc.pool.PoolProperties

        DEFAULT_MAX_ACTIVE, poolCounter

      • Fields inherited from interface org.apache.tomcat.jdbc.pool.PoolConfiguration

        PKG_PREFIX

    • Constructor Summary

      Constructors 
      Constructor Description
      DatasourceConfiguration​(java.lang.String name)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getConfiguredDriverClassName()  
      java.lang.String getConfiguredPassword()  
      java.lang.String getConfiguredUrl()  
      java.lang.String getConfiguredUsername()  
      java.lang.String getConfiguredValidationQuery()  
      java.lang.String getDriverClassName()  
      java.lang.String getJndiName()  
      java.lang.String getPassword()  
      java.lang.String getUrl()  
      java.lang.String getUsername()  
      java.lang.String getValidationQuery()  
      void setDataSourceProperties​(java.util.Map<java.lang.String,​?> dsProperties)
      Sets the datasource properties.
      void setDbProperties​(java.util.Properties dbProperties)  
      void setJndiName​(java.lang.String jndiName)  

      • Methods inherited from class org.apache.tomcat.jdbc.pool.PoolProperties

        clone, getAbandonWhenPercentageFull, getCommitOnReturn, getConnectionProperties, getDataSource, getDataSourceJNDI, getDbProperties, getDefaultAutoCommit, getDefaultCatalog, getDefaultReadOnly, getDefaultTransactionIsolation, getInitialSize, getInitSQL, getJdbcInterceptors, getJdbcInterceptorsAsArray, getLogValidationErrors, getMaxActive, getMaxAge, getMaxIdle, getMaxWait, getMinEvictableIdleTimeMillis, getMinIdle, getName, getNumTestsPerEvictionRun, getPoolCounter, getPoolName, getPropagateInterruptState, getProperties, getRemoveAbandonedTimeout, getRollbackOnReturn, getSuspectTimeout, getTimeBetweenEvictionRunsMillis, getUseDisposableConnectionFacade, getUseLock, getUseStatementFacade, getValidationInterval, getValidationQueryTimeout, getValidator, getValidatorClassName, isAccessToUnderlyingConnectionAllowed, isAlternateUsernameAllowed, isDefaultAutoCommit, isDefaultReadOnly, isFairQueue, isIgnoreExceptionOnPreLoad, isJmxEnabled, isLogAbandoned, isPoolSweeperEnabled, isRemoveAbandoned, isTestOnBorrow, isTestOnConnect, isTestOnReturn, isTestWhileIdle, isUseEquals, setAbandonWhenPercentageFull, setAccessToUnderlyingConnectionAllowed, setAlternateUsernameAllowed, setCommitOnReturn, setConnectionProperties, setDataSource, setDataSourceJNDI, setDefaultAutoCommit, setDefaultCatalog, setDefaultReadOnly, setDefaultTransactionIsolation, setDriverClassName, setFairQueue, setIgnoreExceptionOnPreLoad, setInitialSize, setInitSQL, setJdbcInterceptors, setJmxEnabled, setLogAbandoned, setLogValidationErrors, setMaxActive, setMaxAge, setMaxIdle, setMaxWait, setMinEvictableIdleTimeMillis, setMinIdle, setName, setNumTestsPerEvictionRun, setPassword, setPropagateInterruptState, setRemoveAbandoned, setRemoveAbandonedTimeout, setRollbackOnReturn, setSuspectTimeout, setTestOnBorrow, setTestOnConnect, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRunsMillis, setUrl, setUseDisposableConnectionFacade, setUseEquals, setUseLock, setUsername, setUseStatementFacade, setValidationInterval, setValidationQuery, setValidationQueryTimeout, setValidator, setValidatorClassName, toString

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DatasourceConfiguration

        public DatasourceConfiguration​(@Parameter
                               java.lang.String name)
        Constructor.
        Parameters:
        name - name that comes from properties

    • Method Detail

      • setDbProperties

        public void setDbProperties​(@MapFormat(keyFormat=UNDER_SCORE_SEPARATED)
                            java.util.Properties dbProperties)
        Specified by:
        setDbProperties in interface org.apache.tomcat.jdbc.pool.PoolConfiguration
        Overrides:
        setDbProperties in class org.apache.tomcat.jdbc.pool.PoolProperties

      • getDriverClassName

        public java.lang.String getDriverClassName()
        Specified by:
        getDriverClassName in interface BasicJdbcConfiguration
        Specified by:
        getDriverClassName in interface org.apache.tomcat.jdbc.pool.PoolConfiguration
        Overrides:
        getDriverClassName in class org.apache.tomcat.jdbc.pool.PoolProperties
        Returns:
        The calculated driver class name

      • getUrl

        public java.lang.String getUrl()
        Specified by:
        getUrl in interface BasicJdbcConfiguration
        Specified by:
        getUrl in interface org.apache.tomcat.jdbc.pool.PoolConfiguration
        Overrides:
        getUrl in class org.apache.tomcat.jdbc.pool.PoolProperties
        Returns:
        The calculated URL

      • getUsername

        public java.lang.String getUsername()
        Specified by:
        getUsername in interface BasicJdbcConfiguration
        Specified by:
        getUsername in interface org.apache.tomcat.jdbc.pool.PoolConfiguration
        Overrides:
        getUsername in class org.apache.tomcat.jdbc.pool.PoolProperties
        Returns:
        The calculated username

      • getPassword

        public java.lang.String getPassword()
        Specified by:
        getPassword in interface BasicJdbcConfiguration
        Specified by:
        getPassword in interface org.apache.tomcat.jdbc.pool.PoolConfiguration
        Overrides:
        getPassword in class org.apache.tomcat.jdbc.pool.PoolProperties
        Returns:
        The calculated password

      • getValidationQuery

        public java.lang.String getValidationQuery()
        Specified by:
        getValidationQuery in interface BasicJdbcConfiguration
        Specified by:
        getValidationQuery in interface org.apache.tomcat.jdbc.pool.PoolConfiguration
        Overrides:
        getValidationQuery in class org.apache.tomcat.jdbc.pool.PoolProperties
        Returns:
        The calculated validation query

      • setDataSourceProperties

        public void setDataSourceProperties​(@MapFormat(transformation=FLAT,keyFormat=RAW)
                                    java.util.Map<java.lang.String,​?> dsProperties)
        Description copied from interface: BasicJdbcConfiguration
        Sets the datasource properties.
        Specified by:
        setDataSourceProperties in interface BasicJdbcConfiguration
        Parameters:
        dsProperties - The properties

      • getJndiName

        public java.lang.String getJndiName()
        Returns:
        The JNDI name

      • setJndiName

        public void setJndiName​(java.lang.String jndiName)
        Parameters:
        jndiName - Set the JDNI name