8.6.8 Tuning parameters for setting the timeout

This section explains how to set up tuning parameters used for timeout settings.

Organization of this subsection

(1) Timeout set in the Web server for receiving requests from the client and sending the data to the client
(2) Timeout set in the reverse proxy for sending data to the Web container
(3) Timeout set in the reverse proxy for receiving data from the Web container
(4) Timeout set in the Web container for receiving data from the reverse proxy or the Web client
(5) Timeout set in the Web container for receiving data from the reverse proxy or the Web client
(6) Timeout set in the EJB client for remotely invoking the Enterprise Bean (RMI-IIOP communication) and for invoking the Naming Service by JNDI
(7) Timeout set up in the EJB client for invoking the Enterprise Bean from CTM
(8) Timeout set in the EJB container for the database transaction (when DB Connector is used)
(9) DB Connector timeout
(10) Database timeout
(11) Method timeout in J2EE application

(1) Timeout set in the Web server for receiving requests from the client and sending the data to the client

This is a tuning parameter for setting the timeout at point 1 of Figure 8-9 or Figure 8-10. You can set this parameter only in the case of Web server integration.

Table 8‒26: Tuning parameters for the timeout to be set in the Web server for receiving requests from the client and sending the data to the client
Setup item	Location of setup
Timeout for receiving requests from the client and sending data to the client	`Timeout` directive of `httpsd.conf`

To Page Top

(2) Timeout set in the reverse proxy for sending data to the Web container

This is a tuning parameter for setting the timeout at point 2 and point 3 of Figure 8-9. The following table describes the tuning parameters for timeout settings in the reverse proxy. You can specify the tuning parameter only in the case of Web server integration.

Specify the items listed in the following table with the Smart Composer functionality. You define the parameters in the Easy Setup definition file.

Table 8‒27: Tuning parameters for the timeout to be set in the reverse proxy
Point	Setup item	Setup target	Location of setup (parameter name)^#
2	Connection timeout for Web container when sending requests	Logical Web server (`web-server`)	`timeout` key of `manager.web.reverseproxy.mapping` parameter
3	Timeout for sending requests	Logical Web server (`web-server`)	`timeout` key of `manager.web.reverseproxy.mapping` parameter

To Page Top

(3) Timeout set in the reverse proxy for receiving data from the Web container

This is a tuning parameter for setting the timeout at point 4 of Figure 8-9.

This parameter is set at the level of the data transfer destination of the reverse proxy. The following table describes the tuning parameters for timeout settings in the reverse proxy.

You specify the items listed in the following table using the Smart Composer functionality and define the parameters in the Easy Setup definition file.

Table 8‒28: Tuning parameters for the timeout to be set in the reverse proxy
Setup item	Setup target	Location of setup (parameter name)
Communication timeout of waiting for response data	Logical Web server (`web-server`)	`timeout` key of `manager.web.reverseproxy.mapping` parameter

You can specify this tuning parameter only in the case of Web server integration.

To Page Top

(4) Timeout set in the Web container for receiving data from the reverse proxy or the Web client

This is a tuning parameter for setting the timeout at point 5 of Figure 8-9.

You set up the tuning parameter for each J2EE server. The following table describes tuning parameters for the timeout to be set in the Web container.

You specify the items listed in the following table using the Smart Composer functionality and define the parameters in the Easy Setup definition file.

Table 8‒29: Tuning parameters for the timeout to be set in the Web container
Setup item	Setup target	Location of setup (parameter name)
Timeout when waiting for response from reverse proxy or Web client	Logical J2EE server (`j2ee-server`)	`webserver.connector.nio_http.receive_timeout`

To Page Top

(5) Timeout set in the Web container for receiving data from the reverse proxy or the Web client

This is a tuning parameter for setting the timeout at the point 13 of Figure 8-9.

You set up the tuning parameter for each J2EE server. The following table describes the tuning parameters for the timeout to be set up in the Web container.

You specify the items listed in the following table using the Smart Composer functionality and define the parameters in the Easy Setup definition file.

Table 8‒30: Tuning parameters for the timeout to be set in the Web container
Setup item	Setup target	Parameter name
Timeout of response sending process	Logical J2EE server (`j2ee-server`)	`webserver.connector.nio_http.send_timeout`

To Page Top

(6) Timeout set in the EJB client for remotely invoking the Enterprise Bean (RMI-IIOP communication) and for invoking the Naming Service by JNDI

This is a tuning parameter for setting the timeout at point 7 of Figure 8-9 or Figure 8-10.

Set the tuning parameter for each J2EE server, EJB client application, or invocation by API.

The following table describes the tuning parameters (remote invocation by RMI-IIOP communication) for timeout to be set in the EJB client:

Table 8‒31: Tuning parameters for the timeout to be set in the EJB client (remote invocation by RMI-IIOP communication)
Units	Method of setup	Setup item	Location of setup
Each J2EE server	Smart Composer functionality	Communication timeout between client and server	Definition file Easy Setup definition file Setup target Logical J2EE server (`j2ee-server`) Parameter name `ejbserver.rmi.request.timeout`
Each EJB client application	Specify the system property to be specified at the time of editing or starting a file		Definition file (in the case of edit file) `usrconf.properties` Parameter name `ejbserver.rmi.request.timeout` key
Each API	API		When setting for each object RequestTimeoutConfig#setRequestTimeout (`java.rmi.Remote` obj, int sec) method^# When setting for each thread RequestTimeoutConfig#setRequestTimeout (int sec) method^#

#: The name of the package is com.hitachi.software.ejb.ejbclient.

The following table describes the tuning parameters (invoking the Naming Service) for timeout to be set in the EJB client:

Table 8‒32: Tuning parameters for the timeout to be set in the EJB client (invoking the Naming Service)
Units	Method of setup	Setup item	Location of setup
Each J2EE server	Smart Composer functionality	Period of communication timeout with Naming Service	Definition file Easy Setup definition file Setup target Logical J2EE server (`j2ee-server`) Parameter name `ejbserver.jndi.request.timeout`
Each EJB client application	Specify the system property to be specified at the time of editing or starting a file	Period of communication timeout with Naming Service	Definition file (in the case of edit file) `usrconf.properties` Parameter name `ejbserver.jndi.request.timeout` key

To Page Top

(7) Timeout set up in the EJB client for invoking the Enterprise Bean from CTM

This is a tuning parameter for setting up timeout at point 8 of Figure 8-9 or Figure 8-10.

You set up the tuning parameter for each J2EE server, EJB client application, or each invocation by API.

A value same as that set up in (6) Timeout set in the EJB client for remotely invoking the Enterprise Bean (RMI-IIOP communication) and for invoking the Naming Service by JNDI is inherited as the setup value of this timeout.

To Page Top

(8) Timeout set in the EJB container for the database transaction (when DB Connector is used)

This is a tuning parameter for setting the timeout at point 10 of Figure 8-9 or Figure 8-10.

Set the tuning parameter for each J2EE server, Enterprise Bean, interface, method (in the case of CMT), or each invocation by API (in the case of BMT).

The following table describes the tuning parameters for transaction timeout:

Table 8‒33: Tuning parameters for transaction timeout
Units	Method of setup	Setup item	Location of setup
Each J2EE server	Smart Composer functionality	Default transaction timeout value of a transaction	Definition file Easy Setup definition file Setup target Logical J2EE server (`j2ee-server`) Parameter name `ejbserver.jta.TransactionManager.defaultTimeOut`
Each Enterprise Bean, interface, method (in the case of CMT)	The `cjsetappprop` command of the server management command	Transaction timeout time	Definition file Session Bean property file, Entity Bean property file, or Message-driven Bean property file Parameter name <ejb-transaction-timeout>
Each API (in the case of BMT)	API	Transaction timeout time	UserTransaction#setTransactionTimeout method^#

#: The name of the package is javax.transaction.

To Page Top

(9) DB Connector timeout

This is a tuning parameter for setting the timeout at point 11 of Figure 8-9 or Figure 8-10.

Set the tuning parameter for each DB Connector.

The following table describes the tuning parameters for DB Connector.

Table 8‒34: Tuning parameters for DB Connector
Units	Method of setup	Setup item	Location of setup
Each DB Connector	Server management commands `cjsetrarprop` or `cjsetresprop`	Timeout in establishing a physical connection	Definition file Connector property file Setup target DB Connector Parameter name `loginTimeout`
Each DB Connector	Server management commands `cjsetrarprop` or `cjsetresprop`	Timeout in the request for connection during connection depletion	Definition file Connector property file Setup target DB Connector Parameter name `RequestQueueTimeout`
Each J2EE server	Smart Composer functionality	Timeout in detecting a connection error	Definition file Easy Setup definition file Setup target Logical J2EE server (`j2ee-server`) Parameter name `ejbserver.connectionpool.validation.timeout`^#

#: The same property as the timeout value of the connection adjustment functionality.

To Page Top

(10) Database timeout

This is a tuning parameter for setting the timeout at point 12 of Figure 8-9 or Figure 8-10.

The database timeout differs according to the type of database you are using. This section explains how to set the timeout value when accessing the HiRDB, Oracle, SQL Server, or XDM/RD E2 by using the DB Connector.

Reference note: When Oracle is used, you can use the tuning parameters for setting the timeout only when global transaction is used. When local transaction is used, you cannot use the tuning parameters for setting timeout. You can, however, set the query timeout that is set by the method, in the case of both global and local transactions.

(a) Timeout settings in HiRDB

Set the timeout value in the common system definition of the HiRDB server or the environment variable of the HiRDB client. For details, see the manual HiRDB System Definition or the manual HiRDB UAP Development Guide.

The following table describes the tuning parameters used for setting the timeout in HiRDB:

Table 8‒35: Tuning parameters for setting the timeout in HiRDB
Type of timeout	Location of setup	Method of setup (parameter name)	Settings
Unlock waiting timeout	Common system definition of the HiRDB server	`pd_lck_wait_timeout` parameter	You can specify any value you wish.
Response timeout	Environment variable of the HiRDB client	`PDCWAITTIME`	You can specify any value you wish. However, in the case of a global transaction, specify a larger value than the transaction timeout value.
Request interval timeout	Environment variable of the HiRDB client	`PDSWAITTIME`	You can specify any value you wish. However, in the case of a global transaction, specify a larger value than the transaction timeout value.

Reference note

If PDCWAITTIME and PDSWAITTIME are smaller than the transaction timeout value, even if the processing is within the time limit for the transaction, the database processing exceeds the time limit and a timeout occurs.

In this case, the database connection is lost regardless of the transaction being in process, and the transaction manager cannot conclude the transaction.

Also, in the case of a global transaction, the transaction must be recovered because the instruction about transaction conclusion does not reach after the connection is lost.

(b) Timeout settings in Oracle (when global transaction is used)

Set the timeout value in the DISTRIBUTED_LOCK_TIMEOUT parameter of the Oracle server definition.

In addition to the above, the setting of SesTm parameter of XAOpenString affects the timeout. This parameter cannot be tuned.

(c) Timeout settings in SQL Server

Set the timeout value by executing the parameter or statement in the environment settings option of the SQL Server.

The following table describes the tuning parameters for setting the timeout in the SQL Server.

Table 8‒36: Tuning parameters for setting the timeout in the SQL Server
Type of timeout	Location of setup	Method of setup (name of parameter or statement	Settings
Timeout in acquiring memory	Server configuration option	`query wait` parameter	You can specify any value you wish.
Unlock waiting timeout	--	`SET LOCK_TIMEOUT` statement	You can specify any value you wish.

Legend:: --: Not applicable.

(d) Timeout settings in XDM/RD E2

Set the timeout value in the system option definition of the XDM/BASE, the environment variable of the HiRDB client, and the control statement for invoking control space or the control statement for invoking server space of the DB connection server.

The following table describes the tuning parameters for setting the timeout in XDM/RD E2:

Table 8‒37: Tuning parameters for setting the timeout in XDM/RD E2
Type of timeout	Location of setup	Method of setup (parameter name)	Settings
Unlock waiting timeout	System option definition of XDM/BASE	`TIMER`	You can specify any value you wish.^#1
CPU timeout during SQL execution	The control statement for invoking control space or control statement for invoking server space of the DB connection server	`SQLCTIME`	You can specify any value you wish. However, in the case of a global transaction, specify a larger value than the transaction timeout value.^#2
SQL execution timeout	The control statement for invoking control space or control statement for invoking server space of the DB connection server	`SQLETIME`	You can specify any value you wish. However, in the case of a global transaction, specify a larger value than the transaction timeout value.^#2
Transaction timeout	The control statement for invoking control space or control statement for invoking server space of the DB connection server	`SVETIME`	You can specify any value you wish. However, in the case of a global transaction, specify a larger value than the transaction timeout value.^#2
Response timeout	HiRDB client environment variable	`PDCWAITTIME`	You can specify any value you wish. However, in the case of a global transaction, specify a larger value than the transaction timeout value.^#3

#1: For details, see the manual VOS3 Data Management System XDM E2 Node System Definition (XDM/BASE, SD, or TM2).
#2: For details, see the manual VOS3 Database Connection Server.
#3: For details, see the manual HiRDB XDM/RD E2 Connection Functionality.

To Page Top

(11) Method timeout in J2EE application

This is a tuning parameter for setting the timeout at point 6 and point 9 of Figure 8-9 or Figure 8-10.

Set the timeout value as an application attribute when you want to set the timeout for each method in the Web application or the Enterprise Bean. Set the operations in the case of timeout as an application attribute as well. You specify these items using the server management command (cjsetappprop).

The following table describes the tuning parameters for setting the timeout in the method execution time. The location of setup differs for each point.

Table 8‒38: Tuning parameters for setting the timeout for the method execution time
Points to set	Type of timeout and operations in the case of timeout	Location of setup
6	Request processing method for the filter, servlet or JSP	Definition file Servlet property file Parameter name `<method-observation-timeout>`
9	Request processing method for the Enterprise Bean	Definition file Session Bean property file, Entity Bean property file, or Message-driven Bean property file Parameter name `<ejb-method-observation-timeout>`
6 and 9	Operations for each application when timeout occurs	Definition file Application property file Parameter name `<method-observation-recovery-mode>`

To Page Top