Package org.glassfish.jdbc.config

Interface JdbcConnectionPool

    • Method Detail

      • getDatasourceClassname

        String getDatasourceClassname()
        Gets the value of the datasourceClassname property. Name of the vendor supplied JDBC datasource resource manager. An XA or global transactions capable datasource class will implement javax.sql.XADatasource interface. Non XA or Local transactions only datasources will implement javax.sql.Datasource interface.
        Returns:
        possible object is String

      • getDriverClassname

        String getDriverClassname()
        Gets the value of the driverClassname property. Name of the vendor supplied JDBC driver resource manager. Get classnames that implement java.sql.Driver.
        Returns:
        possible object is String

      • getResType

        @Pattern(regexp="(java.sql.Driver|javax.sql.DataSource|javax.sql.XADataSource|javax.sql.ConnectionPoolDataSource)")
@Pattern(regexp="(java.sql.Driver|javax.sql.DataSource|javax.sql.XADataSource|javax.sql.ConnectionPoolDataSource)") String getResType()
        Gets the value of the resType property. DataSource implementation class could implement one of javax.sql.DataSource, javax.sql.XADataSource or javax.sql.ConnectionPoolDataSource interfaces. This optional attribute must be specified to disambiguate when a Datasource class implements two or more of these interfaces. An error is produced when this attribute has a legal value and the indicated interface is not implemented by the datasource class. This attribute has no default value.
        Returns:
        possible object is String

      • getSteadyPoolSize

        String getSteadyPoolSize()
        Gets the value of the steadyPoolSize property. Minimum and initial number of connections maintained in the pool
        Returns:
        possible object is String

      • getMaxPoolSize

        String getMaxPoolSize()
        Gets the value of the maxPoolSize property. Maximum number of connections that can be created
        Returns:
        possible object is String

      • getMaxWaitTimeInMillis

        String getMaxWaitTimeInMillis()
        Gets the value of the maxWaitTimeInMillis property. Amount of time the caller will wait before getting a connection timeout. Default is 60 sec. A value of 0 will force caller to wait indefinitely.
        Returns:
        possible object is String

      • getPoolResizeQuantity

        String getPoolResizeQuantity()
        Gets the value of the poolResizeQuantity property. Number of connections to be removed when dle-timeout-in-seconds timer expires. Connections that have idled for longer than the timeout are candidates for removal. When the pool size reaches steady-pool-size, the connection removal stops.
        Returns:
        possible object is String

      • getIdleTimeoutInSeconds

        String getIdleTimeoutInSeconds()
        Gets the value of the idleTimeoutInSeconds property. maximum time in seconds, that a connection can remain idle in the pool. After this time, the pool implementation can close this connection. Note that this does not control connection timeouts enforced at the database server side. Administrators are advised to keep this timeout shorter than the database server side timeout (if such timeouts are configured on the specific vendor's database), to prevent accumulation of unusable connection in Application Server.
        Returns:
        possible object is String

      • getTransactionIsolationLevel

        @Pattern(regexp="(read-uncommitted||read-committed|repeatable-read|serializable|snapshot)")
@Pattern(regexp="(read-uncommitted||read-committed|repeatable-read|serializable|snapshot)") String getTransactionIsolationLevel()
        Gets the value of the transactionIsolationLevel property. Specifies the Transaction Isolation Level on pooled database connections. Optional. Has no default. If left unspecified the pool operates with default isolation level provided by the JDBC Driver. A desired isolation level can be set using one of the standard transaction isolation levels, which see. Applications that change the Isolation level on a pooled connection programmatically, risk polluting the pool and this could lead to program errors. Also see: is-isolation-level-guaranteed
        Returns:
        possible object is String

      • getIsIsolationLevelGuaranteed

        String getIsIsolationLevelGuaranteed()
        Gets the value of the isIsolationLevelGuaranteed property. Applicable only when a particular isolation level is specified for transaction-isolation-level. The default value is true. This assures that every time a connection is obtained from the pool, it is guaranteed to have the isolation set to the desired value. This could have some performance impact on some JDBC drivers. Can be set to false by that administrator when they are certain that the application does not change the isolation level before returning the connection.
        Returns:
        possible object is String

      • getIsConnectionValidationRequired

        String getIsConnectionValidationRequired()
        Gets the value of the isConnectionValidationRequired property. if true, connections are validated (checked to find out if they are usable) before giving out to the application. The default is false.
        Returns:
        possible object is String

      • getConnectionValidationMethod

        @Pattern(regexp="(auto-commit|meta-data|custom-validation|table)")
@Pattern(regexp="(auto-commit|meta-data|custom-validation|table)") String getConnectionValidationMethod()
        Gets the value of the connectionValidationMethod property. specifies the type of validation to be performed when is-connection-validation-required is true. The following types of validation are supported: auto-commit using connection.autoCommit() meta-data using connection.getMetaData() table performing a query on a user specified table(see validation-table-name)
        Returns:
        possible object is String

      • getValidationTableName

        String getValidationTableName()
        Gets the value of the validationTableName property. Specifies the table name to be used to perform a query to validate a connection. This parameter is mandatory, if connection-validation-type is set to table. Verification by accessing a user specified table may become necessary for connection validation, particularly if database driver caches calls to setAutoCommit() and getMetaData().
        Returns:
        possible object is String

      • getValidationClassname

        String getValidationClassname()
        Gets the value of the validationClassName property. Specifies the custom validation class name to be used to perform connection validation. This parameter is mandatory, if connection-validation-type is set to custom-validation.
        Returns:
        possible object is String

      • getFailAllConnections

        String getFailAllConnections()
        Gets the value of the failAllConnections property. Indicates if all connections in the pool must be closed should a single validation check fail. The default is false. One attempt will be made to re-establish failed connections.
        Returns:
        possible object is String

      • getNonTransactionalConnections

        String getNonTransactionalConnections()
        Gets the value of the nonTransactionalConnections property. A pool with this property set to true returns non-transactional connections. This connection does not get automatically enlisted with the transaction manager.
        Returns:
        possible object is String

      • getAllowNonComponentCallers

        String getAllowNonComponentCallers()
        Gets the value of the allowNonComponentCallers property. A pool with this property set to true, can be used by non-J2EE components (i.e components other than EJBs or Servlets). The returned connection is enlisted automatically with the transaction context obtained from the transaction manager. This property is to enable the pool to be used by non-component callers such as ServletFilters, Lifecycle modules, and 3rd party persistence managers. Standard J2EE components can continue to use such pools. Connections obtained by non-component callers are not automatically cleaned at the end of a transaction by the container. They need to be explicitly closed by the the caller.
        Returns:
        possible object is String

      • getValidateAtmostOncePeriodInSeconds

        String getValidateAtmostOncePeriodInSeconds()
        Gets the value of the validateAtmostOncePeriodInSeconds property. Used to set the time-interval within which a connection is validated atmost once. Default is 0 which implies that it is not enabled. TBD: Documentation is to be corrected.
        Returns:
        possible object is String

      • getConnectionLeakTimeoutInSeconds

        String getConnectionLeakTimeoutInSeconds()
        Gets the value of the connectionLeakTimeoutInSeconds property. To aid user in detecting potential connection leaks by the application. When a connection is not returned back to the pool by the application within the specified period, it is assumed to be a potential leak and stack trace of the caller will be logged. Default is 0, which implies there is no leak detection, by default. A positive non-zero value turns on leak detection. Note however that, this attribute only detects if there is a connection leak. The connection can be reclaimed only if connection-leak-reclaim is set to true.
        Returns:
        possible object is String

      • getConnectionLeakReclaim

        String getConnectionLeakReclaim()
        Gets the value of the connectionLeakReclaim property. If enabled, connection will be reusable (put back into pool) after connection-leak-timeout-in-seconds occurs. Default value is false.
        Returns:
        possible object is String

      • getConnectionCreationRetryAttempts

        String getConnectionCreationRetryAttempts()
        Gets the value of the connectionCreationRetryAttempts property. The number of attempts to create a new connection. Default is 0, which implies no retries.
        Returns:
        possible object is String

      • getConnectionCreationRetryIntervalInSeconds

        String getConnectionCreationRetryIntervalInSeconds()
        Gets the value of the connectionCreationRetryIntervalInSeconds property. The time interval between retries while attempting to create a connection Default is 10 seconds. Effective when connection-creation-retry-attempts is greater than 0.
        Returns:
        possible object is String

      • setConnectionCreationRetryIntervalInSeconds

        void setConnectionCreationRetryIntervalInSeconds​(String value)
                                          throws PropertyVetoException
        Sets the value of the connectionCreationRetryIntervalInSeconds property.
        Parameters:
        value - allowed object is String
        Throws:
        PropertyVetoException

      • getStatementTimeoutInSeconds

        @Min(-1L)
@Min(-1L) String getStatementTimeoutInSeconds()
        Gets the value of the statementTimeoutInSeconds property. Sets the timeout property of a connection to enable termination of abnormally long running queries. Default value of -1 implies that it is not enabled.
        Returns:
        possible object is String

      • getSlowQueryThresholdInSeconds

        @Min(-1L)
@Min(-1L) String getSlowQueryThresholdInSeconds()
        Gets the value of the sloqSQLLogThreshold property. gets the SLow SQL Log Threshold property if a query exceeds this time in seconds it will be logged as a WARNING
        Returns:
        possible object is String

      • getLazyConnectionEnlistment

        String getLazyConnectionEnlistment()
        Gets the value of the lazyConnectionEnlistment property. Enlist a resource to the transaction only when it is actually used in a method, which avoids enlistment of connections that are not used in a transaction. This also prevents unnecessary enlistment of connections cached in the calling components. Default value is false
        Returns:
        possible object is String

      • getLazyConnectionAssociation

        String getLazyConnectionAssociation()
        Gets the value of the lazyConnectionAssociation property. Connections are lazily associated when an operation is performed on them. Also, they are disassociated when the transaction is completed and a component method ends, which helps reuse of the physical connections. Default value is false.
        Returns:
        possible object is String

      • getAssociateWithThread

        String getAssociateWithThread()
        Gets the value of the associateWithThread property. Associate a connection with the thread such that when the same thread is in need of a connection, it can reuse the connection already associated with that thread, thereby not incurring the overhead of getting a connection from the pool. Default value is false
        Returns:
        possible object is String

      • getPooling

        String getPooling()
        Gets the value of the pooling property. Property to disable pooling for the pool.
        Returns:
        possible object is String

      • getStatementCacheSize

        String getStatementCacheSize()
        Gets the value of the statementCacheSize property. When specified, statement caching is turned on to cache statements, prepared statements, callable statements that are repeatedly executed by applications. Default value is 0, which implies the feature is not enabled.
        Returns:
        possible object is String

      • getStatementCacheType

        String getStatementCacheType()
        Gets the value of the statementCacheType property. When specified, statement caching type is set to cache statements, prepared statements, callable statements that are repeatedly executed by applications.
        Returns:
        possible object is String

      • getStatementLeakTimeoutInSeconds

        String getStatementLeakTimeoutInSeconds()
        Returns:
        possible object is String

      • getStatementLeakReclaim

        String getStatementLeakReclaim()

      • getInitSql

        String getInitSql()
        Gets the value of the initSql property. Init sql is executed whenever a connection created from the pool. This is mostly useful when the state of a connection is to be initialised
        Returns:
        possible object is String

      • getMatchConnections

        String getMatchConnections()
        Gets the value of the matchConnections property. To switch on/off connection matching for the pool. It can be set to false if the administrator knows that the connections in the pool will always be homogeneous and hence a connection picked from the pool need not be matched by the resource adapter. Default value is false.
        Returns:
        possible object is String

      • getMaxConnectionUsageCount

        String getMaxConnectionUsageCount()
        Gets the value of the maxConnectionUsageCount property. When specified, connections will be re-used by the pool for the specified number of times after which it will be closed. This is useful for instance, to avoid statement-leaks. Default value is 0, which implies the feature is not enabled.
        Returns:
        possible object is String

      • getWrapJdbcObjects

        String getWrapJdbcObjects()
        Gets the value of the wrapJdbcObjects property. When set to true, application will get wrapped jdbc objects for Statement, PreparedStatement, CallableStatement, ResultSet, DatabaseMetaData. Defaults to false.
        Returns:
        possible object is String

      • getLogJdbcCalls

        String getLogJdbcCalls()
        Gets the value of the logJDBCCalls property. When set to true, application log all JDBC method calls. Defaults to false.
        Returns:
        possible object is String

      • getSqlTraceListeners

        String getSqlTraceListeners()
        Gets the value of the SqlTraceListeners property. Comma separated list of SQL trace listener implementations to be used to trace the SQL statements executed by the applications. The default logger used by the system logs the SQL statements based on a set of values stored in SQLTraceRecord object.
        Returns:
        possible object is String

      • getDescription

        String getDescription()
        Gets the value of the description property.
        Returns:
        possible object is String

      • getProperty

        @PropertyDesc(name="PortNumber",defaultValue="1527",dataType=Port.class,description="Port on which the database server listens for requests") @PropertyDesc(name="Password",defaultValue="APP",description="Password for connecting to the database") @PropertyDesc(name="User",defaultValue="APP",description="User name for connecting to the database") @PropertyDesc(name="serverName",defaultValue="localhost",description="Database server for this connection pool") @PropertyDesc(name="DatabaseName",defaultValue="sun-appserv-samples",description="Database for this connection pool.") @PropertyDesc(name="connectionAttributes",defaultValue=";create=true",description="connection attributes")
List<Property> getProperty()
        Properties. This list is likely incomplete as of 21 October 2008. Most JDBC 2.0 drivers permit use of standard property lists, to specify User, Password and other resource configuration. While these are optional properties, according to the specification, several of these properties may be necessary for most databases. See Section 5.3 of JDBC 2.0 Standard Extension API. The following are the names and corresponding values for these properties databaseName Name of the Database serverName Database Server name. port Port where a Database server is listening for requests. networkProtocol Communication Protocol used. user default name of the database user with which connections will be stablished. Programmatic database authentication or default-resource-principal specified in vendor specific web and ejb deployment descriptors will take precedence, over this default. The details and caveats are described in detail in the Administrator's guide. password password for default database user roleName The initial SQL role name. datasourceName used to name an underlying XADataSource, or ConnectionPoolDataSource when pooling of connections is done description Textual Description When one or more of these properties are specified, they are passed as is using set() methods to the vendors Datasource class (specified in datasource-classname). User and Password properties are used as default principal, if Container Managed authentication is specified and a default-resource-principal is not found in application deployment descriptors.
        Specified by:
        getProperty in interface PropertyBag
        Returns:
        the property list