JNDI name of the cluster data source.

If two data sources are guaranteed to be bound to different JNDIs on different servers, they can have the same JNDI name. Different data sources with the same JNDI names are not allowed on the same server.

If not specified, the cluster data source ID is used as the JNDI name.

Multiple JNDI names can be specified by using comma (,) delimiter, and JNDI lookup can be used for any of these specified JNDI names.

When obtaining connections from cluster data sources, users or developers can customize policies for a specific component data source selection by inheriting and implementing the jeus.jdbc.helper.DataSourceSelector abstract class. Next, the class name to include the implementation class package name must be set. After it is set, the Load Balance configuration is ignored, and failover and failback are performed unconditionally.

Option to use load balancing.

This option provides compatibility with earlier versions of JEUS that only support failover.

Option to perform failback using the main data source after performing failover using the assistant data source. By default, failback is performed.

To perform failback, --checkQuery and --checkQueryPeriod must be set for the main data source.

Set to use a cluster data source associated with ONS. Specify an IP address and a port number used for each ONS RAC node to perform ONS communication. The cluster data source uses the information to make a socket connection and operates as an ONS client.

Use the following format.

[Dynamic] Encryption algorithm for the database user password. This option must be used with the -password option.

The following algorithm can be used:

Option to use the auto-commit configuration of the data source.

Query timeout used for java.sql.Statement objects created through the data source connection.

JEUS calls the query timeout configuration method (java.sql.Statement#setQueryTimeout) defined in the JDBC API and implemented by the JDBC driver vendor. The query timeout differs depending on the JDBC driver vendors. (Unit: ms)

Determines the action JEUS takes when it detects JDBC connections used by applications (stateless component - servlet/JSP, stateless session bean, MDB), but not yet returned.

Input options: (If not specified, the configuration of the server is used.)

Determines how to handle connection requests when no connections are available in the pool and additional connections cannot be added.

If a request does not involve a transaction, it is better to get a connection from the connection pool data source instead of from the XA data source.

In this situation, a connection from the connection pool data source provides the same functionality as a connection from the XA data source, but with a smaller impact on system performance. Therefore, when using the XA data source, delegate connection requests unrelated to transactions to the connection pool data source.

When Oracle and DB2 use XA connections for both cases, with or without transactions, unexplained errors can occur; using this configuration can help avoid such situation.

Maximum number of times a connection can be used. If the number of times a connection is used exceeds the specified number, the connection is replaced with a new connection.

The default value is 0: a connection is not replaced.

Query (query-check) that checks the connection status.

Simple selection queries are recommended when validating the connection to the DB.

When a check-query is executed to check the connection status, a driver can be in the wait state indefinitely if the DB does not respond. Apply a timeout to the check-query to avoid this situation.

This can be set by using the java.sql.Statement#setQueryTimeout method defined in the JDBC API.

If the value is less than 1000ms, the value is set to 0. (Unit: ms)

Option to skip connection checks if the interval between the last check and the recent check is within the specified interval.

This option is useful for when overhead is created by frequent connection checks. (Unit: ms)

For example, if the option is set to 5000 ms, and 5 seconds has not passed since the last connection check, connections are sent to the applications without being checked.

Checks the connections in the connection pool at the specified interval to delete faulty connections. (Unit: ms)

For data sources that belong to cluster data sources, this option must be set to be used for checking its own state.

If --destroyPolicyOnCheckQuery is set to FAILED_CONNECTION_ONLY, a connection check is performed only once.

If --destroyPolicyOnCheckQuery is set to ALL_CONNECTIONS and a problem is detected during the first connection check, all other connections are also checked, resulting in the connection check being performed twice.

The total connection check count is determined by adding this option value to the default connection check value.

Policy for connections in the connection pool when invalid connections are found.

JDBC driver parses SQL statements sent as parameters whenever applications request prepared statements. Parsing SQL statements can affect system performance, so JEUS offers a function that internally caches the prepared statements. This option sets the number of prepared statements that can be cached. If this option is used, connections are always open, so the clear job performed by the driver is not executed.

For example, when the Oracle JDBC driver sets auto-commit to false and closes the connection without executing commit or rollback, commit is executed unconditionally.

The use of the statement caching function is recommended if provided by the JDBC driver.

Option to offer additional information for connections.

Displays SQL queries used by connections.

If the jeus.jdbc.sql logger level is set to FINE, the SQL query history can be checked in server logs. If this function is used, the statement implementation class of the JDBC driver is wrapped by a JEUS class. Therefore, applications that cast and use statement objects of the JDBC driver cannot use this function.

If this option is set to true and an XA connection is used and returned to the pool, the handle (or the logical connection) is kept open.

This function is required when using DB2 universal drivers. If this option is used, connections are always open, so the clear job performed by the driver is not executed.

For example, when the Oracle JDBC driver sets auto-commit to false and closes the connection without executing commit or rollback, commit is executed unconditionally.

JNDI name of the data source.

If two data sources are guaranteed to be bound to different JNDIs on different servers, they can have the same JNDI name. Different data sources with the same JNDI names are not allowed on the same server.

If not specified, the data source ID is used as the JNDI name.

Multiple JNDI names can be specified by using comma (,) delimiter, and JNDI lookup can be used for any of these specified JNDI names.

Data source type.

Database name.

Sets the database SID (for Oracle).

Amount of time in wait for the connection pool destroy command to complete. (Unit: ms)

The connection pool is destroyed when applications that defined the data sources are undeployed or when the server goes down. During this process, if the connection is used for network communication with a DB, the destroy process can be blocked and left hanging indefinitely. This option is used to avoid this situation. If this option is set, connection pool destruction waits the specified time period and then performs undeployment or terminates the server.

This option provides a unified configuration method to accommodate all property configurations that can differ by JDBC driver.

For a single property, use the 'name:type=value' format.

To specify multiple properties, separate each property with a comma (,).

This option only applies to the connection pool data source type. This option emulates the connection pool data source connection to participate in a global transaction (XA).

For JEUS 6 and earlier versions, this option is an alternative to LocalXADataSource. It is used in the ConnectionPoolDataSource type connection pools.

Note that only one connection pool data source can participate per transaction.

JNDI name of the data source (hereafter DBA delegation data source), which has permission to forcibly terminate database sessions (DBA permission). If there is a delay in handling a query through the connection received from the data source, a query that forcibly terminates the DB session is sent to the DB using the DBA delegation data source. After the application handles exceptions that occurred due to the disabled connection, it closes the connection. JEUS then deletes the connection and gets a new connection from the DB and assigns it to the connection pool.

Currently, this function is supported for Tibero, Oracle, and Sybase. It was created to suspend queries that take too long to perform for JDBC driver version 2.0 and earlier. For JDBC driver version 3.0 and later, it is recommended to use java.sql.Statement#setQueryTimeout instead of forcibly terminating DB sessions.

Especially for XA data sources, if DB sessions are terminated while XA operates normally, the XA operation can generate an error. Therefore, use the statement query timeout and the transaction timeout properties.

The delegation DBA data source waits the specified time period for queries on a connection to finish. If timeout occurs, a query is sent to the DB that forcibly terminates the DB session.

This option only applies when --delegationDba is set. (Unit: ms)

Class name, which includes the package name, that implements the function for users or developers who want to customize the connection check function.

The class must implement the jeus.jdbc.connectionpool.JEUSConnectionChecker interface.

Cluster data source ID.

The cluster data source ID must be unique within a domain.

JNDI name of the cluster data source.

If two data sources are guaranteed to be bound to different JNDIs on different servers, they can have the same JNDI name. Different data sources with the same JNDI names are not allowed on the same server.

If not specified, the cluster data source ID is used as the JNDI name. In order to undo this setting, enter "unset" as the option value.

Multiple JNDI names can be specified by using comma (,) delimiter, and JNDI lookup can be used for any of these specified JNDI names.

[Dynamic] When obtaining connections from cluster data sources, users or developers can customize policies for a specific component data source selection by inheriting and implementing the jeus.jdbc.helper.DataSourceSelector abstract class.

Next, the class name to include the implementation class package name must be set. After it is set, the Load Balance configuration is ignored, and failover and failback are performed unconditionally.

To undo this setting, enter 'unset' as the option value.

[Dynamic] Option to use load balancing.

[Dynamic] Option to perform failback using the main data source after performing failover using the assistant data source. By default, failback is performed.

This option provides compatibility with earlier versions of JEUS that only support failover.

To perform failback, --checkQuery and --checkQueryPeriod must be set for the main data source.

Set to use a cluster data source associated with ONS. Specify an IP address and a port number used for each ONS RAC node to perform ONS communication. The cluster data source uses the information to make a socket connection and operates as an ONS client.

Use the following format.

[Dynamic] Database user ID. The user must have the proper permissions to handle transactions.

In order to undo this setting, enter "unset" as the option value.

[Dynamic] Database user password.

To encrypt the password before storing, use the '{algorithm:keysize}ciphertext' format.

In order to undo this setting, enter "unset" as the option value.

[Dynamic] Encryption algorithm for the database user password. This option must be used with the -password option.

The following algorithm can be used:

[Dynamic] Option to use the auto-commit configuration of the data source.

The configuration value can only be set when the transaction is not linked to the connection pool data sources that use the XA emulation function or linked to XA data sources.

[Dynamic] Query timeout used for java.sql.Statement objects created through the data source connection.

JEUS calls the query timeout configuration method (java.sql.Statement#setQueryTimeout) defined in the JDBC API and implemented by the JDBC driver vendor. The query timeout differs depending on the JDBC driver vendors. (Unit: ms)

[Dynamic] Determines the action JEUS takes when it detects JDBC connections used by applications (stateless component - servlet/JSP, stateless session bean, MDB), but not yet returned.

Input options:

If not specified, the configuration of the server is used. To undo this setting, enter "unset" as the option value.

[Dynamic] Determines how to handle connection requests when no connections are available in the pool and additional connections cannot be added.

[Dynamic] If a request does not involve a transaction, it is better to get a connection from the connection pool data source instead of from the XA data source.

In this situation, a connection from the connection pool data source provides the same functionality as a connection from the XA data source, but with a smaller impact on system performance. Therefore, when using the XA data source, delegate connection requests unrelated to transactions to the connection pool data source.

When Oracle and DB2 use XA connections for both cases, with or without transactions, unexplained errors can occur; using this configuration can help avoid such situation.

In order to undo this setting, enter "unset" as the option value.

[Dynamic] Query (query-check) that checks the connection status. Simple selection queries are recommended when validating the connection to the DB.

In order to undo this setting, enter "unset" as the option value.

[Dynamic] When a check-query is executed to check the connection status, a driver can be in the wait state indefinitely if the DB does not respond. Apply a timeout to the check-query to avoid this situation. This can be set by using the java.sql.Statement#setQueryTimeout method defined in the JDBC API.

If the value is less than 1000ms, the value is set to 0. (Unit: ms)

[Dynamic] Option to skip connection checks if the interval between the last check and the recent check is within the specified time period. This option is useful for when overhead is created by frequent connection checks. (Unit: ms)

For example, if the option is set to 5000 ms, and 5 seconds has not passed since the last connection check, connections are sent to the applications without being checked.

[Dynamic] Checks the connections in the connection pool at the specified interval to delete faulty connections. (Unit: ms)

For data sources that belong to cluster data sources, this option must be set to be used for checking its own state.

[Dynamic] If --destroyPolicyOnCheckQuery is set to FAILED_CONNECTION_ONLY, a connection check is performed only once.

If --destroyPolicyOnCheckQuery is set to ALL_CONNECTIONS and a problem is detected during the first connection check, all other connections are also checked, resulting in the connection check being performed twice.

The total connection check count is determined by adding this option value to the default connection check value.

[Dynamic] Policy for connections in the connection pool when invalid connections are found.

[Dynamic] JDBC driver parses SQL statements sent as parameters whenever applications request prepared statements. Parsing SQL statements can affect system performance, so JEUS offers a function that internally caches the prepared statements. This option sets the number of prepared statements that can be cached. If this option is used, connections are always open, so the clear job performed by the driver is not executed.

For example, when the Oracle JDBC driver sets auto-commit to false and closes the connection without executing commit or rollback, commit is executed unconditionally.

The use of the statement caching function is recommended if provided by the JDBC driver.

[Dynamic] Option to offer additional information for connections.

[Dynamic] Displays SQL queries used by connections. If the jeus.jdbc.sql logger level is set to FINE, the SQL query history can be checked in server logs. If this function is used, the statement implementation class of the JDBC driver is wrapped by a JEUS class. Therefore, applications that cast and use statement objects of the JDBC driver cannot use this function.

[Dynamic] If this option is set to true and an XA connection is used and returned to the pool, the handle (or the logical connection) is kept open.

This function is required when using DB2 universal drivers. If this option is used, connections are always open, so the clear job performed by the driver is not executed.

For example, when the Oracle JDBC driver sets auto-commit to false and closes the connection without executing commit or rollback, commit is executed unconditionally.

JNDI name of the data source. If two data sources are guaranteed to be bound to different JNDIs on different servers, they can have the same JNDI name. Different data sources with the same JNDI names are not allowed on the same server.

If not specified, the data source ID is used as the JNDI name. To undo this setting, enter "unset" as the option value.

Multiple JNDI names can be specified by using comma (,) delimiter, and JNDI lookup can be used for any of these specified JNDI names.

Data source type.

JDBC driver vendor name.

In order to undo this setting, enter "unset" as the option value.

Displays data source descriptions.

In order to undo this setting, enter "unset" as the option value.

Host name or IP at which the database runs.

In order to undo this setting, enter "unset" as the option value.

Transaction isolation level defined in java.sql.Connection. If not specified, the default configuration of the JDBC driver is used.

In order to undo this setting, enter "unset" as the option value.

Amount of time in wait for the connection pool destroy command to complete. (Unit: ms)

The connection pool is destroyed when applications that defined the data sources are undeployed or when the server goes down. During this process, if the connection is used for network communication with the DB, the destroy process can be blocked and left hanging indefinitely. This option is used to avoid this situation. If this option is set, connection pool destruction waits the specified time period and then performs undeployment or server termination.

If this option is set, connection pool destruction waits the specified time period and then performs undeployment or server termination.

This option provides a unified configuration method to accommodate all property configurations that can differ by JDBC driver.

This option only applies to the connection pool data source type. This option emulates the connection pool data source connection to participate in a global transaction (XA).

For JEUS 6 and earlier versions, this option is an alternative to LocalXADataSource. It is used in the ConnectionPoolDataSource type of connection pools.

Note that only one connection pool data source can participate per transaction.

JNDI name of the data source (hereafter DBA delegation data source), which has permission to forcibly terminate database sessions (DBA permission). If there is a delay in handling a query through the connection received from the data source, a query that forcibly terminates the DB session is sent to the DB using the DBA delegation data source. After the application handles exceptions that occurred due to the disabled connection, it closes the connection. JEUS then deletes the connection and gets a new connection from the DB and assigns it to the connection pool.

Currently, this function is supported for Tibero, Oracle, and Sybase. It was created to suspend queries that take too long to perform for JDBC driver version 2.0 and earlier. For JDBC driver version 3.0 and later, it is recommended to use java.sql.Statement#setQueryTimeout instead of forcibly terminating DB sessions.

Especially for XA data sources, if DB sessions are terminated while XA operates normally, the XA operation can generate an error. Therefore, use the statement query timeout and the transaction timeout properties.

In order to undo this setting, enter "unset" as the option value.

The delegation DBA data source waits the specified time period for queries on a connection to finish. If timeout occurs, a query is sent to the DB that forcibly terminates the DB session.

This option only applies when --delegationDba is set. (Unit: ms)

Class name, which includes the package name, that implements the function for users or developers who want to customize the connection check function.

The class must implement the jeus.jdbc.connectionpool.JEUSConnectionChecker interface.

In order to undo this setting, enter "unset" as the option value.

SQL query that is initially handled after a connection has been created.

In order to undo this setting, enter "unset" as the option value.