![[Contents]](FIGURE/CONTENT.GIF)
uCosminexus Application Server, Application Setup Guide
![[Index]](FIGURE/INDEX.GIF)
![[Back]](FIGURE/FRONT.GIF)
![[Next]](FIGURE/AFTER.GIF)
You define the DB Connector properties. You can also define the DB Connector properties after deploying the DB Connector. Note that if you want to change the properties of a DB Connector that is already deployed, change the properties when the applicable DB Connector is not running.
For details on property settings, see 3.5 Property settings using the property file. The following subsections define the DB Connector properties:
Connector attribute file
Execute the following command to acquire the Connector attribute file of DB Connector:
cjgetresprop server-name [-nameserver provider-URL] -type rar -resname DB-Connector-display-name -c Path-of-Connector-attribute-file |
cjgetresprop MyServer -type rar -resname account-rar -c AccountProp.xml
Execute the following command to apply the values of the Connector attribute file:
cjsetresprop server-name [-nameserver provider-URL] -type rar -resname DB-Connector-display-name -c Path-of-Connector-attribute- file |
cjsetresprop MyServer -type rar -resname account-rar -c AccountProp.xml
The settings for DB Connector properties are described below:
The following table describes the settings for the general information attributes (<outbound-resourceadapter> tag) of the DB Connector that can be set:
| Items | Mandatory | Corresponding tags |
|---|---|---|
| Transaction support level | Y | <transaction-support> |
| Scope of re-authentication support | Y | <reauthentication-support> |
For details on the property settings, see 4.1.1 Contents of the HITACHI Connector Property file in the uCosminexus Application Server Application and Resource Definition Reference Guide.
The following table describes the settings for the configuration properties (<outbound-resourceadapter> - <connection-definition> - <config-property> tag) of the DB Connector:
| Items | Corresponding tags |
|---|---|
| Configuration property name | <config-property-name> |
| Configuration property data type | <config-property-type> |
| Configuration property value | <config-property-value># |
Repeat the settings under the <config-property> tag for all the configuration properties that you want to define.
Some of the items that you need to set up differ based on the type of imported DB Connector. For details on the properties that can be set in the <config-property> tag, see 4.1.10 Properties that can be specified in the <config-property> tag set in DB Connector in the uCosminexus Application Server Application and Resource Definition Reference Guide.
Note that when XAOpenString is specified in the <config-property-name> tag and if you execute the cjgetresprop command, the configuration property value (<config-property-value>) will be displayed as follows:
For statement pooling operations and notes on using the statement pooling functionality, see 3.14.4 Statement pooling in the uCosminexus Application Server Common Container Functionality Guide.
For details on the examples of configuration property settings for the DB Connector to be used, see (4) Example of configuration property settings.
The following table describes the settings for the runtime properties (<outbound-resourceadapter> - <connection-definition> - <connector-runtime> tag) of the DB Connector:
| Items | Corresponding tags |
|---|---|
| Property name | <property-name> |
| Property data type | <property-type> |
| Property value | <property-value># |
Repeat the above settings for all the properties that you want to define.
When you set the property value (<property-value>), the value set as the default property value (<property-default-value>) will not be applied.
Set the following items in the property names (<property-name>):
| Property items | Item names of property name (<property-name>) |
|---|---|
| User name# | User |
| Password# | Password |
| Minimum number of connections to be pooled in the connection pool | MinPoolSize |
| Maximum number of connections to be pooled in the connection pool | MaxPoolSize |
| Choose a method to check whether a failure has occurred in the connections inside the pool | ValidationType |
| Interval for periodically checking whether a failure has occurred in the connections inside the pool | ValidationInterval |
| Retry count when you fail to acquire the connection | RetryCount |
| Retry interval when you fail to acquire the connection | RetryInterval |
| Choose whether to output the log | LogEnabled |
| Period from the last usage of connection until you determine whether to cancel the connection automatically (connection sweeper) | ConnectionTimeout |
| Interval for canceling the connection automatically (connection sweeper) | SweeperInterval |
| Choose whether to manage the requests for connection acquisition in a queue when the connections are used up | RequestQueueEnable |
| Maximum waiting time when the requests for connection acquisition (when the connections are used up) are managed in a queue | RequestQueueTimeout |
| Choose whether to enable alert output for monitoring the connection pool | WatchEnabled |
| Interval for monitoring the connection pool | WatchInterval |
| Threshold value for monitoring the usage state of the connection pool | WatchThreshold |
| Choose whether to output the connection pool monitoring results to a file | WatchWriteFileEnabled |
| Interval for operating the connection count adjustment function | ConnectionPoolAdjustmentInterval |
| Choose whether to enable the warming up function of the connection pool | Warmup |
| Choose whether to enable the timeout of the network failure detection function | NetworkFailureTimeout |
For details on the property settings, see 4.1.1 Contents of the HITACHI Connector Property file in the uCosminexus Application Server Application and Resource Definition Reference Guide.
For connection pooling operations and notes on using the connection pooling functionality, see 3.14.1 Connection pooling in the uCosminexus Application Server Common Container Functionality Guide.
For precautions to be taken when you use the warming up function of the connection pool, see (6) Notes.
The following table describes the settings for the optional name information (<outbound-resourceadapter> - <connection-definition> - <connector-runtime> - <resource-external-property> tag) of the DB connector:
| Items | Mandatory | Corresponding tags |
|---|---|---|
| Resource optional name | Y | <optional-name> |
| Resource authentication method | O | <res-auth> |
| Resource sharing scope | O | <res-sharing-scope> |
For details on the property settings, see 4.1.1 Contents of the HITACHI Connector Property file in the uCosminexus Application Server Application and Resource Definition Reference Guide.
For details on how to use an optional name of the DB Connector, see 4.8 Referencing and changing the resource adapter names registered in the JNDI name space.
This subsection shows examples of configuration property settings for the following DB Connectors:
The following table describes an example of configuration property settings when using HiRDB or XDM/RD E2 with DBConnector_HiRDB_Type4_CP.rar:
Table 4-5 Example of configuration property settings when using HiRDB or XDM/RD E2 as a database (With DBConnector_HiRDB_Type4_CP.rar)
| Item names | Example of settings for HiRDB | Example of settings for XDM/RD E2 |
|---|---|---|
| Description | HiRDB- port-number# | Server-schedule-number-of-the-database-connection-server# |
| DBHostName | HiRDB-host-name | XDM/RD E2-host-name |
| environmentVariables | HiRDB-client-environment-variable-names | HiRDB-client-environment-variable-names |
| loginTimeout | 8 | 8 |
| encodeLang | -- | -- |
| JDBC_IF_TRC | false | false |
| TRC_NO | 500 | 500 |
| uapName | -- | -- |
| LONGVARBINARY_Access | REAL | REAL |
| SQLInNum | 300 | 300 |
| SQLOutNum | 300 | 300 |
| SQLWarningLevel | SQLWARN | SQLWARN |
| SQLWarningIgnore | false | false |
| HiRDBCursorMode | false | false |
| maxBinarySize | 0 | 0 |
| LONGVARBINARY_AccessSize | 0 | 0 |
| LONGVARBINARY_TruncError | true | true |
| PreparedStatementPoolSize | 10 | 10 |
| CallableStatementPoolSize | 10 | 10 |
| CancelStatement | true | true |
| logLevel | ERROR | ERROR |
The following table describes an example of configuration property settings when using HiRDB with DBConnector_HiRDB_Type4_XA.rar:
Table 4-6 Example of configuration property settings when using HiRDB as database (With DBConnector_HiRDB_Type4_XA.rar)
| Item names | Example of settings for HiRDB |
|---|---|
| Description | Environment-variable-group-identifier |
| DBHostName | HiRDB-host-name |
| environmentVariables | HiRDB-client-environment-variable-names |
| XAOpenString | <Environment-variable-group-identifier#1> + <Path-of-environment-variable-group-setup-file#2> |
| loginTimeout | 8 |
| encodeLang | -- |
| JDBC_IF_TRC | false |
| TRC_NO | 500 |
| uapName | -- |
| LONGVARBINARY_Access | REAL |
| SQLInNum | 300 |
| SQLOutNum | 300 |
| SQLWarningLevel | SQLWARN |
| SQLWarningIgnore | false |
| HiRDBCursorMode | false |
| maxBinarySize | 0 |
| LONGVARBINARY_AccessSize | 0 |
| LONGVARBINARY_TruncError | true |
| XACloseString | -- |
| XALocalCommitMode | true |
| PreparedStatementPoolSize | 10 |
| CallableStatementPoolSize | 10 |
| CancelStatement | true |
| logLevel | ERROR |
The following table describes the example of configuration property settings when using Oracle with DBConnector_Oracle_CP.rar:
Table 4-7 Example of configuration property settings when using Oracle as the database (with DBConnector_Oracle_CP.rar)
| Item names | Example of settings for Oracle |
|---|---|
| databaseName | Oracle-SID |
| serverName | Oracle-host-name or IP-address |
| portNumber | 1521 |
| url | -- |
| loginTimeout | 8000 |
| PreparedStatementPoolSize | 10 |
| CallableStatementPoolSize | 10 |
| CancelStatement | true |
| ConnectionIDUpdate | false |
| logLevel | ERROR |
The following table describes the example of configuration property settings when using Oracle with DBConnector_Oracle_XA.rar:
Table 4-8 Example of configuration property settings when using Oracle as the database (with DBConnector_Oracle_XA.rar)
| Item names | Example of settings for Oracle |
|---|---|
| databaseName | Oracle-SID |
| serverName | Oracle-host-name or IP-address |
| portNumber | 1521 |
| url | -- |
| loginTimeout | 8000 |
| sessionTimeout | 300 |
| PreparedStatementPoolSize | 10 |
| CallableStatementPoolSize | 10 |
| CancelStatement | true |
| ConnectionIDUpdate | false |
| logLevel | ERROR |
The following table describes the example of configuration property settings when using SQL Server with DBConnector_SQLServer_CP.rar.
Table 4-9 When using SQL Server as the database
| Item names | Example of settings for SQL Server |
|---|---|
| databaseName | SQL-Server-database-name |
| serverName | SQL-Server-host-name-or-IP address |
| applicationName | Name-of-application-to-be-connected-to- SQL-Server |
| instanceName | Name-of-instance-to-be-connected-to- SQL-Server |
| lastUpdateCount | true |
| lockTimeout | -1 |
| loginTimeout | 8 |
| portNumber | 1433 |
| selectMethod | cursor |
| sendStringParametersAsUnicode | true |
| workstationID | Host-name-of-Application Server |
| xopenStates | false |
| failoverPartner | Name-of-failover-server-used-in-database-mirroring-configuration |
| integratedSecurity | false |
| packetSize | 4096 |
| PreparedStatementPoolSize | 10 |
| CallableStatementPoolSize | 10 |
| CancelStatement | true |
| logLevel | ERROR |
| applicationIntent | ReadWrite |
| multiSubnetFailover | false |
All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.