3.6.1 Specifications of the HITACHI MessageDrivenBean Property file

The HITACHI MessageDrivenBean Property file has the following DOCTYPE declaration:

<!DOCTYPE hitachi-message-bean-property PUBLIC '-//Hitachi, Ltd.//DTD Message Bean Property 7.6//EN' 'file:///Cosminexus-installation-directory/CC/admin/dtds/hitachi-message-bean-property_7_6.dtd'>

The HITACHI MessageDrivenBean Property file is an xml file containing the following tags. Note that you can also use earlier versions of the property file.

The related information of a tag is described in the reference manuals mentioned in the Tag name column. uCosminexus Application Server is omitted from the manual names.

Tag nameOccurrence patternExplanation
<hitachi-message-bean-property>OnceSpecifies the root tag.

<description>#1Zero or more times#2Describes the Message-driven Bean.

<display-name>#1One or more times#2Specifies 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[Figure] 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>#1Zero or more times#2Defines the Entity Bean icons displayed on the GUI tool.

<small-icon>Zero or onceSpecifies the file name for small icons (16[Figure] 16).

<large-icon>Zero or onceSpecifies the file name for large icons (32[Figure] 32).

<messaging-type>Zero or onceSpecifies 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>OnceSpecifies the transaction management method.
You can specify either Container or Bean.

<activation-config>Zero or onceSpecifies 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>#1Zero or more timesDescribes the operating environment of the Message-driven Bean.

<activation-config-property>One or more timesSpecifies the property related to the operating environment of the Message-driven Bean.

<activation-config-property-name>OnceSpecifies the property name related to the operating environment of the Message-driven Bean.

<activation-config-property-value>OnceSpecifies the property value related to the operating environment of the Message-driven Bean.

<message-selector>Zero or onceSpecifies 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 onceSpecifies 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 onceDefines the JMS destination.
You can specify the tags under this tag for Enterprise Beans of EJB 2.0 or earlier versions.

<destination-type>OnceSpecifies the JMS destination type.
Specify either javax.jms.Queue or javax.jms.Topic.

<subscription-durability>Zero or onceSpecifies the subscription when JMS destination is javax.jms.Topic.
Specify either Durable or NonDurable. The default value is NonDurable.

<env-entry>Zero or more timesDefines the environment variables invoked from Message-driven Bean.

<description>#1Zero or more times#2Describes the environment variable.

<env-entry-name>OnceSpecifies the environment variable name.

<env-entry-type>OnceSpecifies 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>OnceSpecifies the environment variable value.

<ejb-ref>Zero or more timesDefines the information for referencing the Enterprise Bean with a remote interface from the Message-driven Bean.

<description>#1Zero or more times#2Describes the Enterprise Bean reference.

<ejb-ref-name>OnceSpecifies the Enterprise Bean name to be linked to.

<ejb-ref-type>OnceSpecifies the Enterprise Bean type to be linked to.
You can specify the following values:
  • Session
  • Entity

<home>OnceSpecifies the Remote Home interface name of the Enterprise Bean to be linked to.

<remote>OnceSpecifies the Remote Component interface name of the Enterprise Bean to be linked to.

<ejb-link>Zero or onceSpecifies 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 timesDefines the information for referencing the Enterprise Bean with a local interface from the Message-driven Bean.

<description>#1Zero or more times#2Describes the ejb-local-ref.

<ejb-ref-name>OnceSpecifies the Enterprise Bean name to be linked to.

<ejb-ref-type>OnceSpecifies the Enterprise Bean type to be linked to.
You can specify the following values:
  • Session
  • Entity

<local-home>OnceSpecifies the Local Home interface name of the Enterprise Bean to be linked to.

<local>OnceSpecifies the Local Component interface name of the Enterprise Bean to be linked to.

<ejb-link>Zero or onceSpecifies the name of Enterprise Bean to be linked to.

<message-ref>Zero or onceWhen 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 onceSpecifies the resource adapter display name.
You cannot specify a resource adapter conforming to Connector 1.5 or later versions.

<connection-destination>OnceThis tag is ignored in the cjsetresprop command.

<resource-adapter>OnceSpecifies the resource adapter display name.

<queue>Zero or onceSpecifies the display name of the queue.
You cannot specify a resource adapter conforming to Connector 1.5 or later versions.

<security-identity>Zero or onceDefines the security identity.

<description>#1Zero or more times#2Describes security-identity.

<run-as>OnceDefines the runtime identity.

<description>#1Zero or more times#2Describes run-as.

<role-name>OnceSpecifies the security role name.

<user-name>OnceSpecifies the principal name.

<resource-ref>Zero or more timesDefines the resources referenced from Message-Driven Bean.

<description>#1Zero or more times#2Describes resource-ref.

<res-ref-name>OnceSpecifies the resource reference name.

<res-type>OnceSpecifies 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>OnceSpecifies the method of registering to the resource manager.
The value that you can specify is either Container or Application.

<res-sharing-scope>Zero or onceSpecifies 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 onceSpecifies 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 onceSpecifies 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.
You cannot specify the member resource adapters of the cluster connection pool.
This tag is ignored in the cjsetresprop command.

<resource-env-ref>Zero or more timesDefines the resource environment variables referenced from Message-driven Bean.

<description>#1Zero or more times#2Describes resource-env-ref.

<resource-env-ref-name>OnceSpecifies the name of the resource environment variable reference.

<resource-env-ref-type>OnceSpecifies 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 onceWhen <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 onceSpecifies 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>OnceSpecifies the resource adapter display name.
You cannot specify the resource adapters conforming to Connector1.5 specifications.

<queue>OnceSpecifies the display name of the queue.

<linked-adminobject>

3.16 in the Common Container Functionality Guide
Zero or onceSpecifies the administered object. This tag is ignored in the cjsetresprop command.

<resourceadapter-name>OnceSpecifies the resource adapter display name.
You cannot specify the resource adapters conforming to Connector1.0 or earlier versions.

<adminobject-name>OnceSpecifies 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 (:), semi-colon (;), 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 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 onceSpecifies 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 timesDefines the container transaction.

<description>#1Zero or more times#2Describes container-transaction.

<method>One or more timesDefines the method.

<description>#1Zero or more times#2Describes the method.

<method-intf>Zero or onceSpecifies 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>OnceSpecifies the method name.
When you specify "*", all methods are displayed. #4

<method-params>Zero or onceThis 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 timesSpecifies 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>OnceSpecifies 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>OnceDefines the instances in the pool.

<minimum>OnceSpecifies the minimum number of instances in the pool. #3
1 is displayed.

<maximum>OnceSpecifies the maximum number of instances in the pool.
1[Figure] maximum[Figure] 2147483647​.
If you specify 0, 1 is set up.

<front-ejb>Zero or onceSpecifies 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 onceSpecifies 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[Figure] start-order[Figure] 2147483647​

<ejb-method-observation-timeout>

Chapter 5 in the Operation, Monitoring, and Linkage Guide
Zero or more timesThis 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 onceDescribes the method. You cannot specify this tag multiple times.

<method-intf>Zero or onceSpecifies 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>OnceSpecifies the target method name. When you specify "*", all the methods are displayed. #4

<method-params>Zero or onceSpecified for identifying the method when multiple methods are defined.

<method-param>Zero or more timesSpecifies the argument data type.

<method-observation-timeout>OnceSpecifies 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 timesThis 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 onceDescribes the method. You cannot specify this tag multiple times.

<method-intf>Zero or onceSpecified 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>OnceSpecifies the target method name. When you specify "*", all the methods are displayed. #4

<method-params>Zero or onceSpecified for identifying the method when multiple methods are defined.

<method-param>Zero or more timesSpecifies the argument data type.

<transaction-timeout>OnceSpecifies the transaction timeout period from 0 to 2147483647​ (unit: seconds). If you specify 0, a timeout will not occur. The default value is 0.
#1
You can specify the xml:lang property. If the xml:lang property is not specified, en(English) is assumed. Note that you cannot specify multiple tags with the same xml:lang property.
#2
You cannot specify this tag multiple times for EJB 2.0 or earlier versions.
#3
Do not change the tag name, add or delete the tag, or change the value for the tags output with the cjgetresprop commands.
#4
If false is specified in the ejbserver.cui.checkmethod.compatible key in the usrconf.properties file for server management commands and the method specified with this tag does not exist, an error occurs when you set up the property. For details on the ejbserver.cui.checkmethod.compatible key of the usrconf.properties file, see 5.4 usrconf.properties (System property file for server management commands) in the manual uCosminexus Application Server Definition Reference Guide.