Hitachi

uCosminexus Application Server Application and Resource Definition Reference Guide


3.5.1 Specifications of the HITACHI Entity Bean Property file

The HITACHI Entity Bean Property file has the following DOCTYPE declaration:

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

The HITACHI Entity Bean Property file is an xml file containing the following tags. Note that you can also use the 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 name

Occurrence pattern

Explanation

<hitachi-entity-bean-property>

Once

Specifies the root tag.

<description>#1

Zero or more times#2

Describes the Entity Bean.

<display-name>#1

One or more times#2

Specifies the Entity Bean display name.

Make sure you specify display-name with the xml:lang property as en. Even if the display name of the corresponding resource is specified in the command argument, you specify display-name with the xml:lang property as en.

1character-string-length

There is no restriction on the characters to be used.#5

However, any single-byte space or linefeed at the beginning or end of the character string is removed.

<icon>#1

Zero or more times#2

Defines the icons of Entity Bean displayed on the GUI tool.

<small-icon>

Zero or once

Specifies the file name for small icons (16 × 16).

<large-icon>

Zero or once

Specifies the file name for large icons (32 × 32).

<persistence-type>

Once

Specifies the persistence management type. #3

You can specify the following character strings:

  • Bean

  • Container

<prim-key-class>

Once

Specifies the primary key class.

You can specify the class, interface, or primitive type that can be specified as a single primary key and compound primary key.

If the persistence management type is Bean, you can specify a concrete class, abstract class, and interface.

If the persistence management type is Container, you can specify only a concrete class.

The classes handled as a single primary key are as follows:

  • java.lang.Boolean

  • java.lang.Byte

  • java.lang.Character

  • java.lang.Short

  • java.lang.Integer

  • java.lang.Long

  • java.lang.Float

  • java.lang.Double

  • java.lang.String

The classes and the interfaces handled as a compound primary key are as follows:

For a class

  • java.lang.Object

  • Class in which java.io.Serializable is implemented and boolean equals(Object obj) and int hashCode() are overridden (possible even if java.io.Serializable is implemented in the parent class).

For an interface

An interface implemented in the class in which java.io.Serializable is implemented and boolean equals(Object obj) and int hashCode() are overridden (possible even if java.io.Serializable is implemented in the parent class).

<reentrant>

Once

Specifies whether recursive invocation can be executed in the same transaction.

You can specify the following values:

true

Recursive invocation can be executed.

false

Recursive invocation cannot be executed.

<abstract-schema-name>

Zero or once

Specifies the abstract schema name of an EntityBean.

If there are multiple schema names, set a unique value for each schema name.

<cmp-field>

Zero or more times

If Container is specified for persistence-type

This tag is mandatory.

If Bean is specified for persistence-type

This tag is ignored by the cjsetappprop and the cjsetresprop commands.

<description>#1

Zero or more times#2

Describes the cmp-field.

<field-name>

Once

Specifies the field name of the Bean that manages persistence.

<primkey-field>

Zero or once

Specifies the field name of the Entity Bean acting as the primary key.

This tag is mandatory when Container is specified for persistence-type and a class acting as a single primary key is specified for prim-key-class. In all other cases, this tag is ignored by the cjsetappprop and the cjsetresprop commands.

The value that you can specify is the character string specified for the field-name of cmp-field.

The data type of the field specified for primkey-field must match with the character string of prim-key-class.

<env-entry>

Zero or more times

Defines the environment entry.

<description>#1

Zero or more times#2

Describes the environment entry.

<env-entry-name>

Once

Specifies the environment entry name.

<env-entry-type>

Once

Specifies the environment entry data type.

You can specify the following character strings:

  • java.lang.Boolean

  • java.lang.Byte

  • java.lang.Short

  • java.lang.Integer

  • java.lang.Long

  • java.lang.Float

  • java.lang.Double

  • java.lang.String

  • java.lang.Character

<env-entry-value>

Once

Specifies the environment entry value.

Specify a value suitable to the type specified in env-entry-type.

If a value other than java.lang.String is specified in env-entry-type, you cannot specify a null character.

<ejb-ref>

Zero or more times

Defines the reference information of the Enterprise Bean with a remote interface.

<description>#1

Zero or more times#2

Describes ejb-ref.

<ejb-ref-name>

Once

Specifies the ejb-ref name.

<ejb-ref-type>

Once

Specifies the type of Enterprise Bean to be linked to.

You can specify the following character strings:

  • Entity

  • Session

<home>

Once

Specifies the Remote Home interface name of the Enterprise Bean to be linked to.

<remote>

Once

Specifies the Remote Component interface name of the Enterprise Bean to be linked to.

<ejb-link>

Zero or once

Specifies the ejb-name to be linked to.

<ejb-local-ref>

Zero or more times

Defines the reference information of the Enterprise Bean with a local interface.

<description>#1

Zero or more times#2

Describes ejb-local-ref.

<ejb-ref-name>

Once

Specifies the ejb-local-ref name.

<ejb-ref-type>

Once

Specifies the type of Enterprise Bean to be linked to.

You can specify the following character strings:

  • Session

  • Entity

<local-home>

Once

Specifies the Local Home interface name of the Enterprise Bean to be linked to.

<local>

Once

Specifies the Local Component interface name of the Enterprise Bean to be linked to.

<ejb-link>

Zero or once

Specifies ejb-name to be linked to.

<security-role-ref>

Zero or more times

Defines the security role.

<description>#1

Zero or more times#2

Describes security-role-ref.

<role-name>

Once

Specifies the security-role-ref name.

<role-link>

Zero or once

Specifies the role name to be linked to.

<security-identity>

Zero or once

Defines the security identity.

<description>#1

Zero or more times#2

Describes security-identity.

<use-caller-identity>

Once

Specifies whether to use the runtime security-identity. Note that this tag does not have a value.

Specify either <use-caller-identity> or <run-as>.

<run-as>

Once

Defines the information of the runtime security-identity.

Specify either <use-caller-identity> or <run-as>.

<description>#1

Zero or more times#2

Describes the runtime security-identity.

<role-name>

Once

Specifies the role name of the runtime security-identity.

<user-name>

Zero or once

Specifies the principal name.

<resource-ref>

Zero or more times

Defines the reference information for the resource.

<description>#1

Zero or more times#2

Describes resource-ref.

<res-ref-name>

Once

Specifies the resource-ref name.

<res-type>

Once

Specifies 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 set in the <connectionfactory-interface> tag) of the reference destination resource adapter.

<res-auth>

Once

Specifies the authentication method.

You can specify the following character strings:

  • Application

  • Container

<res-sharing-scope>

Zero or once

Specifies whether to share the referenced resources.

You can specify the following character strings:

  • Shareable

  • Unshareable

<mapped-name>

Zero or once

Specifies 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 once

Specifies 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 adapter of Connector 1.5 or later versions

Resource-adapter-display-name!Connection-definition-identifier

The Connection-definition-identifier is the value specified in the <connectionfactory-interface> tag in the ra.xml.

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

This tag is ignored by the cjsetresprop command.

<resource-env-ref>

Zero or more times

Defines the reference information for the resource environment variable.

<description>#1

Zero or more times#2

Describes resource-env-ref.

<resource-env-ref-name>

Once

Specifies the resource-env-ref name.

<resource-env-ref-type>

Once

Specifies the class type of the resource environment variable value.

You can specify the following character strings:

  • javax.jms.Queue

  • javax.jms.Topic

  • Class name of the JavaBeans resource

When you specify <linked-adminobject>, any class name is displayed.

<mapped-name>

Zero or once

Displays the corresponding queue#3 in the following format when <resource-env-ref-type> is javax.jms.Queue.

Resource-adapter-display-name#Queue-name

When you specify this tag at the same time as <linked-Queue>, the <linked-Queue> tag becomes valid.

Displays the display name of the corresponding JavaBeans resource when <resource-env-ref-type> is JavaBeans-resource-class-name. When you specify this tag at the same time as <linked-to>, the <linked-to> tag becomes valid.

<linked-queue>

Zero or once

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

Once

Specifies the resource adapter display name.

You cannot specify the resource adapters conforming to Connector1.5 specifications.

<queue>

Once

Specifies the display name of the queue.

<linked-adminobject>

Zero or once

Specifies the administered object.

This tag is ignored in the cjsetresprop command.

<resourceadapter-name>

Once

Specifies the resource adapter display name.

You cannot specify the resource adapters conforming to Connector1.0 or earlier versions.

<adminobject-name>

Once

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 ([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 once

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

<query>

Zero or more times

Defines the EJB QL.

<description>

Zero or once

Describes the query.

<query-method>

Once

Defines the query method.

<method-name>

Once

Specifies the query method (finder or select method).

<method-params>

Once

Specifies the query method arguments.

<method-param>

Zero or more times

Specifies the Java type of the finder or select method arguments.

<result-type-mapping>

Zero or once

Specifies the object type when the Entity object is returned by the select method.

Specify either Remote or Local. The default value is Local.

<ejb-ql>

Once

Specifies the EJB QL query statement.

<method-permission>

Zero or more times

Defines the method permission.

<description>#1

Zero or more times#2

Describes method-permission.

<role-name>

One or more times

Specifies the role name allocated to the method.

Specify either <role-name> or <unchecked>.

<unchecked>

Once

Specifies the authentication check for executing the method.

If you use this tag, the authentication check is not performed. Specifies the role name allocated to the method.

Specify either <role-name> or <unchecked>.

Note that this tag does not have a value.

<method>

One or more times

Defines the method.

<description>

Zero or more times#2

Describes the method.

<method-intf>

Zero or once

Specifies the type of interface to which the method belongs.

You can specify the following character strings:

  • Home

  • Remote

  • LocalHome

  • Local

When this tag is omitted, all the interface types are assumed to be specified.

<method-name>

Once

Specifies the method name.

When you specify "*", all the methods are assumed to be specified.

<method-params>

Zero or once

This 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 times

Specifies 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[]

<container-transaction>

Zero or more times

Defines the container transaction

<description>#1

Zero or more times#2

Describes container-transaction.

<method>

One or more times

Defines the method

<description>#1

Zero or more times#2

Describes the method

<method-intf>

Zero or once

Specifies the interface type to which the method belongs.

You can specify the following character strings:

  • Home

  • Remote

  • LocalHome

  • Local

When this tag is omitted, all the interface types are assumed to be specified.

<method-name>

Once

Specifies the method name.

When you specify "*", all the methods are assumed to be specified. #4

<method-params>

Zero or once

This tag is valid when method-name is not a wild card (*).

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 times

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

Once

Specifies the transaction attribute allocated to the method.

You can specify the following character strings:

  • Mandatory

  • Never

  • NotSupported

  • Required

  • RequiresNew

  • Supports

<exclude-list>

Zero or once

Defines the list of methods that are not to be invoked.

<description>#1

Zero or more times#2

Describes exclude-list

<method>

One or more times

Defines the methods that are not to be invoked.

<description>#1

Zero or more times#2

Describes the methods that are not to be invoked

<method-intf>

Zero or once

Specifies the interface type to which the method belongs.

You can specify the following character strings:

  • Home

  • Remote

  • LocalHome

  • Local

When this tag is omitted, all the interface types are assumed to be specified.

<method-name>

Zero or once

Specifies the method name.

When you specify "*", all the methods are assumed to be specified.

<method-params>

Zero or once

This 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 times

Specifies 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[]

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

<lookup-name>

Once

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.

You can specify alphanumeric characters (0 to 9, A to Z, and a to z) and the following special characters in the lookup name:

Space ( ), exclamation mark (!), double quotation mark ("), hash mark (#), dollar sign ($), percent sign (%), ampersand (&), single quotation ('), left parenthesis and right parenthesis (() ()), asterisk (*), plus sign (+), 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 only a period (.)

Any single-byte space or linefeed at the beginning or end of the character string is removed. If a linefeed appears in the middle of the character string, an error occurs.

1character-string-length255

<optional-name>

Zero or once

Specifies the optional name of the remote interface.

You can use alphanumeric characters (0 to 9, A to Z, a to z) and the following special characters in the value:

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

You cannot, however, specify the following names:

  • Names beginning with the reserved word HITACHI_EJB (case sensitive)

  • Names in which forward slash (/) or period (.) is specified at the beginning or end

  • Names containing only forward slash (/) or period (.)

  • Names containing continuous forward slashes (/)

Any single-byte space or linefeed at the beginning or end of the character string is removed. If a linefeed appears in the middle of the character string, an error occurs.

1character-string-length255

If no character is specified, the tag is assumed to be omitted.

<local-optional-name>

Zero or once

Specifies the optional name of the local interface.

There is no restriction on the value to be set up.

Any single-byte space or linefeed at the beginning or end of the character string is removed.

<maximum-instances>

Once

Specifies the maximum number of the Enterprise Bean instances.

0 (infinite) or 1maximum-instances2147483647

<pooled-instance>

Once

Specifies the instance pool properties.

<minimum>

Once

Specifies the minimum number of instances in the pool.

0 (infinite) or 1minimummaximum

If you specify an upper limit for maximum, you must also specify an upper limit for minimum.

<maximum>

Once

Specifies the maximum number of instances in the pool.

0 (infinite) or 1maximummaximum-instances

If you specify an upper limit for maximum-instances, you must also specify an upper limit for maximum.

<caching-model>

Once

Specifies the data caching method.

Specify any one of the following values:

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.

<entity-timeout>

Zero or once

Specifies the existence period (seconds) of the EJBObject. 0: No timeout. 1set-value2147483647

<pass-by-reference>

Zero or once

Specifies a pass by reference for the data of each Bean.

<instance-timeout>

Zero or once

Specifies a value from 0 to 86400 (unit: seconds) as the timeout period for acquiring an instance.

If you specify 0, a timeout will not occur. The default value is 0.

<front-ejb>

Zero or once

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

<ejb20-cmp>

Zero or once

Specifies the setting for CMP of EntityBeans in EJB 1.1 and EJB 2.0.#3

This tag is ignored in the cjsetappprop command.

<sql-statement>

Zero or more times

Relates the method with an SQL statement. #3

The methods are finder and ejbSelect.

<method>

Once

Defines the method. #3

Specify either <method> or <operation>.

<method-intf>

Zero or once

Specifies the type of interface to which the method belongs. #3

You can specify the following character strings:

  • Home

  • Remote

  • LocalHome

  • Local

When this tag is omitted, all the interface types are assumed to be specified.

<method-name>

Once

Specifies the method name. #3

When you specify "*", all the methods are assumed to be specified.

<method-params>

Zero or once

This tag is valid when method-name is not "*". #3

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 times

Specifies the parameter data type. #3

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[]

<operation>

Once

Specifies the CMP operation name.#3

Specify either <method> or <operation>.

<sql>

Once

Specifies the SQL statement. #3

<cmp-map>

Zero or once

When persistence-type is Bean

This tag is ignored in the cjsetappprop command.

When persistence-type is Container

This tag is mandatory.

<datasource-name>

Once

Specifies the display name of the data source for mapping the Enterprise Bean fields or the display name of the running resource adapter.

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 adapter of Connector 1.5 or later versions

Resource-adapter-display-name!Connection-definition-identifier

The connection-definition-identifier refers to the value specified in the <connectionfactory-interface> tag in ra.xml.

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

<catalog-name>

Zero or once

Specifies the catalog name of the database for mapping the Enterprise Bean field.

<schema-name>

Zero or once

Specifies the schema name of the database for mapping the Enterprise Bean field.

<table-name>

Once

Specifies the table name of the database for mapping the Enterprise Bean field.

<read-only-access>

Once

Allows or denies the permission for writing to the database from the application.

Specify one of the following values:

true

Writing will be prohibited.

false

Writing will be permitted.

<available-transaction-isolations>

Once

Defines the transactions that you can specify.

<transaction-isolation>

Zero or more times

Describes the specifiable transaction isolation level. #3

Specify one of the following values (auto-generated by accessing the database when the property file is created with the cjgetappprop command):

none

Transaction is not supported.

read committed

Dirty read is controlled.

read uncommitted

Dirty read, non-repeatable read, and phantom read occur.

repeatable_read

Dirty read and non-repeatable read are controlled.

serializable

Dirty read, non-repeatable read, and phantom read are controlled.

<transaction-isolation>

Zero or once

Specifies the transaction isolation level.

Specify one of the transactions included in available-transaction-isolations.

When this tag is omitted, the default transaction isolation level is used (differs on the basis of the database and the JDBC drivers used).

<concurrency-protection>

Zero or once

Specifies the data and record comparison method to be written in the database.

You can specify the following values:

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.

You can omit this tag when read-only-access is true. The tag is ignored even if a value is set.

<field-impl>

Zero or more times

Defines the mapping of the Entity Bean field and table column. #3

<field-name>

Once

Specifies the Entity Bean field name. #3

<column-name>

Once

Specifies the column name of the table.

<finder-impl>

Zero or more times

Specifies the search conditions of the Finder method other than ejbFindByPrimaryKey. #3

<method-name>

Once

Specifies the Finder method name. #3

<where-clause>

Once

Specifies the search conditions of the table. You can specify values other than hash mark (#).

  • The operators that you can specify for the search conditions are as follows. 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.

IS NULL

NULL.

IS NOT NULL

Not NULL.

=

Equal (You can use this operator when the Finder method has one or more parameters).

!=

Not equal (You can use this operator when the Finder method has one or more parameters).

< (&lt;)

Less than ... (You can use this operator when the Finder method has one or more parameters).

> (&gt;)

Greater than ... (You can use this operator when the Finder method has one or more parameters).

<= (&lt;=)

Less than or equal to ... (You can use this operator when the Finder method has one or more parameters).

>= (&gt;=)

More than or equal to ... (You can use this operator when the Finder method has one or more parameters).

LIKE

Matches with the search pattern (You can use this operator when the Finder method has one or more parameters).

NOT LIKE

Does not match with the search pattern (You can use this operator when the Finder method has one or more parameters).

BETWEEN

Within the range (You can use this operator when the Finder method has two or more parameters).

NOT BETWEEN

Not within the range (You can use this operator when the Finder method has two or more parameters).

  • The syntax of the search condition is as follows:

When using IS NULL or IS NOT NULL operators

Field name Operator

When using BETWEEN or NOT BETWEEN operators

Field name Operator ?number AND ?number

When using other operators

Field name Operator ?number

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

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

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

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.

  • In the case of 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.

<start-order>

Zero or once

Specifies the order of starting and 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.

0start-order2147483647

<ejb-method-observation-timeout>

Chapter 5 in the Operation, Monitoring, and Linkage Guide

Zero or more times

This 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 once

Describes the method. You cannot specify this tag multiple times.

<method-intf>

Zero or once

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

You can specify the following values:

  • Home

  • Remote

  • LocalHome

  • Local

When this tag is omitted, all the interface types are assumed to be specified.

<method-name>

Once

Specifies the target method name. When you specify "*", all the methods are assumed to be specified. #4

<method-params>

Zero or once

Specified for identifying the method, when multiple methods are defined.

<method-param>

Zero or more times

Specifies the argument data type.

<method-observation-timeout>

Once

Specifies 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 times

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

Defines the method.

<description>

Zero or once

Describes the method. You cannot specify this tag multiple times.

<method-intf>

Zero or once

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

You can specify the following values:

  • Home

  • Remote

  • LocalHome

  • Local

When this tag is omitted, all the interface types are assumed to be specified.

<method-name>

Once

Specifies the target method name. When you specify "*", all the methods are assumed to be specified. #4

<method-params>

Zero or once

Specified for identifying a method when multiple methods are defined.

<method-param>

Zero or more times

Specifies the argument data type.

<transaction-timeout>

Once

Specifies the transaction timeout period from 0 to 2147483647 (unit: seconds). #5 The default value is 0. If you specify 0 or if there is no tag, the operation is performed using the default timeout value set in the J2EE server.

--

--

--

#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 cjgetappprop or 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.2.3 usrconf.properties (System property file for server management commands) in the manual uCosminexus Application Server Definition Reference Guide.

#5

If CMR is used, you can specify only characters that can be used in Java identifiers.