2.2.3 Details of the Session Bean property

This tag defines the Session Bean.

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

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.

None.

None.

You cannot omit the value of this tag.

You cannot omit the value of this tag.

This tag defines the security identity of the Session Bean.

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag defines the runtime identity.

None.

None.

You cannot omit the value of this tag.

You cannot omit the value of this tag.

This tag specifies the user name.

None.

None.

You cannot omit the value of this tag.

You cannot omit the value of this tag.

This tag defines the resource to be referenced from the Session Bean.

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the name of the resource reference.

None.

None.

You cannot omit the value of this tag.

You cannot omit the value of this tag.

This tag specifies the corresponding resource adapter display name and the mail display name.

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

• 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

There are no limitations for the input value.

None.

You cannot omit the value of this tag.

You can omit this tag.

This tag defines the resource environment variable to be referenced from the Session Bean.

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the name of the resource environment variable reference.

None.

None.

You cannot omit this tag.

You cannot omit the value of this tag.

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.

None.

This tag depends on the <resource-env-ref-type> tag of the DD.

You cannot omit this tag.

You can omit the value of this tag.

This tag specifies the display name of the resource adapter.

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

There are no limitations for the input value.

None.

You cannot omit this tag.

You cannot omit the value of this tag.

This tag specifies the queue name.

There are no limitations for the input value.

None.

You cannot omit this tag.

You cannot omit the value of this tag.

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.

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the display name of the resource adapter.

You cannot specify a resource adapter conforming to Connector 1.0 or earlier versions.

There are no limitations for the input value.

None.

You cannot omit this tag.

You cannot omit the value of this tag.

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

• Name containing continuous underscores (_)

None.

You cannot omit this tag.

You cannot omit the value of this tag.

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.

None.

This tag depends on the <resource-env-ref-type> tag of the DD.

You can omit this tag.

You can omit the value of this tag.

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.

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

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the optional name of the remote interface.

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 (), 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 forward slash (/) or a period in the beginning or at the end

• A name that includes continuous forward slashes (/)

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.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the optional name of the local interface.

There are no limitations for the specifiable characters.

You can specify 1 to 255 characters.

None.

You can omit this tag.

You cannot omit the value of this tag.

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.

Specify an integer value of 0 (infinite) or 1 ≤ maximum-sessions ≤ 2147483647.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag is specified when the Session Bean type is Stateless.

Either <stateless> or <stateful>, or neither of these is specified.

None.

This tag depends on the <session-type> tag of the DD.

You can omit this tag.

You can omit the value of this tag.

This tag defines the instances within a pool.

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the minimum number of instances within a pool.

Specify an integer value of 0 or 1 ≤ minimum ≤ maximum.

This tag depends on the <maximum> tag.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the maximum number of instances within a pool.

Specify an integer value of 0 (infinite) or 1 ≤ maximum ≤ 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.

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.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the instance acquisition timeout value (seconds).

When you specify 0, a timeout does not occur.

Specify an integer value from 0 to 86400.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag is specified when the Session Bean type is Stateful.

Either <stateless> or <stateful> is specified or neither of these is specified.

None.

This tag depends on the <session-type> tag of the DD.

You can omit this tag.

You can omit the value of this tag.

This tag specifies the maximum number of active sessions.

When maximum-sessions is 0 (infinite)

Specify an integer value of 0 (infinite) ≤maximum-active-sessions ≤ 2147483647.

When maximum-sessions is not 0 (infinite)

Specify an integer value of 1 ≤ maximum-active-sessions ≤ maximum-sessions.

This tag depends on the <maximum-sessions> tag of the DD.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the time period (minutes) for which the inactive status is retained until the session is activated again.

Specify an integer value of 0 (infinite) or 1 ≤ inactivity-timeout ≤ 2147483647.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the time period (minutes) for which the inactive status is retained until the session is removed.

Specify an integer value of 0 (infinite) or 1 ≤removal-timeout ≤ 2147483647.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies whether to use the corresponding Bean as the scheduler Gate.

• true

  The corresponding Bean will be used as the scheduler Gate.

• false

  The corresponding Bean will not be used as the scheduler Gate.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies whether to invoke the EJB with pass-by-reference.

• true

  The EJB will be invoked with pass-by-reference.

• false

  The EJB will not be invoked with pass-by-reference.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag sets up the information related to CTM integration.

None.

This tag depends on the <session-type> tag, <scheduling-unit> tag, and the <enable-scheduling> tag of the DD.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the queue name for which scheduling is to be executed.

You can use alphanumeric characters and underscores (_).

You can specify 1 to 63 characters.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the number of threads prepared by the CTM scheduler to invoke an application.

Specify an integer value from 1 to 127.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the length of a queue.

Specify an integer value from 1 to 32767.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies whether the specified EJB is a front EJB (an EJB invoked directly by the client).

• true

  The EJB is a front EJB.

• false

  The EJB is not a front EJB.

None.

You can omit this tag.

You cannot omit the value of this tag.

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.

Specify an integer value from 0 to 2147483647.

None.

You can omit this tag.

You cannot omit the value of this tag.

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.

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag defines the method.

None.

None.

You cannot omit this tag.

You cannot omit the value of this tag.

This tag is specified when identifying the interface type to which the method belongs.

• Home

• Remote

• LocalHome

• Local

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the target method name.

An asterisk (*) indicates that all the methods are targets.

None.

This tag depends on the <method-params> tag of the DD.

You cannot omit this tag.

You cannot omit the value of this tag.

This tag is specified to identify a method when multiple methods are defined.

None.

None.

You can omit this tag.

You can omit the value of this tag.

This tag specifies the data type of the argument.

Specify a value other than a white space delimiter, row delimiter, and paragraph delimiter.

None.

You can omit this tag.

You cannot omit the value of this tag.

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.

Specify an integer value from 0 to 86400.

None.

You cannot omit this tag.

You cannot omit the value of this tag.

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.

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag defines the method.

None.

None.

You cannot omit this tag.

You cannot omit the value of this tag.

This tag is specified when identifying the interface type to which the method belongs.

• Home

• Remote

• LocalHome

• Local

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the target method name.

An asterisk (*) indicates that all the methods are targets.

None.

This tag depends on the <method-params> tag of DD.

You cannot omit this tag.

You cannot omit the value of this tag.

This tag is specified to identify a method when multiple methods are defined.

None.

None.

You can omit this tag.

You can omit the value of this tag.

This tag specifies the data type of the argument.

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

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.

Specify an integer value from 0 to 2147483647.

None.

You cannot omit this tag.

You cannot omit the value of this tag.