3.6.1 Specifications of the HITACHI MessageDrivenBean Property file

<hitachi-message-bean-property>

Once

Specifies the root tag.

<description>^#1

Zero or more times^#2

Describes the Message-driven Bean.

<display-name>^#1

One or more times^#2

Specifies the Message-driven Bean display name.

Make sure you specify display-name with xml:lang property as en. Even if the display name of the corresponding resource is specified using the command argument, specify display-name with xml:lang as en.

1 ≤ character-string-length

There is no restriction on the characters to be used.

Any single-byte space or linefeed at the beginning or end of the character string is removed and the character string is set up without an error.

<icon>^#1

Zero or more times^#2

Defines the Entity Bean icons displayed on the GUI tool.

<small-icon>

Zero or once

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

<large-icon>

Zero or once

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

<messaging-type>

Zero or once

Specifies the message listener interface of the Message-driven Bean.

If you do not describe the message listener interface of the Message-driven Bean, javax.jms.MessageListener is assumed.

You can specify this tag for Enterprise Beans of EJB 2.1 or later versions.

<transaction-type>

Once

Specifies the transaction management method.

You can specify either Container or Bean.

<activation-config>

Zero or once

Specifies the operating environment of Message-driven Bean.

You can specify the tags under this tag for Enterprise Beans of EJB 2.1 or later versions.

<description>^#1

Zero or more times

Describes the operating environment of the Message-driven Bean.

<activation-config-property>

One or more times

Specifies the property related to the operating environment of the Message-driven Bean.

<activation-config-property-name>

Once

Specifies the property name related to the operating environment of the Message-driven Bean.

<activation-config-property-value>

Once

Specifies the property value related to the operating environment of the Message-driven Bean.

<message-selector>

Zero or once

Specifies the JMS message selector for determining the messages received by the Message-driven bean.

You can specify this tag for an Enterprise Bean earlier than EJB2.0.

You can specify this tag for Enterprise Beans of EJB 2.0 or earlier versions.

<acknowledge-mode>

Zero or once

Specifies the notification semantics used in the onMessage message of the BMT Message-driven bean.

Specify either Auto-acknowledge or Dups-ok-acknowledge. The default value is Auto-acknowledge.

You can specify this tag for Enterprise Beans of EJB 2.0 or earlier versions.

<message-driven-destination>

Zero or once

Defines the JMS destination.

You can specify the tags under this tag for Enterprise Beans of EJB 2.0 or earlier versions.

<destination-type>

Once

Specifies the JMS destination type.

Specify either javax.jms.Queue or javax.jms.Topic.

<subscription-durability>

Zero or once

Specifies the subscription when JMS destination is javax.jms.Topic.

Specify either Durable or NonDurable. The default value is NonDurable.

<env-entry>

Zero or more times

Defines the environment variables invoked from Message-driven Bean.

<description>^#1

Zero or more times^#2

Describes the environment variable.

<env-entry-name>

Once

Specifies the environment variable name.

<env-entry-type>

Once

Specifies the Java type of the environment variable value.

You can specify the following values:

• java.lang.Boolean

• java.lang.String

• java.lang.Character

• java.lang.Integer

• java.lang.Double

• java.lang.Byte

• java.lang.Short

• java.lang.Long

• java.lang.Float

<env-entry-value>

Once

Specifies the environment variable value.

<ejb-ref>

Zero or more times

Defines the information for referencing the Enterprise Bean with a remote interface from the Message-driven Bean.

<description>^#1

Zero or more times^#2

Describes the Enterprise Bean reference.

<ejb-ref-name>

Once

Specifies the Enterprise Bean name to be linked to.

<ejb-ref-type>

Once

Specifies the Enterprise Bean type to be linked to.

You can specify the following values:

• Session

• Entity

<home>

Once

Specifies the Remote Home interface name of the Enterprise Bean to be linked to.

<remote>

Once

Specifies the Remote Component interface name of the Enterprise Bean to be linked to.

<ejb-link>

Zero or once

Specifies the Enterprise Bean name to be linked to.

When setting the link destination with the naming service switching functionality, use the following format:

corbaname::Namespace-host-name: Namespace-port-number#JNDI-name-of-EJB-Home-object-reference

<ejb-local-ref>

Zero or more times

Defines the information for referencing the Enterprise Bean with a local interface from the Message-driven Bean.

<description>^#1

Zero or more times^#2

Describes the ejb-local-ref.

<ejb-ref-name>

Once

Specifies the Enterprise Bean name to be linked to.

<ejb-ref-type>

Once

Specifies the Enterprise Bean type to be linked to.

You can specify the following values:

• Session

• Entity

<local-home>

Once

Specifies the Local Home interface name of the Enterprise Bean to be linked to.

<local>

Once

Specifies the Local Component interface name of the Enterprise Bean to be linked to.

<ejb-link>

Zero or once

Specifies the name of Enterprise Bean to be linked to.

<message-ref>

Zero or once

When you specify a Connector 1.0 resource adapter, the combination of <resource-adapter> and <queue> must be unique between multiple applications.

<connection-factory>

Zero or once

Specifies the resource adapter display name.

You cannot specify a resource adapter conforming to Connector 1.5 or later versions.

<connection-destination>

Once

This tag is ignored in the cjsetresprop command.

<resource-adapter>

Once

Specifies the resource adapter display name.

<queue>

Zero or once

Specifies the display name of the queue.

You cannot specify a resource adapter conforming to Connector 1.5 or later versions.

<security-identity>

Zero or once

Defines the security identity.

<description>^#1

Zero or more times^#2

Describes security-identity.

<run-as>

Once

Defines the runtime identity.

<description>^#1

Zero or more times^#2

Describes run-as.

<role-name>

Once

Specifies the security role name.

<user-name>

Once

Specifies the principal name.

<resource-ref>

Zero or more times

Defines the resources referenced from Message-Driven Bean.

<description>^#1

Zero or more times^#2

Describes resource-ref.

<res-ref-name>

Once

Specifies the resource reference name.

<res-type>

Once

Specifies the resource type.

You can specify the following character strings:

• javax.mail.Session

• javax.sql.DataSource

• javax.jms.QueueConnectionFactory

• javax.jms.ConnectionFactory

• javax.resource.cci.ConnectionFactory

• org.omg.CORBA_2_3.ORB (a resource that can be looked up even if not defined in a DD)

• javax.jms.TopicConnectionFactory

If the reference destination is a Connector 1.5 resource adapter, specify the connection definition identifier (value specified for the <connectionfactory-interface> tag) of the reference destination resource adapter.

<res-auth>

Once

Specifies the method of registering to the resource manager.

The value that you can specify is either Container or Application.

<res-sharing-scope>

Zero or once

Specifies whether to share the connection acquired from the resource manager factory reference.

The value that you can set is either Shareable or Unshareable. The default value is Shareable.

<mapped-name>

Zero or once

Specifies the corresponding resource adapter display name or mail display name.^#3

When you specify this tag at the same time as the <linked-to> tag, the <linked-to> tag becomes valid.

<linked-to>

Zero or once

Specifies the corresponding resource adapter display name, data source display name, or mail display name.

How to specify the resource adapter display name differs depending on the resource adapter version.

Connector 1.0 or earlier versions

Resource-adapter-display-name

Outbound resource adapters of Connector 1.5 or later versions

Resource-adapter-display-name!connection-definition-identifier

The connection-definition-identifier is a value specified in the <connectionfactory-interface> tag in the ra.xml.

The member resource adapter for the connection pool clustering functionality (compatibility functionality) cannot be specified.

This tag is ignored in the cjsetresprop command.

<resource-env-ref>

Zero or more times

Defines the resource environment variables referenced from Message-driven Bean.

<description>^#1

Zero or more times^#2

Describes resource-env-ref.

<resource-env-ref-name>

Once

Specifies the name of the resource environment variable reference.

<resource-env-ref-type>

Once

Specifies the type of resource environment variable reference.

Specify the following Java class or interface name:

• javax.jms.Queue

• javax.jms.Topic

• JavaBeans resource class name

When you specify <linked-adminobject>, any class name is displayed.

<mapped-name>

Zero or once

When <resource-env-ref-type> is javax.jms.Queue, the corresponding queue ^#3 is displayed in the following format:

Resource-adapter-display-name#Queue-name

When you specify this tag at the same time as <linked-Queue> tag, the <linked-Queue> tag becomes valid.

When <resource-env-ref-type> is JavaBeans-resource-class-name, the display name of the corresponding JavaBeans resource is displayed. When you specify this tag at the same time as the <linked-to> tag, the <linked-to> tag becomes valid.

<linked-queue>

Zero or once

Specifies the queue name.

This tag is ignored in the cjsetresprop command.

This tag is valid only when <resource-env-ref-type> is javax.jms.Queue.

<resource-adapter>

Once

Specifies the resource adapter display name.

You cannot specify the resource adapters conforming to Connector1.5 specifications.

<queue>

Once

Specifies the display name of the queue.

<linked-adminobject>

3.16 in the Common Container Functionality Guide

Zero or once

Specifies the administered object. This tag is ignored in the cjsetresprop command.

<resourceadapter-name>

Once

Specifies the resource adapter display name.

You cannot specify the resource adapters conforming to Connector1.0 or earlier versions.

<adminobject-name>

Once

Specifies the administered object name.

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 only a period (.)

• Name containing continuous underscores (_)

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

<linked-to>

Zero or once

Specifies the JavaBeans resource display name.

This tag is valid only when <resource-env-ref-type> is JavaBeans-resource-class-name.

This tag is ignored in the cjsetresprop command.

<container-transaction>

Zero or more times

Defines the container transaction.

<description>^#1

Zero or more times^#2

Describes container-transaction.

<method>

One or more times

Defines the method.

<description>^#1

Zero or more times^#2

Describes the method.

<method-intf>

Zero or once

Specifies the type of interface to which the method belongs.

You cannot specify a value for this tag. However, you can specify Bean for EJBs where the setup destination is EJB 2.0 or an earlier version.

<method-name>

Once

Specifies the method name.

When you specify "*", all methods are displayed. ^#4

<method-params>

Zero or once

This tag is valid when method-name is not "*".

When method-params is specified

Specifies the method-name method existing in the interface specified in method-intf and containing the parameters specified in method-params.

When method-params is not specified

Specifies all the method-name methods existing in the interface specified in method-intf.

<method-param>

Zero or more times

Specifies the parameter data type.

Specify the primitive type or class name.

For an array, specify square brackets ([]) after the name (ensure that there is no space between "name" and "[", and "[" and "]").

For a multidimensional array, specify square brackets ([]) one after the other (there must be no space between "]" and "[" ).

You cannot specify the internal format name of the array ([I for int[], and [Ljava.lang.String; for java.lang.String[]).

For example:

• int

• short[][]

• java.lang.String[]

<trans-attribute>

Once

Specifies the transaction attribute allocated to method.

You can specify the following character strings:

• Mandatory

• Never

• NotSupported

• Required

• RequiresNew

• Supports

<runtime>

Zero or once

When this tag is used in the cjsetappprop command

This tag is mandatory.

When this tag is used in the cjsetresprop command

This tag is ignored.

<pooled-instance>

Once

Defines the instances in the pool.

<minimum>

2.9.3 in the Application Server EJB Container Functionality Guide

Once

Specifies the minimum number of instances in the pool. ^#3

1 is displayed.

<maximum>

2.9.3 in the Application Server EJB Container Functionality Guide

Once

Specifies the maximum number of instances in the pool.

1 ≤ maximum ≤ 2147483647.

If you specify 0, 1 is set up.

<front-ejb>

Zero or once

Specifies whether the specified EJB is a front EJB (an EJB invoked directly by the client). Specify true if the EJB is a front EJB and false if it is not. The default value is false.

<start-order>

Zero or once

Specifies the order of starting or stopping the J2EE applications. The start process is executed in the ascending order when the applications are started and the stop process is executed in the descending order when the applications are terminated.

0 ≤ start-order ≤ 2147483647

<ejb-method-observation-timeout>

Chapter 5 in the Operation, Monitoring, and Linkage Guide

Zero or more times

This tag is specified when you set up a timeout value for monitoring the in-process methods, in an EJB method.

When multiple <ejb-method-observation-timeout> tags are specified and the values set under the <method> tags (excluding the <description> tag) are the same, the tags are merged into one. In this case, a warning message (KDJE37601-W) is output, and the value of <method-observation-timeout> of the <ejb-method-observation-timeout> tag defined first is enabled.

<method>

One or more times

--

<description>

Zero or once

Describes the method. You cannot specify this tag multiple times.

<method-intf>

Zero or once

Specifies the type of interface to which the method belongs.

You cannot specify a value for this tag. However, you can specify Bean for EJBs where the setup destination is EJB 2.0 or an earlier version.

<method-name>

Once

Specifies the target method name. When you specify "*", all the methods are displayed. ^#4

<method-params>

Zero or once

Specified for identifying the method when multiple methods are defined.

<method-param>

Zero or more times

Specifies the argument data type.

<method-observation-timeout>

Once

Specifies a value from 0 to 86400 (unit: seconds) as the timeout value (seconds) used for monitoring the in-process methods. When you specify 0, a timeout does not occur. The default value is 0.

<ejb-transaction-timeout>

3.15.8 in the Common Container Functionality Guide

Zero or more times

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 (excluding the <description> tag) are the same, the tags are merged into one. In this case, a warning message (KDJE37601-W) is output, and the value of <transaction-timeout> of the <ejb-transaction-timeout> tag defined first is enabled.

<method>

One or more times

--

<description>

Zero or once

Describes the method. You cannot specify this tag multiple times.

<method-intf>

Zero or once

Specified for identifying the types of interface to which the method belongs. You cannot specify a value for this tag. However, you can specify Bean for EJBs where the setup destination is EJB 2.0 or an earlier version.

<method-name>

Once

Specifies the target method name. When you specify "*", all the methods are displayed. ^#4

<method-params>

Zero or once

Specified for identifying the method when multiple methods are defined.

<method-param>

Zero or more times

Specifies the argument data type.

<transaction-timeout>

Once

Specifies the transaction timeout period from 0 to 2147483647 (unit: seconds). If you specify 0, a timeout will not occur. The default value is 0.

--

--

--