2.2.5 Details of the Message-driven Bean property
(1) <message>
- Description
- This tag defines the Message-driven Bean.
- 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) <ejb-name>
- Description
- Specifies the name of an ejb.
- Note that this key is used for identifying the Message-driven Bean.
- This tag specifies the set value of <ejb-jar>-<enterprise-beans>-<message-driven>-<ejb-name> in the ejb-jar.xml file.
- 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) <security-identity>
- Description
- This tag defines the security identity of the Message-driven Bean.
- 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) <run-as>
- Description
- This tag defines the runtime identity.
- 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.
(5) <user-name>
- Description
- This tag specifies the user name.
- 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.
(6) <message-ref>
- Description
- This tag specifies 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.
(7) <connection-factory>
- Description
- This tag specifies the display name of the resource adapter.
- You cannot specify a resource adapter conforming to Connector 1.5 or later versions.
- Specifiable value
- There are no limitations for the input value.
- Dependency on other tags
- None.
- Tag omission
- You can omit this tag.
- Value omission
- You cannot omit the value of this tag.
(8) <connection-destination>
- Description
- This tag defines the resource adapter.
- 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.
(9) <resource-adapter>
- Description
- This tag specifies the display name of the resource adapter.
- 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.
(10) <queue>
- Description
- This tag specifies the queue name.
- You cannot specify a resource adapter conforming to Connector 1.5 or later versions.
- Specifiable value
- There are no limitations for the input value.
- Dependency on other tags
- None.
- Tag omission
- You can omit this tag.
- Value omission
- You cannot omit the value of this tag.
(11) <resource-ref>
- Description
- This tag defines the resource to be referenced from the Message-driven Bean.
- 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.
(12) <res-ref-name>
- Description
- This tag specifies the name of the resource reference.
- 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.
(13) <linked-to>
- Description
- This tag specifies the corresponding resource adapter display name and the mail display name.
- You cannot specify the member resource adapters of the cluster connection pool.
- Connector 1.0 or earlier versions
Resource-adapter-display-name
- Outbound resource adapter conforming to Connector 1.5 or later versions
Resource-adapter-display-name!Connection-definition-identifier
- Specifiable value
- There are no limitations for the input value.
- Dependency on other tags
- None.
- Tag omission
- You can omit this tag.
- Value omission
- You can omit the value of this tag.
(14) <resource-env-ref>
- Description
- This tag defines the resource environment variable to be referenced from the Message-driven Bean.
- 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.
(15) <resource-env-ref-name>
- Description
- This tag defines the name of resource-env-ref.
- 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.
(16) <linked-queue>
- Description
- This tag specifies the queue name. This tag is enabled only when javax.jms.Queue is specified in the <resource-env-ref-type> tag of the DD.
- Note that any one of the <linked-to> tag, <linked-queue> tag, or the <linked-adminobject> tag is specified.
- Specifiable value
- None.
- Dependency on other tags
- This tag depends on the <resource-env-ref-type> tag of the DD.
- Tag omission
- You can omit this tag.
- Value omission
- You cannot omit the value of this tag.
(17) <resource-adapter>
- Description
- This tag specifies the display name of the resource adapter.
- You cannot specify a resource adapter conforming to Connector 1.5 or later versions.
- 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.
(18) <queue>
- Description
- This tag specifies the queue name.
- 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.
(19) <linked-adminobject>
- Description
- This tag specifies the administered object.
- Note that any one of the <linked-to> tag, <linked-queue> tag, or the <linked-adminobject> tag is specified.
- 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) <resourceadapter-name>
- Description
- This tag specifies the display name of the resource adapter.
- You cannot specify a resource adapter conforming to Connector 1.0 or earlier versions.
- 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.
(21) <adminobject-name>
- Description
- This tag specifies the administered object name.
- 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 (
), 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 cannot omit the value of this tag.
(22) <linked-to>
- Description
- This tag specifies the display name of the JavaBeans resource.
- This tag is enabled only when JavaBeans-resource-class-name is specified in the DD element <resource-env-ref-type>.
- Note that any one of the <linked-to> tag, <linked-queue> tag, or the <linked-adminobject> tag is specified.
- Specifiable value
- There are no limitations for the input value.
- Dependency on other tags
- This tag depends on the <resource-env-ref-type> tag of the DD.
- Tag omission
- You can omit this tag.
- Value omission
- You can omit the value of this tag.
(23) <pooled-instance>
- Description
- The tag defines the instances within a pool.
- 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.
(24) <minimum>
- Description
- This tag specifies the minimum number of instances within a pool.
- However, the value set in this tag is ignored because you can specify a maximum number to customize the pooling operations.
- Specifiable value
- There are no limitations for the input value.
- Dependency on other tags
- None.
- Tag omission
- You can omit this tag.
- Value omission
- You can omit the value of this tag.
(25) <maximum>
- Description
- This tag specifies the maximum number of instances within a pool.
- Specifiable value
- Specify an integer value from 1 to 2147483647.
- If 0 is specified, the value is assumed as 1.
- Dependency on other tags
- None.
- Tag omission
- You cannot omit this tag.
- Value omission
- You cannot omit the value of this tag.
(26) <front-ejb>
- Description
- This tag specifies whether the specified EJB is a front EJB (an EJB invoked directly by the client).
- Specifiable value
- true
The EJB is a front EJB.
- false
The EJB is not a front EJB.
- Dependency on other tags
- None.
- Tag omission
- You can omit this tag.
- Value omission
- You cannot omit the value of this tag.
(27) <start-order>
- Description
- This tag specifies the order of starting and stopping the J2EE applications.
- When starting an application, the start processing is executed in the ascending order and when terminating the application, the stop processing is executed in the descending order.
- Specifiable value
- Specify an integer value from 0 to 2147483647.
- Dependency on other tags
- None.
- Tag omission
- You can omit this tag.
- Value omission
- You cannot omit the value of this tag.
(28) <ejb-method-observation-timeout>
- Description
- This tag is specified when you set up a method timeout value in the EJB method for the functionality used for monitoring the J2EE application run time. When multiple <ejb-method-observation-timeout> tags are specified and the values set under the <method> tags are the same, the tags are merged into one. In such cases, a warning message (KDJE42377-W) is output, and the value of <method-observation-timeout> tag of the <ejb-method-observation-timeout> tag defined first is enabled.
- 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) <method>
- Description
- This tag defines the method.
- 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.
(30) <method-intf>
- Description
- This tag is specified when identifying the interface type to which the method belongs.
- You cannot specify a value for this tag in the Message-driven Bean property settings.
- Specifiable value
- None.
- Dependency on other tags
- None.
- Tag omission
- You can omit this tag.
- Value omission
- You can omit the value of this tag.
(31) <method-name>
- Description
- This tag specifies the target method name.
- An asterisk (*) indicates that all the methods are targets.
- Specifiable value
- There are no limitations for the input value.
- Dependency on other tags
- This tag depends on the <method-params> tag.
- Tag omission
- You cannot omit this tag.
- Value omission
- You cannot omit the value of this tag.
(32) <method-params>
- Description
- This tag is specified to identify a method when multiple methods are defined.
- Specifiable value
- None.
- Dependency on other tags
- None.
- Tag omission
- You can omit this tag.
- Value omission
- You can omit the value of this tag.
(33) <method-param>
- Description
- This tag specifies the data type of the argument.
- 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.
(34) <method-observation-timeout>
- Description
- This tag specifies the method timeout value (seconds) for the functionality used for monitoring the J2EE application run time. When you specify 0, a timeout does not occur.
- Specifiable value
- Specify an integer value from 0 to 86400.
- Dependency on other tags
- None.
- Tag omission
- You cannot omit this tag.
- Value omission
- You cannot omit the value of this tag.
(35) <ejb-transaction-timeout>
- Description
- This tag is specified when you set up a transaction timeout value for the EJB (CMT) method.
- When multiple <ejb-transaction-timeout> tags are specified and the values set under the <method> 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 <transaction-timeout> tag of the <ejb-transaction-timeout> tag defined first is enabled.
- 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.
(36) <method>
- Description
- This tag defines the method.
- 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.
(37) <method-intf>
- Description
- This tag is specified when identifying the interface type to which the method belongs.
- You cannot specify a value for this tag in the Message-driven Bean property settings.
- Specifiable value
- None.
- Dependency on other tags
- None.
- Tag omission
- You can omit this tag.
- Value omission
- You can omit the value of this tag.
(38) <method-name>
- Description
- This tag specifies the target method name.
- An asterisk (*) indicates that all the methods are targets.
- Specifiable value
- There are no limitations for the input value.
- Dependency on other tags
- This tag depends on the <method-params> tag.
- Tag omission
- You cannot omit this tag.
- Value omission
- You cannot omit the value of this tag.
(39) <method-params>
- Description
- This tag is specified to identify a method when multiple methods are defined.
- Specifiable value
- None.
- Dependency on other tags
- None.
- Tag omission
- You can omit this tag.
- Value omission
- You can omit the value of this tag.
(40) <method-param>
- Description
- This tag specifies the data type of the argument.
- 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.
(41) <transaction-timeout>
- Description
- This tag specifies the transaction timeout value (seconds).
- When you specify 0, the operation is performed using the default timeout value set in the J2EE server.
- 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.