2.2.4 Details of the Entity Bean property

This subsection describes the details of the Entity 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) <entity>
(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-instances>
(22) <pooled-instance>
(23) <minimum>
(24) <maximum>
(25) <caching-model>
(26) <entity-timeout>
(27) <pass-by-reference>
(28) <instance-timeout>
(29) <front-ejb>
(30) <cmp-map>
(31) <datasource-name>
(32) <catalog-name>
(33) <schema-name>
(34) <table-name>
(35) <read-only-access>
(36) <transaction-isolation>
(37) <concurrency-protection>
(38) <field-impl>
(39) <field-name>
(40) <column-name>
(41) <finder-impl>
(42) <method-name>
(43) <where-clause>
(44) <start-order>
(45) <ejb-method-observation-timeout>
(46) <method>
(47) <method-intf>
(48) <method-name>
(49) <method-params>
(50) <method-param>
(51) <method-observation-timeout>
(52) <ejb-transaction-timeout>
(53) <method>
(54) <method-intf>
(55) <method-name>
(56) <method-params>
(57) <method-param>
(58) <transaction-timeout>

(1) <entity>

Description
This tag defines the Entity 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 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.
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.

(3) <security-identity>

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

(5) <user-name>

Description
This tag specifies the user 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.

(6) <resource-ref>

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

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

(9) <resource-env-ref>

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

(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 can omit this tag.
Value omission
You cannot 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 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.
Specifiable value
There are no limitations for the input value.
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 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.
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-instances>

Description
This tag specifies the maximum number of Enterprise Bean instances.
Specifiable value
Specify an integer value of 0 (infinite) or 1[Figure] maximum-instances[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) <pooled-instance>

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

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

(24) <maximum>

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

(25) <caching-model>

Description
This tag specifies the caching model.
Specifiable value
  • 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.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(26) <entity-timeout>

Description
This tag specifies the existence time (seconds) of the EJB object.
When you specify 0, a timeout does not occur.
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.

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

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

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

(30) <cmp-map>

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

(31) <datasource-name>

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

(32) <catalog-name>

Description
This tag specifies the catalog name of the database as the mapping destination of the Enterprise Bean field.
Specifiable value
There are no limitations for the input value.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(33) <schema-name>

Description
This tag specifies the schema name of the database as the mapping destination of the Enterprise Bean field.
Specifiable value
There are no limitations for the input value.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(34) <table-name>

Description
This tag specifies the table name of the database as the mapping destination of the Enterprise Bean field.
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.

(35) <read-only-access>

Description
This tag specifies whether to prohibit writing from an application to the database. However, even if specified, this tag is disabled in Application Server.
Specifiable value
  • true
    Writing will be prohibited.
  • false
    Writing will be allowed.
Dependency on other tags
None.
Tag omission
You cannot omit this tag.
Value omission
You cannot omit the value of this tag.

(36) <transaction-isolation>

Description
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).
Specifiable value
  • 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.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(37) <concurrency-protection>

Description
Specifies the concurrency protection to be written in the database.
Specifiable value
  • 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.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(38) <field-impl>

Description
This tag specifies the mapping between the Entity Bean field and the table column.
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.

(39) <field-name>

Description
This tag specifies the field name of the Entity Bean.
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.

(40) <column-name>

Description
This tag specifies the column name of the table.
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.

(41) <finder-impl>

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

(42) <method-name>

Description
This tag specifies the method name of the Finder method.
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.

(43) <where-clause>

Description
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.
OperatorDescriptionRemarks
IS NULLNULL--
IS NOT NULLNot NULL--
=EqualYou can use this operator when the number of parameters of the Finder method is one or more.
!=Not equal
< (&lt;)Less than ...
> (&gt;)Greater than ...
<= (&lt;=)Less than or equal to ...
>= (&gt;=)Greater than or equal to ...
LIKEMatches the search pattern
NOT LIKEDoes not match the search pattern
BETWEENWithin the rangeYou can use this operator when the number of parameters of the Finder method is two or more.
NOT BETWEENNot within the range

Legend:

--: 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.
Specifiable value
You can specify values other than hash mark (#).
Dependency on other tags
None.
Tag omission
You cannot omit the value of this tag.
Value omission
You can omit this tag.

(44) <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 the 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.

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

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

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

(48) <method-name>

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

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

(50) <method-param>

Description
This tag specifies the data type of the argument.
Specifiable value
There are no limitations for the input value.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

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

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

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

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

(55) <method-name>

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

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

(57) <method-param>

Description
This tag specifies the data type of the argument.
Specifiable value
There are no limitations for the input value.
Dependency on other tags
None.
Tag omission
You can omit this tag.
Value omission
You cannot omit the value of this tag.

(58) <transaction-timeout>

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