Hitachi

uCosminexus Application Server Application and Resource Definition Reference Guide


2.2.9 Details of the Connector property

This subsection describes the details of the Connector property of cosminexus.xml with reference to each tag. The values specified in the <property-value> tag and the <property-name> tag are described for each specifiable range.

Note that the tag details are described in the order mentioned in 2.1 Specifications of the Cosminexus application property file (cosminexus.xml).

Organization of this subsection

(1) <rar>

Description

This tag defines the information concerning rar.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(2) <module-name>

Description

This is a key for identifying the resource adapter.

The set value is specified according to the following conditions:

For an application that includes application.xml
  • Common to the archive format and exploded archive format

    This tag specifies the character string specified in <application>-<module>-<connector> in application.xml.

For an application that does not include application.xml
  • Archive format (cjimportapp command (-f/-d))

    This tag specifies the location of the RAR file within the J2EE application using the relative path from the EAR root.

  • Exploded archive format (cjimportapp command (-a))

    This tag specifies the location of the RAR file within an application directory using the relative path from the application directory.

Precautions when using a relative path
  • Use a forward slash (/) as the path delimiter.

  • You cannot specify a forward slash (/) at the beginning of the path string.

  • You cannot specify "./", "../", and "//" in the path string.

Specifiable value

There are no limitations for the input value.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(3) <resourceadapter>

Description

This tag defines the information about the resource adapter.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(4) <outbound-resourceadapter>

Description

This tag defines the resource adapter in the outbound direction.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(5) <connection-definition>

Description

This tag defines the connection interface class.

Supplement

About the lower tag <connector-property>

The <property-value> tag is mentioned in each property because the range of the set value is different for each <property-name> tag.

When multiple <property> tags are specified, and the set values of the <property-name> tags are the same, the tags are merged into one. In such cases, a warning message (KDJE42377-W) is output, and the value of the <property-value> tag of the <property> tag defined first is enabled.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(6) <connectionfactory-interface>

Description

This tag specifies the class name of the ConnectionFactory interface supported by the resource.

For a resource adapter conforming to Connector 1.5 or later versions, the value of this tag is the connection definition identifier.

Specify this tag from the package when the package is defined.

Specifiable value

There are no limitations for the input value.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(7) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(8) <property-name>

Description

This tag specifies the MaxPoolSize property.

Specifiable value

You can specify the following character strings:

  • MaxPoolSize

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(9) <property-value>

Description

This tag specifies the maximum value of the pool as the property value.

Specifiable value

Specify an integer value of -1 (infinite) or from 0 to 2147483647.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(10) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(11) <property-name>

Description

This tag specifies the MinPoolSize property.

Specifiable value

You can specify the following character strings:

  • MinPoolSize

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(12) <property-value>

Description

This tag specifies the minimum value of the pool as the property value.

Specifiable value

Specify an integer value from 0 to 2147483647.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(13) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(14) <property-name>

Description

This tag specifies the LogEnabled property.

Specifiable value

You can specify the following character strings:

  • LogEnabled

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(15) <property-value>

Description

This tag specifies the requirement of the log output by LogWriter, as the property value.

Specifiable value
  • true

    The log will be output.

  • false

    The log will not be output.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(16) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(17) <property-name>

Description

This tag specifies the User property.

Specifiable value

You can specify the following character strings:

  • User

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(18) <property-value>

Description

This tag specifies the user name as the property value.

Specifiable value

There are no limitations for the input value.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You can omit the value of this tag.

(19) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(20) <property-name>

Description

This tag specifies the Password property.

Specifiable value

You can specify the following character strings:

  • Password

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(21) <property-value>

Description

This tag specifies the password as the property value.

Specifiable value

There are no limitations for the input value.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You can omit the value of this tag.

(22) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(23) <property-name>

Description

This tag specifies the ValidationType property.

Specifiable value

You can specify the following character strings:

  • ValidationType

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(24) <property-value>

Description

Specifies the property value of the connection check trigger.

Specifiable value
  • 0: Connection check functionality OFF

  • 1: Connection is checked when the connection is acquired

  • 2: Connection is checked at a fixed interval

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(25) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(26) <property-name>

Description

This tag specifies the ValidationInterval property.

Specifiable value

You can specify the following character strings:

  • ValidationInterval

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(27) <property-value>

Description

This tag specifies the connection check interval (seconds) as the property value.

Specifiable value

Specify an integer value from 1 to 2147483647.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(28) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(29) <property-name>

Description

This tag specifies the RetryCount property.

Specifiable value

You can specify the following character strings:

  • RetryCount

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(30) <property-value>

Description

This tag specifies the connection retry count as the property value.

Specifiable value

Specify an integer value from 0 to 2147483647.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(31) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(32) <property-name>

Description

This tag specifies the RetryInterval property.

Specifiable value

You can specify the following character strings:

  • RetryInterval

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(33) <property-value>

Description

This tag specifies the connection retry interval (seconds) as the property value.

Specifiable value

Specify an integer value from 1 to 2147483647.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(34) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(35) <property-name>

Description

This tag specifies the ConnectionTimeout property.

Specifiable value

You can specify the following character strings:

  • ConnectionTimeout

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(36) <property-value>

Description

This tag specifies the timeout value (seconds) until the release of a connection, as the property value.

Specifiable value

Specify an integer value from 0 to 2147483647.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(37) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(38) <property-name>

Description

This tag specifies the ConnectionPoolAdjustmentInterval property.

Specifiable value

You can specify the following character strings:

  • ConnectionPoolAdjustmentInterval

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(39) <property-value>

Description

This tag specifies the soft landing operation adjustment interval (seconds) of the connection count as the property value.

Specifiable value

Specify an integer value from 0 to 2147483647.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(40) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(41) <property-name>

Description

This tag specifies the SweeperInterval property.

Specifiable value

You can specify the following character strings:

  • SweeperInterval

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(42) <property-value>

Description

This tag specifies the connection sweeper operation time interval (seconds) as the property value.

Specifiable value

Specify an integer value from 0 to 2147483647.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(43) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(44) <property-name>

Description

This tag specifies the RequestQueueEnable property.

Specifiable value

You can specify the following character strings:

  • RequestQueueEnable

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(45) <property-value>

Description

This tag specifies the requirement of a connection pending queue for connection depletion, as the property value.

Specifiable value
  • true

    The connection pending queue functionality during connection depletion will be enabled.

  • false

    The connection pending queue functionality during connection depletion will be disabled.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(46) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(47) <property-name>

Description

This tag specifies the RequestQueueTimeout property.

Specifiable value

You can specify the following character strings:

  • RequestQueueTimeout

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(48) <property-value>

Description

This tag specifies the maximum value (seconds) for which the connection pending queue for connection depletion can be retained, as the property value.

Specifiable value

Specify an integer value from 0 to 2147483647.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(49) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(50) <property-name>

Description

This tag specifies the WatchEnabled property.

Specifiable value

You can specify the following character strings:

  • WatchEnabled

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(51) <property-value>

Description

This tag specifies whether to enable the output of an alert for connection pool monitoring, as the property value.

Specifiable value
  • true

    Alert output will be enabled.

  • false

    Alert output will be disabled.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(52) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(53) <property-name>

Description

This tag specifies the WatchInterval property.

Specifiable value

You can specify the following character strings:

  • WatchInterval

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(54) <property-value>

Description

This tag specifies the connection pool monitoring interval (seconds) as the property value.

Specifiable value

Specify an integer value from 1 to 2147483647.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(55) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(56) <property-name>

Description

This tag specifies the WatchThreshold property.

Specifiable value

You can specify the following character strings:

  • WatchThreshold

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(57) <property-value>

Description

This tag specifies the threshold value (%) for monitoring the connection pool usage status, as the property value.

Specifiable value

Specify an integer value from 1 to 100.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(58) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(59) <property-name>

Description

This tag specifies the WatchWriteFileEnabled property.

Specifiable value

You can specify the following character strings:

  • WatchWriteFileEnabled

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(60) <property-value>

Description

This tag specifies whether to output the connection pool monitoring results to a file, as the property value.

Specifiable value
  • true

    The monitoring results will be output to a file.

  • false

    The monitoring results will not be output to a file.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(61) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(62) <property-name>

Description

This tag specifies the Warmup property.

Specifiable value

You can specify the following character strings:

  • Warmup

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(63) <property-value>

Description

This tag specifies whether to enable the warming up functionality of the connection pool, as the property value.

Specifiable value
  • true

    The warming up functionality of the connection pool will be enabled.

  • false

    The warming up functionality of the connection pool will be disabled.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(64) <connector-property>

Description

This tag sets up the information unique to the connection interface class.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(65) <property-name>

Description

This tag specifies the NetworkFailureTimeout property.

Specifiable value

You can specify the following character strings:

  • NetworkFailureTimeout

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(66) <property-value>

Description

This tag specifies whether to enable the timeout of the network failure detection functionality, as the property value.

Specifiable value
  • true

    The timeout of the network failure detection functionality will be enabled.

  • false

    The timeout of the network failure detection functionality will be disabled.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(67) <resource-external-property>

Description

This tag defines the resource.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(68) <optional-name>

Description

This tag specifies the optional name of the resource.

Specifiable value

You can specify alphanumeric characters (0 to 9, A to Z, and a to z) and the following special characters:

Space ( ), exclamation mark (!), double quotation mark ("), hash mark (#), dollar sign ($), percent sign (%), ampersand (&), single quotation ('), left parenthesis and right parenthesis (() ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), forward slash (/), colon (:), semicolon (;), less-than sign (<), equal sign (=), greater-than sign (>), question mark (?), at mark (@), square brackets ([) (]), yen sign ([Figure]), caret (^), underscore (_), grave accent mark (`), curly brackets ({) (}), vertical bar (|), and tilde (~).

You can specify 1 to 255 characters.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(69) <res-auth>

Description

This tag specifies whether to perform authentication for using a resource in the application or to entrust authentication to the container.

Specifiable value

You can specify the following character strings:

  • Application

  • Container

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(70) <res-sharing-scope>

Description

This tag specifies whether to enable the sharing of a resource connection.

Specifiable value

You can specify the following character strings:

  • Shareable

  • Unshareable

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(71) <adminobject>

Description

This tag defines the administered objects provided by the resource adapter.

You must set up as many tags as the number of <adminobject> tags in the DD and in the same order (if the same number of tags is not set up, you specify the empty tag <adminobject/>).

If it is not required to set up <adminobject-name> in all the <adminobject> tags, you can omit this tag.

Specifiable value

None.

Dependency on other tags

This tag depends on the <adminobject> tag of DD.

Tag omission

You can omit this tag.

Value omission

You can omit the value of this tag.

(72) <adminobject-name>

Description

This tag specifies the administered object name. This name must be unique within a resource adapter.

Specifiable value

You can use alphanumeric characters (0 to 9, A to Z, and a to z) and the following special characters:

Space ( ), exclamation mark (!), double quotation mark ("), hash mark (#), dollar sign ($), percent sign (%), ampersand (&), single quotation ('), left parenthesis and right parenthesis (() ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), colon (:), semicolon (;), less-than sign (<), equal sign (=), greater-than sign (>), question mark (?), at mark (@), square brackets ([) (]), yen sign ([Figure]), caret (^), underscore (_), grave accent mark (`), curly brackets ({) (}), vertical bar (|), and tilde (~)

You cannot, however, specify the following names:

  • Name containing a period (.) at the beginning or at the end

  • Name containing a period (.) only

  • Name containing continuous underscores (_)

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You can omit the value of this tag.

(73) <resourceadapter-property>

Description

This tag defines a resource adapter corresponding to the Connector 1.5 specifications.

Note that tags lower than this tag can be specified only for a resource adapter conforming to Connector 1.5 or later versions.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(74) <property-name>

Description

This tag specifies the MaxTPoolSize property.

Specifiable value

You can specify the following character strings:

  • MaxTPoolSize

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(75) <property-value>

Description

This tag specifies the maximum number of threads executed concurrently in a thread pool, as the property value.

Specifiable value

Specify an integer value from 1 to 2147483647.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(76) <resourceadapter-property>

Description

This tag defines a resource adapter corresponding to the Connector 1.5 specifications.

Note that tags lower than this tag can be specified only for a resource adapter conforming to Connector 1.5 or later versions.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(77) <property-name>

Description

This tag specifies the MinTPoolSize property.

Specifiable value

You can specify the following character strings:

  • MinTPoolSize

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(78) <property-value>

Description

This tag specifies the minimum number of threads that exist in the thread pool, as the property value.

Specifiable value

Specify an integer value from 0 to 1024.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(79) <resourceadapter-property>

Description

This tag defines a resource adapter corresponding to the Connector 1.5 specifications.

Note that tags lower than this tag can be specified only for a resource adapter conforming to Connector 1.5 or later versions.

Specifiable value

None.

Dependency on other tags

None.

Tag omission

You can omit this tag.

Value omission

You cannot omit the value of this tag.

(80) <property-name>

Description

This tag specifies the TpoolKeepalive property.

Specifiable value

You can specify the following character strings:

  • TPoolKeepalive

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.

(81) <property-value>

Description

This tag specifies the timeout value (seconds) until the release of threads of the thread pool, as the property value.

Specifiable value

Specify an integer value from 1 to 2147483647.

Dependency on other tags

None.

Tag omission

You cannot omit this tag.

Value omission

You cannot omit the value of this tag.