2.2.3 Details of the Session Bean property

This subsection describes the details of the Session Bean property of cosminexus.xml with reference to each tag.

Note that the tag details are described in the order mentioned in 2.1 Specifications of the Cosminexus application property file (cosminexus.xml).

Organization of this subsection
(1) <session>
(2) <ejb-name>
(3) <security-identity>
(4) <run-as>
(5) <user-name>
(6) <resource-ref>
(7) <res-ref-name>
(8) <linked-to>
(9) <resource-env-ref>
(10) <resource-env-ref-name>
(11) <linked-queue>
(12) <resource-adapter>
(13) <queue>
(14) <linked-adminobject>
(15) <resourceadapter-name>
(16) <adminobject-name>
(17) <linked-to>
(18) <lookup-name>
(19) <optional-name>
(20) <local-optional-name>
(21) <maximum-sessions>
(22) <stateless>
(23) <pooled-instance>
(24) <minimum>
(25) <maximum>
(26) <instance-timeout>
(27) <stateful>
(28) <maximum-active-sessions>
(29) <inactivity-timeout>
(30) <removal-timeout>
(31) <enable-scheduling>
(32) <pass-by-reference>
(33) <scheduling>
(34) <queue-name>
(35) <parallel-count>
(36) <queue-length>
(37) <front-ejb>
(38) <start-order>
(39) <ejb-method-observation-timeout>
(40) <method>
(41) <method-intf>
(42) <method-name>
(43) <method-params>
(44) <method-param>
(45) <method-observation-timeout>
(46) <ejb-transaction-timeout>
(47) <method>
(48) <method-intf>
(49) <method-name>
(50) <method-params>
(51) <method-param>
(52) <transaction-timeout>

(1) <session>

Description
This tag defines the Session 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
This tag specifies the name of the ejb.
Note that this key is used for identifying the Session Bean.
Specifies the value set for <ejb-jar>-<enterprise-beans>-<session>-<ejb-name> in the ejb-jar.xml.
For an application that does not include ejb-jar.xml, the value set for name in @Stateless, @Stateful, or @Singleton is specified.
If name is not specified, the class name obtained by removing the package name of the EJB implementation class name is specified.
Specifiable value
None.
Dependency on other tags
None.
Tag omission
You cannot omit the value of this tag.
Value omission
You cannot omit the value of this tag.

(3) <security-identity>

Description
This tag defines the security identity of the Session 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 the value of this tag.
Value omission
You cannot omit the value of this tag.

(5) <user-name>

Description
This tag specifies the user name.
Specifiable value
None.
Dependency on other tags
None.
Tag omission
You cannot omit the value of this tag.
Value omission
You cannot omit the value of this tag.

(6) <resource-ref>

Description
This tag defines the resource to be referenced from the Session 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.

(7) <res-ref-name>

Description
This tag specifies the name of the resource reference.
Specifiable value
None.
Dependency on other tags
None.
Tag omission
You cannot omit the value of this tag.
Value omission
You cannot omit the value of this tag.

(8) <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 cannot omit the value of this tag.
Value omission
You can omit this tag.

(9) <resource-env-ref>

Description
This tag defines the resource environment variable to be referenced from the Session 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.

(10) <resource-env-ref-name>

Description
This tag specifies the name of the resource environment variable reference.
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.

(11) <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 cannot omit this tag.
Value omission
You can omit the value of this tag.

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

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

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

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

(16) <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 ([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 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.

(17) <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 <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 can omit the value of this tag.

(18) <lookup-name>

Description
This tag specifies the name used when looking up the EJB from the client. This tag corresponds to EJB-lookup-name in HITACHI_EJB/SERVERS/server-name/EJB/application-lookup-name/EJB-lookup-name.
If this tag is omitted, the resource name is used as the default value; however, all the characters other than alphanumeric characters and underscores (_) included in the default value are converted into underscores.
Specifiable value
You can specify alphanumeric characters (0 to 9, A to Z, and a to z) and the following special characters:
Space ( ), double quotation 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 ([Figure]), caret (^), underscore (_), grave accent mark (`), curly brackets ({) (}), vertical bar (|), and tilde (~).
You cannot, however, specify the following names:
  • A name containing a period (.) at the beginning or at the end
  • A name containing a period (.) only
If there is a single byte space or a linefeed in the beginning or at the end of a character string, such a single byte space or a linefeed is removed, and then the name is input. Also, if there is a linefeed in between a character string, an error occurs.
You can specify 1 to 255 characters.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(19) <optional-name>

Description
This tag specifies the optional name of the remote interface.
Specifiable value
You can specify 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 (~).
However, the following names cannot be specified:
  • A name that starts with the keyword HITACHI_EJB (case sensitive)
  • A name that includes a slash (/) or a period in the beginning or at the end
  • A name that includes a continuous slash (/)
If there is a single byte space or a linefeed in the beginning or at the end of a character string, such a single byte space or a linefeed is removed, and then the name is input. Also, if there is a linefeed in between a character string, an error occurs.
You can specify 1 to 255 characters.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(20) <local-optional-name>

Description
This tag specifies the optional name of the local interface.
Specifiable value
There are no limitations for the specifiable characters.
You can specify 1 to 255 characters.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(21) <maximum-sessions>

Description
This tag specifies the maximum number of sessions or Bean instances.
For a Stateless Session Bean or Singleton Session Bean, this set value is disabled.
Specifiable value
Specify an integer value of 0 (infinite) or 1[Figure] maximum-sessions[Figure] 2147483647.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(22) <stateless>

Description
This tag is specified when the Session Bean type is Stateless.
Either <stateless> or <stateful>, or neither of these is specified.
Specifiable value
None.
Dependency on other tags
This tag depends on the <session-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
This 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.
Specifiable value
Specify an integer value of 0 or 1[Figure] minimum[Figure] maximum.
Dependency on other tags
This tag depends on the <maximum> tag.
Tag omission
You can omit this tag.
Value omission
You cannot 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 of 0 (infinite) or 1[Figure] maximum[Figure] 2147483647.
Furthermore, when the value of the <enable-scheduling> tag is true and the value of the <managed-by-ctm> tag of the application property is true, the specifiable range will differ.
  • When the specified value of the <scheduling-unit> tag of the application property is Bean
    Specify an integer value of 0, or equal to or more than <scheduling>-<parallel-count>.
  • When the specified value of the <scheduling-unit> tag of the application property is Application
    Specify an integer value of 0, or equal to or more than the <scheduling>-<parallel-count> tag of the application property.
Dependency on other tags
This tag depends on the <enable-scheduling> tag, <managed-by-ctm> tag of the application property, <scheduling-unit> tag of the application property, <scheduling>-<parallel-count> tag, and the <scheduling>-<parallel-count> tag of the application property.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(26) <instance-timeout>

Description
This tag specifies the instance acquisition timeout value (seconds).
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 can omit this tag.
Value omission
You cannot omit the value of this tag.

(27) <stateful>

Description
This tag is specified when the Session Bean type is Stateful.
Either <stateless> or <stateful> is specified or neither of these is specified.
Specifiable value
None.
Dependency on other tags
This tag depends on the <session-type> tag of the DD.
Tag omission
You can omit this tag.
Value omission
You can omit the value of this tag.

(28) <maximum-active-sessions>

Description
This tag specifies the maximum number of active sessions.
Specifiable value
When maximum-sessions is 0 (infinite)
Specify an integer value of 0 (infinite) [Figure]maximum-active-sessions[Figure] 2147483647.
When maximum-sessions is not 0 (infinite)
Specify an integer value of 1[Figure] maximum-active-sessions[Figure] maximum-sessions.
Dependency on other tags
This tag depends on the <maximum-sessions> tag of the DD.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(29) <inactivity-timeout>

Description
This tag specifies the time period (minutes) for which the inactive status is retained until the session is activated again.
Specifiable value
Specify an integer value of 0 (infinite) or 1[Figure] inactivity-timeout[Figure] 2147483647.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(30) <removal-timeout>

Description
This tag specifies the time period (minutes) for which the inactive status is retained until the session is removed.
Specifiable value
Specify an integer value of 0 (infinite) or 1[Figure]removal-timeout[Figure] 2147483647.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(31) <enable-scheduling>

Description
This tag specifies whether to use the corresponding Bean as the scheduler Gate.
Specifiable value
  • true
    The corresponding Bean will be used as the scheduler Gate.
  • false
    The corresponding Bean will not be used as the scheduler Gate.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(32) <pass-by-reference>

Description
This tag specifies whether to invoke the EJB with pass-by-reference.
Specifiable value
  • true
    The EJB will be invoked with pass-by-reference.
  • false
    The EJB will not be invoked with pass-by-reference.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(33) <scheduling>

Description
This tag sets up the information related to CTM integration.
Specifiable value
None.
Dependency on other tags
This tag depends on the <session-type> tag, <scheduling-unit> tag, and the <enable-scheduling> tag of the DD.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(34) <queue-name>

Description
This tag specifies the queue name for which scheduling is to be executed.
Specifiable value
You can use alphanumeric characters and underscores (_).
You can specify 1 to 63 characters.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(35) <parallel-count>

Description
This tag specifies the number of threads prepared by the CTM scheduler to invoke an application.
Specifiable value
Specify an integer value from 1 to 127.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(36) <queue-length>

Description
This tag specifies the length of a queue.
Specifiable value
Specify an integer value from 1 to 32767.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

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

(38) <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 an 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.

(39) <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 (excluding the <description> tag) 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 <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.

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

(41) <method-intf>

Description
This tag is specified when identifying the interface type to which the method belongs.
Specifiable value
  • Home
  • Remote
  • LocalHome
  • Local
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(42) <method-name>

Description
This tag specifies the target method name.
An asterisk (*) indicates that all the methods are targets.
Specifiable value
None.
Dependency on other tags
This tag depends on the <method-params> tag of the DD.
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

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

(44) <method-param>

Description
This tag specifies the data type of the argument.
Specifiable value
Specify a value other than a white space delimiter, row delimiter, and paragraph delimiter.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

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

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

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

(48) <method-intf>

Description
This tag is specified when identifying the interface type to which the method belongs.
Specifiable value
  • Home
  • Remote
  • LocalHome
  • Local
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(49) <method-name>

Description
This tag specifies the target method name.
An asterisk (*) indicates that all the methods are targets.
Specifiable value
None.
Dependency on other tags
This tag depends on the <method-params> tag of DD.
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

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

(51) <method-param>

Description
This tag specifies the data type of the argument.
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.

(52) <transaction-timeout>

Description
This tag specifies the transaction timeout value (seconds).
When you specify 0, the operation is executed 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.