2.2.4 Details of the Entity Bean property

This tag defines the Entity Bean.

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the name of ejb.

Note that this key is used for identifying the Entity Bean.

Specifies the value set for <ejb-jar>-<enterprise-beans>-<entity>-<ejb-name> in the ejb-jar.xml file.

There are no limitations for the input value.

None.

You cannot omit this tag.

You cannot omit the value of this tag.

This tag defines the security identity of the Entity 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 this tag.

You cannot omit the value of this tag.

This tag specifies the user 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 defines the resource to be referenced from the Entity 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.

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 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 this tag.

You can omit the value of this tag.

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

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the name of resource-env-ref.

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.

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 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.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 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.

There are no limitations for the input value.

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

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 Enterprise Bean instances.

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

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the properties of an instance 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 of the DD.

You can omit this tag.

You cannot omit the value of this tag.

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

When maximum-instances is 0 (infinite)

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

When maximum-instances is not 0 (infinite)

Specify an integer value of 1 ≤ maximum ≤ maximum-instances.

This tag depends on the <maximum-instances> tag.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the caching model.

• full-caching

  The entire status information when the method is running is cached.

• caching

  The status information used most frequently when the method is running is cached.

• no-caching

  Status information is not cached.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the existence time (seconds) of the EJB object.

When you specify 0, a timeout does not occur.

Specify an integer value from 0 to 2147483647.

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 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 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 maps the Entity Bean field on the database.

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 started as the mapping destination of the Enterprise Bean field.

• 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 this tag.

You cannot omit the value of this tag.

This tag specifies the catalog name of the database as the mapping destination of the Enterprise Bean field.

There are no limitations for the input value.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the schema name of the database as the mapping destination of the Enterprise Bean field.

There are no limitations for the input value.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the table name of the database as the mapping destination of the Enterprise Bean field.

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 whether to prohibit writing from an application to the database. However, even if specified, this tag is disabled in Application Server.

• true

  Writing will be prohibited.

• false

  Writing will be allowed.

None.

You cannot omit this tag.

You cannot omit the value of this tag.

This tag specifies the transaction isolation level.

If this tag is omitted, the default transaction isolation level is used (differs depending on the database and the JDBC driver being used).

• none

  The transaction is not supported.

• read_committed

  Uncommitted read is prevented.

• read_uncommitted

  Uncommitted reads, non-repeatable reads, and phantom reads occur.

• repeatable_read

  Uncommitted reads and non-repeatable reads are prevented.

• serializable

  Uncommitted reads, non-repeatable reads, and phantom reads are prevented.

None.

You can omit this tag.

You cannot omit the value of this tag.

Specifies the concurrency protection to be written in the database.

• primary-key

  Compares with the primary key and updates the data.

• modified-data

  Compares with the primary key and checks if the value of the data to be changed is changed after the last read operation.

• whole-row

  Compares with the primary key and checks if all the values in the row, including the value to be changed, are changed after the last read operation.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the mapping between the Entity Bean field and the table column.

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the field name of the Entity Bean.

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 column name of the table.

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 search conditions for the Finder method other than ejbFindByPrimaryKey.

None.

None.

You can omit this tag.

You cannot omit the value of this tag.

This tag specifies the method name of the Finder method.

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 search conditions for the table.

The following table describes the operators that you can specify in the search conditions.

Note that you use entities such as round brackets "()" as described in the table when editing a property file with the text editor because the use of angle brackets "<>" for values in XML syntaxes is not permitted.

--: Not applicable.

The syntaxes of the search conditions are as follows:

• When using IS NULL and IS NOT NULL operators

  Field name Operator

• When using BETWEEN and NOT BETWEEN operators

  Field name Operator ?number AND ?number

• When using other operators

  Field name Operator ?number

The rules concerning the search conditions are as follows:

• You can join the search conditions with AND or OR.

• Search conditions, AND, OR, and field names are case sensitive.

• ?number specifies the location (1, 2, ...from the left) of the arguments of the Finder method.

  For example: id &lt;= ?1 AND value IS NOT NULL OR name BETWEEN ?3 AND ?4

• Insert a space of one or more characters between the search conditions, AND, OR, field names, and ?number.

• For a blank character string, all the rows of the table are assumed to match the search pattern.

• You cannot use this method from the application when DISABLE is specified.

You can specify values other than hash mark (#).

None.

You cannot omit the value of this tag.

You can omit 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 the 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 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.

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.

There are no limitations for the input value.

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

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.

There are no limitations for the input value.

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.

There are no limitations for the input value.

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

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.

There are no limitations for the input value.

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 performed 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.