4.1.1 Specifications of the HITACHI Connector Property file

Tag name

Displays the tag to be set.

Occurrence pattern

Indicates the frequency of occurrence of the tag.

Contents

Indicates the contents to be defined for the tag.

Specifiable value

Indicates the values that you can specify in the tag. If no value can be specified, a hyphen (-) is specified.

Default

Indicates the value that is enabled when the contents to be specified in the tag are omitted. If no default value exists, "None" is specified.

Version

Indicates the Application Server version that can be defined.

<hitachi-connector-property>

Zero or once

This is the root tag.

--

None

05-05

<description>

Zero or more times

Describes the resource adapter.

There are no limitations for the input value.

None

05-05

<display-name>

One or more times

Specifies the name of the resource adapter displayed on the Deploy tool.

You can use only alphanumeric characters or underscore (_).

You can specify the value in the range of 1 ≤ character-string-length ≤ 240. The number of characters that you can specify is 1 to range-estimated-with-the-formula^#-for-estimating-the-work-directory-path-length.

To change the value, you can use alphanumeric characters (0 to 9, A to Z, a to z), and the following special characters:

plus sign (+), hyphen (-), period (.), caret (^), underscore (_)

"TP1/Message Queue - Access" is the rar display name of TP1/Message Queue - Access, and therefore, can be specified. You cannot, however, specify the following names:

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

• Name containing only a period (.)

If you specify the following names, you might not be able to operate the J2EE applications. Therefore, do not specify the following names:

• Name specifying an underscore (_) before and after a sign (example: abc_+_001)

• Name ending with a sign (example: abc+)

None

05-05

<icon>

Zero or more times

Defines the icons of the resource adapter displayed on the Deploy tool.

--

None

05-05

<small-icon>

Zero or once

Specifies the file name for small icons (16 × 16).

There are no limitations for the input value.

None

05-05

<large-icon>

Zero or once

Specifies the file name for large icons (32 × 32).

There are no limitations for the input value.

None

05-05

<vendor-name>

Once

Specifies the vendor name of the resource adapter provider.

You cannot change this tag.

There are no limitations for the input value.

None

05-05

<spec-version>

Once

Specifies the version of the connector architecture specifications supported by the resource adapter.

You cannot change this tag.

There are no limitations for the input value.

None

05-05

<eis-type>

Once

Specifies the information about the EIS type.

You cannot change this tag.

There are no limitations for the input value.

None

05-05

<version>

Once

Specifies the resource adapter version.

You cannot change this tag.

There are no limitations for the input value.

None

05-05

<license>

Zero or once

Defines the license request of the resource adapter module.

--

None

05-05

<description>

Zero or more times

Describes the license.

There are no limitations for the input value.

None

07-60

<license-required>

Once

Specifies the flag for license request when deploying or using resource adapters.

You cannot change this tag.

You can specify the following strings:

• true: Requested

• false: Not requested

None

05-05

<resourceadapter>

Once

Defines the resource adapter settings.

--

None

05-05

<resourceadapter-class>

Zero or once

Specifies the Java class name in which javax.resource.spi.ResourceAdapter is implemented.

You cannot change this tag.

There are no limitations for the input value.

None

07-50

<config-property>

Zero or more times

Defines the configuration properties of the ResourceAdapter instance.

You can specify this tag only for resource adapters conforming to Connector 1.5 specifications.

--

None

05-05

<description>

Zero or more times

Describes the configuration property.

There are no limitations for the input value.

None

05-05

<config-property-name>

Once

Specifies the name of the configuration property.

You cannot specify a duplicate name.

For details on the TP1 inbound adapter settings, see 4.1.10(4) Properties that you can specify in the <config-property> tag set up for TP1 inbound adapter.

For details on the resource adapter settings of Cosminexus JMS provider, see 4.1.11 Properties that you can specify in the <config-property> tag set up for resource adapters of Cosminexus JMS provider.

None

05-05

<config-property-type>

Once

Specifies the Java type of the configuration property requested by ResourceAdapter.

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

None

05-05

<config-property-value>

Zero or once

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 space will be specified in the information of that property.

When the <config-property-value> tag is specified, and a value is also specified, the specified value will be set up in the property.

There are no limitations for the input value.

None

05-05

<outbound-resourceadapter>

Zero or once

Specifies the definition of the resource adapter in the Outbound direction.

--

None

07-50

<connection-definition>

One or more times

Defines the connection interface class.

--

None

07-50

<managedconnectionfactory-class>

Once

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.

There are no limitations for the input value.

None

05-05

<config-property>

Zero or more times

Defines the configuration property.

--

None

05-05

<description>

Zero or more times

Describes the configuration property.

There are no limitations for the input value.

None

05-05

<config-property-name>

Once

Specifies the configuration property name.

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.11 Properties that you can specify in the <config-property> tag set up for resource adapters of Cosminexus JMS provider.

None

05-05

<config-property-type>

Once

Specifies the Java type of the configuration property requested by ResourceAdapter.

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

None

05-05

<config-property-value>

Zero or once

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 space will be specified in the information of that property.

When the <config-property-value> tag is specified, and a value is also specified, the specified value will be set up 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, add the <config-property-value> tag, and then specify the value after change.

If XAOpenString is set in the <config-property-name> tag when you execute the cjgetresprop or cjgetrarprop command, the tag will be 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 <>

There are no limitations for the input value.

None

05-05

<connectionfactory-interface>

Once

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.

There are no limitations for the input value.

None

05-05

<connectionfactory-impl-class>

Once

Specifies the Java class name in which the ConnectionFactory interface is implemented. You specify from the package when the package is defined.

You cannot change this tag.

There are no limitations for the input value.

None

05-05

<connection-interface>

Once

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.

There are no limitations for the input value.

None

05-05

<connection-impl-class>

Once

Specifies the Java class name in which the Connection interface is implemented. Specified from the package when the package is defined.

You cannot change this tag.

There are no limitations for the input value.

None

05-05

<connector-runtime>

Zero or once

Defines the runtime property.

--

None

07-50

<property>

Zero or more times

Sets up the information unique to the connection interface class.

--

None

05-05

<property-name>

Once

Specifies the property name.

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

None

05-05

<property-type>

Once

Specifies the Java type of the property value.

There are no limitations for the input value.

None

05-05

<property-value>

Zero or once

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 will be specified in the information of that property.

When the <property-value> tag is specified, and a value is also specified, the specified value will be set up in the property.

When User or Password is specified 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, 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 <>

There are no limitations for the input value.

See 4.1.12 Properties that you can specify for the <property> tag.

--

05-05

<property-default-value>

Zero or once

Specifies the default value of the property.

You cannot change this tag.

There are no limitations for the input value.

--

05-05

<resource-external-property>

Zero or more times

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 value of <res-auth> and <res-sharing-scope> of the <resource-external-property> tag defined later becomes valid.

--

None

07-00

<description>

Zero or once

Describes the optional name of the resource.

There are no limitations for the input value.

None

07-00

<optional-name>

Once

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 ≤ character-string-length ≤ 255

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 (), caret (^), underscore (_), grave accent mark (`), curly brackets ({) (}), vertical bar (|), and tilde (~)

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 (/).

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.

None

07-00

<res-auth>

Zero or once

Specifies whether to perform authentication for using resources in the application or to entrust authentication to the container.

You can specify the following strings:

• Application

• Container

Container

07-00

<res-sharing-scope>

Zero or once

Specifies whether to enable the sharing of a resource connection.

You can specify the following strings:

• Shareable

• Unshareable

Shareable

07-00

<transaction-support>

Once

Specifies the transaction support level provided in the resource adapter.

You can specify the following strings:

• NoTransaction

• LocalTransaction

• XATransaction

None

05-05

<reauthentication-support>

Once

Specifies whether to support the reauthentication of the ManagedConnection instance.

You can specify the following strings:

(Note: Setting true does not take effect if DB Connector is used.)

• true

• false

None

05-05

<inbound-resourceadapter>

Zero or once

Defines the resource adapter in the Inbound direction. You cannot change this tag.

--

None

07-60

<messageadapter>

Zero or once

Defines the messaging-related functionality of the resource adapter.

You cannot change this tag.

--

None

07-60

<messagelistener>

One or more times

Defines the message listener.

You cannot change this tag.

--

None

07-60

<messagelistener-type>

Once

Specifies the message listener type.

You cannot change this tag.

There are no limitations for the input value.

None

07-60

<activationspec>

Once

Specifies the information for message endpoint activation. You cannot change this tag.

--

None

07-60

<activationspec-class>

Once

Specifies the class in which the ActivationSpec interface is implemented. You cannot change this tag.

There are no limitations for the input value.

None

07-60

<required-config-property>

Zero or more times

Specifies the properties that must be set up for message endpoint activation.

You cannot change this tag.

--

None

07-60

<description>

Zero or more times

Describes the properties that must be set up for message endpoint activation.

You cannot change this tag.

There are no limitations for the input value.

None

07-60

<config-property-name>

Once

Specifies the name of the properties that must be set up for message endpoint activation.

You cannot change this tag.

There are no limitations for the input value.

None

07-60

<adminobject>

Zero or more times

Defines the administered objects provided by the resource adapter.

You can specify the definition about the Administered object, only for the resource adapter that complies with the specifications of Connector 1.5.

--

None

07-60

<adminobject-name>

Zero or once

Specifies the administered object name.

This name must be unique within a resource adapter.

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 (), caret (^), underscore (_), grave accent mark (`), curly brackets ({) (}), vertical bar (|), and tilde (~)

Note that you cannot use continuous underscores (_).

You cannot specify the following names:

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

• Name containing a period (.) only

• Name containing continuous underscores (_)

Any single-byte space or linefeed at the beginning or end of the character string is removed.

None

07-60

<adminobject-interface>

Once

Specifies the interface implemented by the administered object class.

There are no limitations for the input value.

None

07-60

<adminobject-class>

Once

Specifies the administered object class.

There are no limitations for the input value.

None

07-60

<config-property>

Zero or more times

Defines the configuration property for the administered object.

--

None

07-60

<description>

Zero or more times

Describes the configuration property.

There are no limitations for the input value.

None

07-60

<config-property-name>

Once

Specifies the name of the configuration property.

You cannot specify a duplicate name.

None

07-60

<config-property-type>

Once

Specifies the Java type of the configuration property requested by the adminobject instance.

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

None

07-60

<config-property-value>

Zero or once

Specifies the configuration property value. The following operation is performed when executing the cjsetresprop command and the cjsetrarprop command:

When the <config-property-value> tag is not specified

The property information is set up as blank.

When the <config-property-value> tag is specified, and the value is blank

The property information is set up as blank.

When the <config-property-value> tag is specified, and a value is also specified

The value specified in the property is set up.

There are no limitations for the input value.

None

07-60

<security-permission>

Zero or more times

Defines the security permission.

You cannot change this tag.

--

None

05-05

<description>

Zero or more times

Describes the security permission requested from the code of the resource adapter.

You cannot change this tag.

There are no limitations for the input value.

None

05-05

<security-permission-spec>

Once

Specifies the security permission for the security policy file.

You cannot change this tag.

There are no limitations for the input value.

None

05-05

<resourceadapter-runtime>

Zero or once

You can specify this tag only for the resource adapters conforming to Connector 1.5 specifications.

--

None

07-50

<property>

Zero or more times

Sets up unique information for the resource adapter.

--

None

05-05

<property-name>

Once

Specifies the property name.

Specify any one of the following:

• MaxTPoolSize

• MinTPoolSize

• TPoolKeepalive

None

05-05

<property-type>

Once

Specifies the property type.

There are no limitations for the input value.

None

05-05

<property-value>

Zero or once

Specifies the Java type of the property value.

There are no limitations for the input value.

See 4.1.12 Properties that you can specify for the <property> tag.

--

05-05

<property-default-value>

Zero or once

Specifies the default value of the property.

You cannot change this tag.

There are no limitations for the input value.

See 4.1.12 Properties that you can specify for the <property> tag.

--

05-05