4.1.5 Defining outbound resource adapters

This subsection describes the details on defining the outbound resource adapters in the HITACHI Connector Property File with reference to each tag.

Note that the tag details are described in the order mentioned in 4.1.1 Specifications of the HITACHI Connector Property file.

Organization of this subsection
(1) <outbound-resourceadapter>
(2) <connection-definition>
(3) <managedconnectionfactory-class>
(4) <config-property>
(5) <description>
(6) <config-property-name>
(7) <config-property-type>
(8) <config-property-value>
(9) <connectionfactory-interface>
(10) <connectionfactory-impl-class>
(11) <connection-interface>
(12) <connection-impl-class>
(13) <connector-runtime>
(14) <property>
(15) <property-name>
(16) <property-type>
(17) <property-value>
(18) <property-default-value>
(19) <resource-external-property>
(20) <description>
(21) <optional-name>
(22) <res-auth>
(23) <res-sharing-scope>
(24) <transaction-support>
(25) <reauthentication-support>

(1) <outbound-resourceadapter>

Description
This tag defines the resource adapter in the outbound direction.
Specifiable value
--
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(2) <connection-definition>

Description
This tag defines the connection interface class.
Specifiable value
--
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(3) <managedconnectionfactory-class>

Description
This tag specifies the Java class name in which the javax.resource.spi.ManagedConnectionFactory interface is implemented.
Specified from the package when the package is defined.
You cannot change this tag.
Specifiable value
There are no limitations for the input value.
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(4) <config-property>

Description
This tag defines the configuration property for the connection interface class.
Specifiable value
--
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(5) <description>

Description
This tag describes the configuration property.
Specifiable value
There are no limitations for the input value.
Tag omission
You can omit this tag.
Value omission
You can omit the value of this tag.

(6) <config-property-name>

Description
This tag specifies the name of the configuration property.
Specifiable value
You cannot specify a duplicate name.
For details on the DB Connector settings, see 4.1.10 Properties that you can specify in the <config-property> tag set up for DB Connector.
For details on the resource adapter settings of Cosminexus JMS provider, see 4.1.12 Properties that you can specify in the <config-property> tag set up for resource adapters of Cosminexus JMS provider.
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(7) <config-property-type>

Description
This tag specifies the Java type of the configuration property requested by ResourceAdapter.
Specifiable value
Specify any one of the following:
  • java.lang.Boolean
  • java.lang.String
  • java.lang.Integer
  • java.lang.Double
  • java.lang.Byte
  • java.lang.Short
  • java.lang.Long
  • java.lang.Float
  • java.lang.Character
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(8) <config-property-value>

Description
This tag specifies the configuration property value.
When the <config-property-value> tag is not specified, the information about that property is not changed. The already set up information is retained as is.
When the <config-property-value> tag is specified, and if no value is specified, a blank is set in the information of that property.
When the <config-property-value> tag is specified, and a value is also specified, the specified value is set in the property.
When XAOpenString is set in the <config-property-name> tag, and a value is specified in the <config-property-value> tag, the <config-property-value> tag is not displayed for security reasons. To change the value, you add the <config-property-value> tag, and then specify the value after change.
When XAOpenString is set in the <config-property-name> tag when you execute the cjgetresprop or cjgetrarprop command, the tag is displayed as follows:
When a value is specified:
Comment tag <!-- The config-property-value has already been set. -->
When no value is specified:
Empty tag <>
Specifiable value
There are no limitations for the input value.
Tag omission
You can omit this tag.
Value omission
You can omit the value of this tag.

(9) <connectionfactory-interface>

Description
This tag specifies the class name of the ConnectionFactory interface supported by the resource. Specified from the package when the package is defined.
For resource adapters conforming to Connector 1.5 specifications, the value of this tag will become the connection definition identifier.
You cannot change this tag.
Specifiable value
There are no limitations for the input value.
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(10) <connectionfactory-impl-class>

Description
This tag specifies the Java class name in which the ConnectionFactory interface is implemented. Specified from the package when the package is defined.
You cannot change this tag.
Specifiable value
There are no limitations for the input value.
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(11) <connection-interface>

Description
This tag specifies the class name of the Connection interface supported by the resource adapter. Specified from the package when the package is defined.
You cannot change this tag.
Specifiable value
There are no limitations for the input value.
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(12) <connection-impl-class>

Description
This tag specifies the Java class name in which the Connection interface is implemented. Specified from the package when the package is defined.
Specifiable value
There are no limitations for the input value.
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(13) <connector-runtime>

Description
This tag defines the runtime property.
Specifiable value
--
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(14) <property>

Description
This tag sets up the information unique to the connection interface class.
Specifiable value
--
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(15) <property-name>

Description
This tag specifies the property name.
Specifiable value
Specify any one of the following:
  • MaxPoolSize
  • MinPoolSize
  • LogEnabled
  • User
  • Password
  • ValidationType
  • ValidationInterval
  • RetryCount
  • RetryInterval
  • ConnectionTimeout
  • SweeperInterval
  • RequestQueueEnable
  • RequestQueueTimeout
  • WatchEnabled
  • WatchInterval
  • WatchThreshold
  • WatchWriteFileEnabled
  • ConnectionPoolAdjustmentInterval
  • Warmup
  • NetworkFailureTimeout
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(16) <property-type>

Description
This tag specifies the Java type of the property value.
Specifiable value
There are no limitations for the input value.
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(17) <property-value>

Description
This tag specifies the property value.
When the <property-value> tag is not specified, the information about that property is not changed. The already set up information is retained as is.
When the <property-value> tag is specified, and if no value is specified, a blank is set in the information of that property.
When the <property-value> tag is specified, and a value is also specified, the specified value is set in the property.
When User or Password is set in the <property-name> tag, and a value is specified in the <property-value> tag, the <property-value> tag is not displayed for security reasons. To change the value, you add the <property-value> tag, and then specify the value after change.
When a value is specified:
Comment tag <!-- The property-value has already been set. -->
When no value is specified:
Empty tag <>
Specifiable value
There are no limitations for the input value.
Tag omission
You can omit this tag.
Value omission
You can omit the value of this tag.

(18) <property-default-value>

Description
This tag specifies the default value of the property.
Specifiable value
There are no limitations for the input value.
Tag omission
You can omit this tag.
Value omission
You can omit the value of this tag.

(19) <resource-external-property>

Description
This tag defines the external properties of the resource.
When multiple <resource-external-property> tags are specified and the set value of <optional-name> is the same, the tags are merged into one. In such cases, a warning message (KDJE37600-W) is output, and the values of <res-auth> and <res-sharing-scope> of the <resource-external-property> tag defined later become valid.
Specifiable value
--
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(20) <description>

Description
This tag describes the optional name of the resource.
Specifiable value
There are no limitations for the input value.
Tag omission
You can omit this tag.
Value omission
You can omit the value of this tag.

(21) <optional-name>

Description
This tag specifies the optional name of the resource.
If multiple <resource-external-property> tags are specified within the same resource, and the specified value of <optional-name> configures the lower hierarchy of the specified value of another <optional-name> tag, a warning message (KDJE37602-W) is output.
Example:

Optional name 1: AAA
Optional name 2: AAA/BBB
1 [Figure] character-string-length [Figure] 255

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 (.), 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 (~)
Any single-byte space or linefeed at the beginning or end of the character string is removed. If a space or linefeed appear in the middle of the character string, an error occurs.
You can specify 1 to 255 characters.
You cannot specify the following names:
  • Names beginning with the reserved word HITACHI_EJB (case sensitive)
  • Names with a forward slash (/) or period (.) specified at the beginning or end
  • Names containing only forward slash (/) or period (.)
  • Names containing continuous forward slashes (/).
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(22) <res-auth>

Description
This tag specifies whether to perform authentication for using resources in the application, or to entrust authentication to the container.
Specifiable value
You can specify the following strings:
  • Application
  • Container
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(23) <res-sharing-scope>

Description
This tag specifies whether to share a resource connection.
Specifiable value
You can specify the following strings:
  • Shareable
  • Unshareable
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(24) <transaction-support>

Description
This tag specifies the transaction support level provided in the resource adapter.
Specifiable value
You can specify the following strings:
  • NoTransaction
  • LocalTransaction
  • XATransaction
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(25) <reauthentication-support>

Description
This tag specifies whether to support the re-authentication of the ManagedConnection instance.
Specifiable value
  • true
  • false
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.