uCosminexus Application Server, Application and Resource Definition Reference Guide

[Contents][Index][Back][Next]

2.1 Specifications of the Cosminexus application property file (cosminexus.xml)

The Cosminexus application property file (cosminexus.xml) is used for acquiring and editing the information that is unique to Application Server. The Cosminexus application property file (cosminexus.xml) only describes the locations at which the set value was changed. If you set up the default values using commands such as the server management commands, the relevant tags are deleted from this file.

The following properties are defined in the Cosminexus application property file (cosminexus.xml):

Note that you can use the Cosminexus application property file (cosminexus.xml) only when the Application Server version is 08-00 or a later version.

The format and storage location of the Cosminexus application property file (cosminexus.xml) are as follows:

Format
This is an xml file.

Storage location
EAR-root/META-INF/cosminexus.xml

The following table lists and describes the items defined in the tables of the Cosminexus application property file (cosminexus.xml):

Item name Explanation
Tag name Displays the tag to be set.
Occurrence pattern Indicates the frequency of occurrence of the tag.
Contents Indicates the contents to be defined in the tag.
Specifiable value Indicates the value that can be specified in the tag.
Default Indicates the value that is enabled when the tag or the contents to be specified in the tag are omitted. If no default value exists, "None" is specified.
Identification key Indicates if the specified tag is a key used for identifying the DD and module. The legend is as follows:
D: Key to identify the elements of a DD.
K: Key to identify modules.
--: Key not used for identification.

For details on the tags, the omission of the keys and values, and the dependency on other tags, see 2.2 Details of each property specified in the Cosminexus application property file (cosminexus.xml).

The Cosminexus application property file (cosminexus.xml) has the following DOCTYPE declaration. Note that you need not edit the DOCTYPE declaration.

<!DOCTYPE cosminexus-app PUBLIC '-//Hitachi, Ltd.//DTD Cosminexus 9.5//EN' 'file:///Cosminexus-installation-directory/CC/admin/dtds/cosminexus_9_5.dtd'>

The configuration and specifications of cosminexus.xml are as follows.

The tag names described in the Tag name column are also cross-reference links to the proceeding sections describing information related to the tags. uCosminexus Application Server is omitted from the manual names.

Tag name Occurrence pattern Contents Specifiable value Default Identification key
<cosminexus-app> Zero or once This is the root tag. -- None --
<security-prop> Zero or once Specifies the management method for the security of cosminexus-app -- None --
<security-method> Once Specifies whether to enable the security settings. You can specify the following character strings:
  • disable_methods_without_roles
  • map_methods_without_roles
  • no_security_for_methods_without_roles
  • no_security_for_all_methods
 no_security_for_methods_without_roles --
<default-security-role> Zero or once Specifies the default security role when map_methods_without_roles is specified in <security-method>. There are no limitations for the input value. None --
<start-order> Zero or once 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. 10 --
<scheduling-unit> Zero or once Specifies the deployment model of the queue. You can specify the following character strings:
  • Application
  • Bean
 Application --
<scheduling> Zero or once Sets up the information related to CTM integration. -- None --
<queue-name> Zero or once Specifies the queue name for which scheduling is to be performed. You can specify 1 to 63 alphanumeric characters and underscores (_). Application-name # --
<parallel-count> Zero or once Specifies the number of threads provided by the CTM scheduler to invoke an application. Specify an integer value from 1 to 127. 1 --
<queue-length> Zero or once Specifies the length of a queue. Specify an integer value from 1 to 32767. Length-during-generation-of-the-CTM-queue-maintained-in-the-CTM-daemon (length specified in the -CTMMaxRequestCount option) --
<managed-by-ctm> Zero or once Specifies whether to integrate CTM. You can specify the following character strings:
  • true
  • false
 false --
<ref-libraries> Zero or once Specifies the library JAR to be referenced. -- None --
<classpath> One or more times Specifies the class path of the referenced library. There are no limitations for the input value. None --
<method-observation-recovery-mode> Zero or once Specifies the recovery mode of the method time monitoring functionality. You can specify the following character string:
  • thread
 None --
<ejb-async-props> Zero or once Sets up the information for invoking the Session Bean asynchronously. -- None --
<min-thread-pool-size> Zero or once Specifies the minimum number of threads executed concurrently in a thread pool. Specify an integer value from 1 to 2147483647. 16 --
<max-thread-pool-size> Zero or once Specifies the maximum number of threads executed concurrently in a thread pool. Specify an integer value from 1 to 2147483647. 32 --
<thread-pool-keep-alive> Zero or once Specifies the timeout value (unit: seconds) until the threads in the thread pool are released. Specify an integer value from 1 to 2147483647. 60 --
<result-timeout-value> Zero or once Specifies the time (unit: minutes) at which the results of asynchronous invocation will be stored.
If 0 is specified, the results of asynchronous invocation are not released and are stored until the application is terminated. 		Specify an integer value from 0 to 2147483647. 30 --
<ejb-jar> Zero or more times Defines the EJB-JAR. -- None --
<module-name> Once Specifies the module name from which you can identify the EJB-JAR. There are no limitations for the input value. None K
<security-role> Zero or more times Defines the security role. -- None --
<role-name> Once Role name. There are no limitations for the input value. None D
<linked-to> Once Specifies the role name defined by the cjaddsec command. -- The link is not resolved. --
<session> Zero or more times Defines SessionBean. -- None --
<ejb-name> Once Specifies the name of the ejb.
Note that this key is used for identifying the SessionBean.
Specifies the setup value of <ejb-jar>-<enterprise-beans>-<session>-<ejb-name> in the ejb-jar.xml.
For an application that does not include ejb-jar.xml, the setup value of name of @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 D
<security-identity> Zero or once Defines the security identity of the SessionBean. -- None --
<run-as> Once Defines the runtime identity. -- None --
<user-name> Once Specifies the user name. -- None --
<resource-ref> Zero or more times Defines the resource to be referenced from SessionBean. -- None --
<res-ref-name> Once Specifies the name of the resource reference. -- None D
<linked-to> Once Specifies the corresponding resource adapter display name and mail display name.
The member resource adapters of the cluster connection pool cannot be specified.		 There are no limitations for the input value. The link is not resolved. --
<resource-env-ref> Zero or more times Defines the resource environment variables to be referenced from SessionBean. -- None --
<resource-env-ref-name> Once Specifies the name of the resource environment variable reference. -- None D
<linked-queue> Once Specifies the queue name. -- None --
<resource-adapter> Once Specifies the display name of the resource adapter. There are no limitations for the input value. None --
<queue> Once Specifies the queue name. There are no limitations for the input value. None --
<linked-adminobject> Once Specifies the administered object. -- None --
<resourceadapter-name> Once Specifies the display name of the resource adapter. There are no limitations for the input value. None --
<adminobject-name> Once Specifies the administered object name. 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 ($), percentage sign (%), ampersand (&), single quotation mark ('), left parenthesis and right parenthesis (() ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), colon (:),semicolon (;), less-than sign (<), equal to sign (=), greater-than sign (>), question mark (?), at mark (@), square brackets ([) (]), yen sign ([Figure]), caret (^), underscore (_), grave accent mark (`), curly brackets ({) (}), vertical bar (|), and tilde (~)
You cannot, however, specify the following names:
  • A name containing a period (.) at the beginning or at the end
  • A name containing a period (.) only
  • A name containing continuous underscores (_)
 None --
<linked-to> Once 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>.		 -- The link is not resolved. --
<lookup-name> Zero or 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.
If this tag is omitted, the resource name is used as the default value, however, all the characters other than the alphanumeric characters and underscores (_) included in the default value are converted into underscores.		 You can specify the alphanumeric characters (0 to 9, A to Z, and a to z) and the following special characters:
Space ( ), double quotation mark ("), dollar sign ($), percentage sign (%), ampersand (&), single quotation mark ('), left parenthesis and right parenthesis (() ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), colon (:),semicolon (;), less-than sign (<), equal to 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, you cannot specify the following names:
  • A name that includes a period (.) in the beginning or at the end
  • A name that only includes 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.		 Resource-name --
<optional-name> Zero or once 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 ([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 only includes a slash (/) or a period (.)
  • 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.		 The optional name is not added. --
<local-optional-name> Zero or once Specifies the optional name of the local interface. There are no limitations for the specifiable characters.
You can specify 1 to 255 characters. 		The optional name is not added. --
<maximum-sessions> Zero or once Specifies the maximum number of sessions or Bean instances.
For a Stateless Session Bean, this set value is disabled.		 An integer value of 0 (infinite) or 1 [Figure] maximum-sessions [Figure] 2147483647. 0 --
<stateless> Zero or once This tag is specified when the Session Bean type is Stateless.
Either <stateless> or <stateful>, or neither of these is specified.		 -- None --
<pooled-instance> Zero or once Defines the instances within a pool. -- None --
<minimum> Zero or once Specifies the minimum number of instances within a pool.
However, the value set in this tag is ignored because you can specify a maximum number to customize the pooling operations.		 An integer value of 0 or 1 [Figure] minimum [Figure] maximum. 0 --
<maximum> Zero or once Specifies the maximum number of instances within a pool. An integer value of 0 (infinite) or 1 [Figure] maximum [Figure] 2147483647.
Furthermore, when the value of <enable-scheduling> is true and the value of the application property <managed-by-ctm> is true, the specifiable range will differ.
When the specified value of the application property <scheduling-unit> is Bean:
An integer value of 0, or equal to or more than the <scheduling>-<parallel-count> tag.
When the specified value of the application property <scheduling-unit> is Application:
An integer value of 0, or equal to or more than the application property <scheduling>-<parallel-count>. 		0 --
<instance-timeout> Zero or once Specifies the instance acquisition timeout value (seconds).
When you specify 0, a timeout does not occur.		 An integer value from 0 to 86400. 0 --
<stateful> Zero or once This tag is specified when the Session Bean type is Stateful.
Either <stateless> or <stateful>, or neither of these is specified.		 -- None --
<maximum-active-sessions> Zero or once Specifies the maximum number of active sessions. When maximum-sessions is 0 (infinite), an integer value of 0 (infinite) [Figure]maximum-active-sessions [Figure] 2147483647.
When maximum-sessions is other than 0 (infinite), an integer value of 1 [Figure] maximum-active-sessions [Figure] maximum-sessions.		 0 --
<inactivity-timeout> Zero or once Specifies the time period (minutes) for which the inactive status is retained until the session is activated again. An integer value of 0 (infinite) or 1 [Figure] inactivity-timeout [Figure] 2147483647. 0 --
<removal-timeout> Zero or once Specifies the time period (minutes) for which the inactive status is retained until the session is removed. An integer value of 0 (infinite) or 1 [Figure]removal-timeout [Figure] 2147483647. 0 --
<enable-scheduling> Zero or once Specifies whether to use the corresponding Bean as the scheduler Gate. You can specify the following character strings:
  • true
  • false
 false --
<pass-by-reference> Zero or once Specifies whether to invoke the EJB with a pass-by-reference. You can specify the following character strings:
  • true
  • false
 false --
<scheduling> Zero or once Sets up the information related to CTM integration. -- None --
<queue-name> Zero or once Specifies the queue name for which scheduling is to be performed. You can use 1 to 63 alphanumeric characters and underscores (_). ejb-name --
<parallel-count> Zero or once Specifies the number of threads provided by the CTM scheduler to invoke an application. Specify an integer value from 1 to 127. 1 --
<queue-length> Zero or once Specifies the length of a queue. An integer value from 1 to 32767. Length-during-generation-of-the-CTM-queue-maintained-in-the-CTM-daemon (length specified in the -CTMMaxRequestCount option) --
<front-ejb> Zero or once Specifies whether the specified EJB is a front EJB (an EJB invoked directly by the client). You can specify the following character strings:
  • true
  • false
 false --
<start-order> Zero or once Specifies the order of starting or 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. 10 --
<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 such cases, a warning message (KDJE42377-W) is output, and the value of <method-observation-timeout> of the <ejb-method-observation-timeout> tag defined first is enabled. -- None --
<method> One or more times Defines the method. -- None --
<method-intf> Zero or once This tag is specified when identifying the interface type to which the method belongs to. You can specify the following character strings:
  • Home
  • Remote
  • LocalHome
  • Local
 All the values including Home, Remote, LocalHome, and Local. --
<method-name> Once Specifies the target method name.
An asterisk (*) indicates that all the methods are the target.		 There are no limitations for the input value. None --
<method-params> Zero or once This tag is specified to identify a method when multiple methods are defined. -- None --
<method-param> Zero or more times Specifies the data type of argument. Specify a value other than a white space delimiter, row delimiter, and paragraph delimiter. None --
<method-observation-timeout> Once Specifies the timeout value (seconds) used for monitoring the in-process methods.
When you specify 0, a timeout does not occur.		 An integer value from 0 to 86400. 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 are the same, the tags are merged into one. In such cases, a warning message (KDJE42377-W) is output, and the value of <transaction-timeout> of the <ejb-transaction-timeout> tag defined first is enabled. 		-- None --
<method> One or more times Defines the method. -- None --
<method-intf> Zero or once This tag is specified when identifying the interface type to which the method belongs. You can specify the following character strings:
  • Home
  • Remote
  • LocalHome
  • Local
 All the values including Home, Remote, LocalHome, and Local. --
<method-name> Once Specifies the target method name.
An asterisk (*) indicates that all the methods are targets.		 -- None --
<method-params> Zero or once This tag is specified to identify a method when multiple methods are defined. -- None --
<method-param> Zero or more times Specifies the data type of the argument. -- None --
<transaction-timeout> Once Specifies the transaction timeout value (seconds).
When 0 (zero) is specified, the operation is performed using the default timeout value set in the J2EE server.		 Specify an integer value from 0 to 2147483647. 0 --
<entity> Zero or more times Defines the EntityBean. -- None --
<ejb-name> Once Specifies the name of the ejb.
Note that this key is used for identifying the EntityBean.
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 D
<security-identity> Zero or once Defines the security identity of the EntityBean. -- None --
<run-as> Once Defines the runtime identity. -- None --
<user-name> Once Specifies the user name. There are no limitations for the input value. None --
<resource-ref> Zero or more times Defines the resource to be referenced from EntityBean. -- None --
<res-ref-name> Once Specifies the name of the resource reference. There are no limitations for the input value. None D
<linked-to> Once Specifies the corresponding resource adapter display name and mail display name.
The member resource adapters of the cluster connection pool cannot be specified.		 There are no limitations for the input value. The link is not resolved. --
<resource-env-ref> Zero or more times Defines the resource environment variable to be referenced from EntityBean. -- None --
<resource-env-ref-name> Once Specifies the name of resource-env-ref. There are no limitations for the input value. None D
<linked-queue> Once Specifies the queue name. This tag is enabled only when javax.jms.Queue is specified in the DD element <resource-env-ref-type>. -- None --
<resource-adapter> Once Specifies the display name of the resource adapter. There are no limitations for the input value. None --
<queue> Once Specifies the queue name. There are no limitations for the input value. None --
<linked-adminobject> Once Specifies the administered object. -- None --
<resourceadapter-name> Once Specifies the display name of the resource adapter. There are no limitations for the input value. None --
<adminobject-name> Once Specifies the administered object name. You can use the 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 ($), percentage sign (%), ampersand (&), single quotation mark ('), left parenthesis and right parenthesis (() ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), colon (:),semicolon (;), less-than sign (<), equal to 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 (.)
  • A name containing continuous underscores (_)
 None --
<linked-to> Once 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>.		 There are no limitations for the input value. The link is not resolved. --
<lookup-name> Zero or 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.
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 the 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.		 Resource-name --
<optional-name> Zero or once Specifies the optional name of the remote interface. You can specify the 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 slash (/) or a period (.) in the beginning or at the end
  • A name that only includes a slash (/) or a period (.)
  • A name that includes 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.		 The optional name is not added. --
<local-optional-name> Zero or once Specifies the optional name of the local interface. There are no limitations for the specifiable characters.
You can specify 1 to 255 characters.		 The optional name is not added. --
<maximum-instances> Zero or once Specifies the maximum number of Enterprise Bean instances. An integer value of 0 (infinite) or 1 [Figure] maximum-instances [Figure] 2147483647. 0 --
<pooled-instance> Zero or once Specifies the properties of an instance pool. -- None --
<minimum> Zero or once Specifies the minimum number of instances within a pool. 0 (infinite) or 1 [Figure] minimum [Figure] maximum. 0 --
<maximum> Zero or once Specifies the maximum number of instances within a pool. [When maximum-instances is 0 (infinite)]
An integer value of 0 (infinite) [Figure]maximum [Figure] 2147483647.
[When maximum-instances is other than 0 (infinite)]
An integer value of 1 [Figure] maximum [Figure] maximum-instances.		 0 --
<caching-model> Zero or once Specifies the caching model. You can specify the following character strings:
  • full-caching
  • caching
  • no-caching
 caching --
<entity-timeout> Zero or once 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. 0 --
<pass-by-reference> Zero or once Specifies whether to invoke the EJB with pass-by-reference. You can specify the following character strings:
  • true
  • false
 false --
<instance-timeout> Zero or once Specifies the instance acquisition timeout value (seconds). When you specify 0, a timeout does not occur. An integer value from 0 to 86400. 0 --
<front-ejb> Zero or once Specifies whether the specified EJB is a front EJB (an EJB invoked directly by the client). You can specify the following character strings:
  • true
  • false
 false --
<cmp-map> Zero or once Maps the Entity Bean field on the database. -- None --
<datasource-name> Once Specifies the display name of the resource adapter started as the mapping destination of the Enterprise Bean field. There are no limitations for the input value. The link is not resolved. --
<catalog-name> Zero or once Specifies the database catalog name as the mapping destination of the Enterprise Bean field. There are no limitations for the input value. None --
<schema-name> Zero or once Specifies the database schema name as the mapping destination of the Enterprise Bean field. There are no limitations for the input value. None --
<table-name> Once Specifies the database table name as the mapping destination of the Enterprise Bean field. There are no limitations for the input value. None --
<read-only-access> Once Specifies whether to prohibit writing from an application to the database. However, even if specified, this tag is disabled in Application Server. You can specify the following character strings:
  • true
  • false
 None --
<transaction-isolation> Zero or once Specifies the transaction isolation level.
If omitted, the default transaction isolation level is used (differs depending on the database and JDBC driver in use).		 You can specify the following character strings:
  • none
  • read_committed
  • read_uncommitted
  • repeatable_read
  • serializable
 None --
<concurrency-protection> Zero or once Specifies the data and record comparison method to be written in the database. You can specify the following character string:
  • primary-key
 primary-key --
<field-impl> Zero or more times Specifies the mapping between the Entity Bean field and the table column. -- None --
<field-name> Once Specifies the field name of the Entity Bean. There are no limitations for the input value. None --
<column-name> Once Specifies the column name of the table. There are no limitations for the input value. None --
<finder-impl> Zero or more times Specifies search conditions for the Finder method other than ejbFindByPrimaryKey. -- None --
<method-name> Once Specifies the method name of the Finder method. There are no limitations for the input value. None --
<where-clause> Once Specifies the search conditions for the table. You can specify values other than the hash mark (#). None --
<start-order> Zero or once Specifies the order of starting or stopping 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. 10 --
<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 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> of the <ejb-method-observation-timeout> tag defined first is enabled.
 -- None --
<method> One or more times Defines the method. -- None --
<method-intf> Zero or once This tag is specified when identifying the interface type to which the method belongs. You can specify the following character strings:
  • Home
  • Remote
  • LocalHome
  • Local
 All the values including Home, Remote, LocalHome, and Local. --
<method-name> Once Specifies the target method name.
An asterisk (*) indicates that all methods are the target.		 There are no limitations for the input value. None --
<method-params> Zero or once This tag is specified to identify a method when multiple methods are defined. -- None --
<method-param> Zero or more times Specifies the data type of the argument. There are no limitations for the input value. None --
<method-observation-timeout> Once Specifies the timeout value (seconds) used for monitoring the in-process methods.
When you specify 0, a timeout does not occur.		 An integer value from 0 to 86400. 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 are the same, the tags are merged into one. In such cases, a warning message (KDJE42377-W) is output, and the value of <transaction-timeout> of the <ejb-transaction-timeout> tag defined first is enabled. 		-- None --
<method> One or more times Defines the method. -- None --
<method-intf> Zero or once This tag is specified when identifying the interface type to which the method belongs. You can specify the following character strings:
  • Home
  • Remote
  • LocalHome
  • Local
 All the values including Home, Remote, LocalHome, and Local. --
<method-name> Once Specifies the target method name.
An asterisk (*) indicates that all the methods are targets.		 There are no limitations for the input value. None --
<method-params> Zero or once This tag is specified to identify a method when multiple methods are defined. -- None --
<method-param> Zero or more times Specifies the data type of the argument. There are no limitations for the input value. None --
<transaction-timeout> Once Specifies the transaction timeout value (seconds).
When 0 (zero) is specified, the operation is performed using the default timeout value set in the J2EE server.		 Specify an integer value from 0 to 2147483647. 0 --
<message> Zero or more times Defines the Message-driven Bean. -- None --
<ejb-name> Once Specifies the name of the ejb.
Note that this key is used for identifying the Message-driven Bean.
Specifies the value set for <ejb-jar>-<enterprise-beans>-<message-driven>-<ejb-name> in the ejb-jar.xml file.		 There are no limitations for the input value. None D
<security-identity> Zero or once Defines the security identity of the Message-driven Bean. -- None --
<run-as> Once Defines the runtime identity. -- None --
<user-name> Once Specifies the user name. There are no limitations for the input value. None --
<message-ref> Zero or once Specifies the resource adapter. -- None --
<connection-factory> Zero or once Specifies the display name of the resource adapter. There are no limitations for the input value. None --
<connection-destination> Once Defines the resource adapter. -- None --
<resource-adapter> Once Specifies the display name of the resource adapter. There are no limitations for the input value. None --
<queue> Zero or once Specifies the queue name. There are no limitations for the input value. None --
<resource-ref> Zero or more times Defines the resource to be referenced from the Message-driven Bean. -- None --
<res-ref-name> Once Specifies the name of the resource reference. There are no limitations for the input value. None D
<linked-to> Once Specifies the corresponding resource adapter display name and mail display name.
The member resource adapters of the cluster connection pool cannot be specified.		 There are no limitations for the input value. The link is not resolved. --
<resource-env-ref> Zero or more times Defines the resource environment variable to be referenced from the Message-driven Bean. -- None --
<resource-env-ref-name> Once Specifies the name of resource-env-ref. There are no limitations for the input value. None D
<linked-queue> Once Specifies the queue name. This tag is enabled only when javax.jms.Queue is specified in the DD element <resource-env-ref-type>. -- None --
<resource-adapter> Once Specifies the display name of the resource adapter. There are no limitations for the input value. None --
<queue> Once Specifies the queue name. There are no limitations for the input value. None --
<linked-adminobject> Once Specifies the administered object. -- None --
<resourceadapter-name> Once Specifies the display name of the resource adapter. There are no limitations for the input value. None --
<adminobject-name> Once Specifies the administered object name. You can use the 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:
  • A name containing a period (.) at the beginning or at the end
  • A name containing only a period (.)
  • A name containing continuous underscores (_)
 None --
<linked-to> Once 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>.		 There are no limitations for the input value. The link is not resolved. --
<pooled-instance> Zero or once Defines the instances within a pool. -- None --
<minimum> Zero or once Specifies the minimum number of instances within a pool. There are no limitations for the input value. 1 --
<maximum> Zero or once Specifies the maximum number of instances within a pool. Specify an integer value from 1 to 2147483647.
If 0 is specified, the value is assumed as 1.		 1 --
<front-ejb> Zero or once Specifies whether the specified EJB is a front EJB (an EJB invoked directly by the client). You can specify the following character strings:
  • true
  • false
 false --
<start-order> Zero or once Specifies the order of starting or 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. 10 --
<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 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> of the <ejb-method-observation-timeout> tag defined first is enabled. 		-- None --
<method> One or more times Defines the method. -- None --
<method-intf> Zero or once This tag is specified when identifying the interface type to which the method belongs.
You cannot specify a value for this tag in the Message-driven Bean property settings. 		-- None --
<method-name> Once Specifies the target method name.
An asterisk (*) indicates that all the methods are targets.		 There are no limitations for the input value. None --
<method-params> Zero or once This tag is specified to identify a method when multiple methods are defined. -- None --
<method-param> Zero or more times Specifies the data type of the argument. There are no limitations for the input value. None --
<method-observation-timeout> Once Specifies the timeout value (seconds) used for monitoring the in-process methods.
When you specify 0, a timeout does not occur.		 An integer value from 0 to 86400. 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 are the same, the tags are merged into one. In such cases, a warning message (KDJE42377-W) is output, and the value for <transaction-timeout> of the <ejb-transaction-timeout> tag defined first is enabled.		 -- None --
<method> One or more times Defines the method. -- None --
<method-intf> Zero or once This tag is specified when identifying the interface type to which the method belongs.
You cannot specify a value for this tag in the Message-driven Bean property settings.		 -- None --
<method-name> Once Specifies the target method name.
An asterisk (*) indicates that all the methods are the target.		 There are no limitations for the input value. None --
<method-params> Zero or once This tag is specified to identify a method when multiple methods are defined. -- None --
<method-param> Zero or more times Specifies the data type of the argument. There are no limitations for the input value. None --
<transaction-timeout> Once Specifies the transaction timeout value (seconds).
When 0 (zero) is specified, the operation is performed using the default timeout value set in the J2EE server.		 Specify an integer value from 0 to 2147483647. 0 --
<war> Zero or more times Defines the WAR. -- None --
<module-name>
Zero or Once
This is a key for identifying the WAR.
However, in the case of WAR applications, the WAR property for cosminexus.xml is the same, therefore you are not required to specify this tag. Even if you specify, this setting is ignored.
The setup value is specified according to the following conditions:

For an application that includes application.xml
  • Common to the archive format and exploded archive format
    Specifies the character string specified in <application>-<module>-<web>-<web-uri> in application.xml.

For an application that does not include application.xml
  • Archive format (cjimportapp command (-f/-d))
    Specifies the location of the WAR file within the J2EE application using the relative path from the EAR root.
  • Exploded archive format (cjimportapp command (-a))
    Specifies the value of the WAR directory acquired by replacing the _war at the end of the relative path from the application directory, with .war.
There are no limitations for the input value.
None
K
<security-role> Zero or more times Defines the security role. -- None --
<role-name> Once Specifies the security role name. There are no limitations for the input value. None D
<linked-to> Once Specifies the access control list (role name defined by the cjaddsec command). There are no limitations for the input value. None --
<resource-ref> Zero or more times Defines the resource to be referenced from the Servlet. -- None --
<res-ref-name> Once Specifies the name of the resource reference. There are no limitations for the input value. None D
<linked-to> Once Specifies the corresponding resource adapter display name and the mail display name.
The member resource adapters of the cluster connection pool cannot be specified.		 There are no limitations for the input value. None --
<resource-env-ref> Zero or more times Defines the resource environment variable to be referenced from the Servlet. -- None --
<resource-env-ref-name> Once Specifies the name of the resource environment variable reference. There are no limitations for the input value. None D
<linked-queue> Once Specifies the queue name. This tag is enabled only when javax.jms.Queue is specified in the DD element <resource-env-ref-type>. -- None --
<resource-adapter> Once Specifies the display name of the resource adapter. There are no limitations for the input value. None --
<queue> Once Specifies the queue name. There are no limitations for the input value. None --
<linked-adminobject> Once Specifies the administered object. -- None --
<resourceadapter-name> Once Specifies the display name of the resource adapter. There are no limitations for the input value. None --
<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:
  • A name containing a period (.) at the beginning or at the end
  • A name containing a period (.) only
  • A name containing continuous underscores (_)
 None --
<linked-to> Once 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>.		 There are no limitations for the input value. The link is not resolved. --
<thread-control>
2.17 in the Web Container Functionality Guide		 Zero or once Specifies the settings for controlling the Web application threads. -- None --
<thread-control-max-threads> Once Specifies the maximum number of concurrently executed threads of Web applications.
Specify a value equal to or more than the number of dedicated threads.		 An integer value from 1 to 1024. None --
<thread-control-exclusive-threads> Once Specifies the number of dedicated threads.
You specify a value equal to or not more than the maximum number of concurrently executed threads of Web applications.		 An integer value from 1 to 1024. 0 --
<thread-control-queue-size> Once Specifies the pending queue size of Web applications. Specify an integer value from 0 to 2147483647. None --
<thread-control-stats-monitor> Once Specifies the settings for monitoring the operation statistics. When this tag is omitted or when <enabled>, <high-threshold>, or <low-threshold> tags are omitted, the default value and threshold value events are enabled. -- None --
<whole-waiting-request-count> Once Monitors the entire pending request count of the Web applications. -- None --
<enabled> Once Specifies whether to enable the threshold value event for monitoring the entire pending request count of Web applications. You can specify the following character strings:
  • true
  • false
 true --
<high-threshold> Once Specifies the high threshold value (unit: %) for the output of the threshold value event. An integer value from 1 to 100. However, the value must be equal to or greater than the value specified in the <low-threshold> tag. 80 --
<low-threshold> Once Specifies the low threshold value (unit: %) for the output of the threshold value event. An integer value from 0 to 99. However, the value must be equal to or not more than the value specified in the <high-threshold> tag. 0 --
<waiting-request-count> Once Monitors the number of pending requests of the Web applications. -- None --
<enabled> Once Specifies whether to enable the threshold value event for monitoring the number of pending requests of the Web applications. You can specify the following character strings:
  • true
  • false
 true --
<high-threshold> Once Specifies the high threshold value (unit: %) for the output of the threshold value event. An integer value from 1 to 100. However, the value must be equal to or more than the value specified in the <low-threshold> tag. 80 --
<low-threshold> Once Specifies the low threshold value (unit: %) for the output of the threshold value event. An integer value from 0 to 99. However, the value must be equal to or not more than the value specified in the <high-threshold> tag. 0 --
<resource-watcher> Zero or once Specifies the properties related to the monitoring of the number of saved request pending queues of the Web applications. -- None --
<watcher-threshold> Zero or once Specifies the threshold value to output an alert message. An integer value from 1 to 100. 80 --
<watcher-interval> Zero or once Specifies the monitoring interval. Specify an integer value from 1 to 2147483647. 30 --
<watcher-enabled> Zero or once Specifies whether to enable the monitoring of the number of saved request pending queues of the Web applications. You can specify the following character strings:
  • true
  • false
 true --
<watcher-writefile-enabled> Zero or once Specifies whether to output the resource usage status to a file. You can specify the following character strings:
  • true
  • false
 true --
<urlgroup-thread-control>
2.18 in the Web Container Functionality Guide		 Zero or more times Specifies the settings for controlling the number of concurrently executing threads of the URL groups. -- None --
<urlgroup-thread-control-name> Once Specifies the definition name for controlling the number of concurrently executing threads of the URL groups.
Specify a name that is unique in the Web application as the definition name for controlling the number of concurrently executed threads of the URL groups.		 You can use alphanumeric characters, hyphens (-), and underscores (_).
Specify the length of the character string in 1 to 64 characters.		 None --
<urlgroup-thread-control-max-threads> Once Specifies the maximum number of concurrently executed threads of the URL groups. An integer value from 1 to thread-control-max-threads. None --
<urlgroup-thread-control-exclusive-threads> Zero or once Specifies the number of dedicated threads of the URL groups. An integer value from 0 to urlgroup-thread-control-max-threads and equal to or not more than thread-control-exclusive-threads. 0 --
<urlgroup-thread-control-queue-size> Zero or once Specifies the pending queue size of the URL group. Specify an integer value from 0 to 2147483647. None --
<urlgroup-thread-control-mapping> Zero or more times Sets up the mapping information of the URL to be controlled. -- None --
<url-pattern> Once Specifies the URL pattern to be controlled.
You cannot specify the same URL pattern in single Web application. Some examples of specification are as follows:
/soda/grape/*
/foo/*
/contents
*.foo
 There are no limitations for the input value. None --
<stats-monitor> Zero or once Specifies the settings for monitoring the operation statistics. -- None --
<waiting-request-count> Zero or once Monitors the number of pending requests of the URL groups. -- None --
<enabled> Zero or once Specifies whether to enable the threshold value event for monitoring the number of pending requests of the URL groups. You can specify the following character strings:
  • true
  • false
 true --
<high-threshold> Zero or once Specifies the high threshold value (unit: %) for the output of the threshold value event. An integer value from 1 to 100.
The value must be equal to or more than low-threshold.		 80 --
<low-threshold> Zero or once Specifies the low threshold value (unit: %) for the output of the threshold value event. An integer value from 0 to 99.
The value must be equal to or not more than high-threshold.		 0 --
<http-request> Zero or once Specifies various settings concerning an HTTP request. -- None --
<encoding> Once Specifies the default encoding used for decoding a request body and query.
However, if the settings conform to the servlet specifications (ServletAPI and web.xml), this tag will be disabled.
Specify a character encoding supported by JavaVM.		 There are no limitations for the input value. None --
<http-response> Zero or once Specifies various settings concerning an HTTP response. -- None --
<encoding> Once Specifies the default encoding used for encoding a response body.
However, if the settings conform to the servlet specifications (ServletAPI and web.xml), this tag will be disabled.
Specify a character encoding supported by JavaVM.
 There are no limitations for the input value. None --
<jsp> Zero or once Specifies various settings concerning a JSP. -- None --
<page-encoding> Once Specifies the default encoding used to read a JSP file.
However, if the settings conform to the servlet specifications (ServletAPI and web.xml), this tag will be disabled.
Specify a character encoding supported by JavaVM. 		There are no limitations for the input value. None --
<http-session> Zero or once Sets up the information related to the monitoring of the number of HttpSessions of the Web applications. -- None --
<http-session-max-number> Zero or once Specifies the maximum number of usable HttpSessions.
When -1 is specified, the number of usable HttpSessions is infinite.		 An integer value from -1 to 2147483647. -1 --
<resource-watcher> Zero or once Sets up the properties concerning the monitoring of the number of HttpSessions. -- None --
<watcher-threshold> Zero or once Specifies the threshold value to output an alert message. An integer value from 1 to 100. 80 --
<watcher-interval> Zero or once Specifies the monitoring interval. Specify an integer value from 1 to 2147483647. 30 --
<watcher-enabled> Zero or once Specifies whether to enable the monitoring of the number of HttpSessions.
However, if 0 is specified in <http-session-max-number>, monitoring will be disabled irrespective of the value specified.		 You can specify the following character strings:
  • true
  • false
 true --
<watcher-writefile-enabled> Zero or once Specifies whether to output the resource usage status to a file. You can specify the following character strings:
  • true
  • false
 true --
<dbsfo>
Chapter 6 in the Expansion Guide		 Zero or once Sets up the database session failover functionality. -- None --
<enabled> Zero or once Specifies whether to enable the database session failover functionality. You can specify the following character strings:
  • true
  • false
 Property value of the J2EE server (webserver.dbsfo.enabled) --
<application-id> Zero or once Sets up the application identifier. You can specify up to 16 alphanumeric characters and underscores (_). Created from the context root name of the application. --
<attribute-data-size-max> Zero or once Sets up the maximum size for the property information of an HTTP session that can be included in the global session information. An integer value from 128 to 10485760. Property value of the J2EE server (webserver.dbsfo.attribute_data_size.max) --
<exclude-extensions> Zero or once Sets up an extension to control the database session failover functionality.
When specifying multiple extensions, demarcate with commas (,).		 Specify up to 512 characters using the following:
  • Alphanumeric characters
  • Parentheses (())
  • Exclamation mark (!)
  • Percent sign (%)
  • Dollar sign ($)
  • Ampersand (&)
  • Single quotation mark (')
  • Plus sign (+)
  • Hyphen (-)
  • Equal sign (=)
  • At mark (@)
  • Underscore (_)
  • Tilde (~)
  • Period (.)
  • Comma (,)
 Property value of the J2EE server (webserver.dbsfo.exclude.extensions) --
<eadssfo>

Chapter 7 in the Expansion Guide		 Zero or once Sets up the EADs session failover functionality. -- None --
<enabled> Zero or once Specifies whether to enable the EADs session failover functionality. You can specify the following character strings:
  • true
  • false
 Property value of the J2EE server (webserver.eadssfo.enabled) --
<application-id> Zero or once Sets up the application identifier. You can use the alphanumeric characters and underscores (_).
You can specify up to 128 characters.		 Create from the context root name of applications. --
<exclude-url-patterns> Zero or once Specifies a URL pattern (specifies for a complete match, prefix match, and identifier match) for controlling the EADs session failover functionality.
If the specified URL pattern and the request URL are in conformity, the EADs session failover functionality is disabled with the corresponding request.
Note that for requesting multiple URL patterns, use a semicolon (;) as a demarcator, and then specify.
  • For specifying a complete match and prefix match, specify the normalized URI that starts with a slash (/).
  • For specifying an identifier match, specify an identifier that starts with (*.).
 Property value of the J2EE server (webserver.eadssfo.exclude.url_patterns) --
<session-read-only-url-patterns> Zero or once Specifies a URL pattern for read-only requests for HTTP sessions of the EADs session failover functionality.
If the specified URL pattern and request URL are in conformity, the corresponding request becomes the read-only request for HTTP sessions.
Note that for requesting multiple URL patterns, use a semicolon (;) as a demarcator, and then specify.
  • For specifying complete match and prefix match, specify the normalized URI that starts from a slash (/).
  • For specifying identifier match, specify an identifier that starts from (*.).
 Property value of the J2EE server (webserver.eadssfo.session_read_only.url_patterns) --
<start-notify-error> Zero or once Specifies whether to interrupt the start processing of a J2EE application after reporting the error, when an error occurs during the initialization of a Servlet or JSP in which the startup load is specified when the J2EE application is started, and during the parsing of taglib.
When a new J2EE application is created in Application Server 06-00 or later versions, the default display value is true, and for other J2EE applications, the default value is false.		 You can specify the following character strings:
  • true
  • false
 true --
<start-order> Zero or once 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. 10 --
<session-config> Zero or once Defines the session parameters of Web applications. -- None --
<cookie-config> Zero or once Specifies HTTP Cookie that shows the session ID of the HTTP session created with Web applications. -- None --
<name> Zero or once Specifies the name of HTTP Cookie that shows the session ID of the HTTP session created with Web applications. You can use the alphanumeric characters (0 to 9, A to Z, and a to z) and the following special characters:
Exclamation mark (!), dollar sign ($), percentage sign (%), ampersand (&), single quotation mark ('), asterisk (*), plus sign (+), hyphen (-), period (.), caret (^), underscore (_), grave accent mark (`), vertical bar (|), and tilde (~)
However, you cannot specify dollar sign ($) at the beginning of the name.		 JSESSIONID --
<http-only> Zero or once Specifies whether the HttpOnly attribute is to be added or not in an HTTP Cookie that shows the session ID of the HTTP session created with Web applications. You can specify the following characters:
  • true
  • false
 false --
<tracking-mode> Zero or more Specifies the tracking mode. You can specify the following characters:
  • COOKIE
  • URL
 None --
<filter> Zero or more times Defines the Filter.
You cannot specify this tag when web.xml is not included.		 -- None --
<filter-name> Once Key for identifying the Filter.
Specifies the value set for <web-app>-<filter>-<filter-name> in the web.xml file.		 There are no limitations for the input value. None D
<method-observation-timeout> Once Specifies the timeout value (seconds) for monitoring the doFilter method of the filter invoked by extending a request.
When you specify 0, a timeout does not occur. 		An integer value from 0 to 86400. 0 --
<servlet> Zero or more times Defines the Servlet.
You cannot specify this tag, when web.xml is not included. 		-- None --
<servlet-name> Once Key for identifying the Servlet.
Specifies the value set for <web-app>-<servlet>-<servlet-name> in the web.xml file. 		There are no limitations for the input value. None D
<run-as> Zero or once Defines the runtime identity. -- None --
<user-name> Once Specifies the user name. There are no limitations for the input value. None --
<method-observation-timeout> Zero or once Specifies the timeout value (seconds) for monitoring the service method of the servlet or the _jspService method of the JSP invoked by extending a request.
When you specify 0, a timeout does not occur.		 An integer value from 0 to 86400. 0 --
<rar> Zero or more times Defines the information concerning rar. -- None --
<module-name>
Once
Key for identifying the resource adapter.
The set value is specified according to the following conditions:

For an application that includes application.xml
  • Common to the archive format and exploded archive format
    Specifies the character string specified in <application>-<module>-<connector> in the application.xml.

For an application that does not include application.xml
  • Archive format (cjimportapp command (-f/-d))
    Specifies the location of the RAR file within the J2EE application using the relative path from the EAR root.
  • Exploded archive format (cjimportapp command (-a))
    Specifies the location of the RAR file within the application directory using the relative path from the application directory.
 There are no limitations for the input value.
None
K
<resourceadapter> Zero or once Defines the information about the resource adapter. -- None --
<outbound-resourceadapter> Zero or once Defines the resource adapter in the outbound direction. -- None --
<connection-definition> One or more times Defines the connection interface class.
Supplement
  • Lower tag <connector-property>
    <property-value> is mentioned in each property because the range of the set value is different for each <property-name>.
    When multiple <property> tags are specified, and when the set value of <property-name> is the same, the tags are merged into one. In such cases, a warning message (KDJE42377-W) is output, and the value of <property-value> of the <property> tag defined first is enabled.
-- None --
<connectionfactory-interface> Once Specifies the class name of the ConnectionFactory interface supported by the resource. There are no limitations for the input value. None D
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the MaxPoolSize property. You can specify the following character string:
  • MaxPoolSize
 None --
<property-value> Once Specifies the maximum value of the pool as the property value. An integer value of -1 (infinite) or from 0 to 2147483647. 10 --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the MinPoolSize property. You can specify the following character string:
  • MinPoolSize
 None --
<property-value> Once Specifies the minimum value of the pool as the property value. Specify an integer value from 0 to 2147483647. 10 --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the LogEnabled property. You can specify the following character string:
  • LogEnabled
 None --
<property-value> Once Specifies the requirements for the log output by LogWriter, as the property value. You can specify the following character strings:
  • true
  • false
 true --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the User property. You can specify the following character string:
  • User
 None --
<property-value> Once Specifies the user name as the property value. There are no limitations for the input value. None --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the Password property. You can specify the following character string:
  • Password
 None --
<property-value> Once Specifies the password as the property value. There are no limitations for the input value. None --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the ValidationType property. You can specify the following character string:
  • ValidationType
 None --
<property-value> Once Specifies the connection check trigger as the property value. You can specify the following values:
  • 0: Connection check functionality OFF
  • 1: Connection is checked when the connection is acquired
  • 2: Connection is checked at a fixed interval
 1 --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the ValidationInterval property. You can specify the following character string:
  • ValidationInterval
 None --
<property-value> Once Specifies the connection check interval (seconds) as the property value. Specify an integer value from 1 to 2147483647. 3600 --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the RetryCount property. You can specify the following character string:
  • RetryCount
 None --
<property-value> Once Specifies the connection retry count as the property value. Specify an integer value from 0 to 2147483647. 0 --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the RetryInterval property. You can specify the following character string:
  • RetryInterval
 None --
<property-value> Once Specifies the connection retry interval (seconds) as the property value. Specify an integer value from 1 to 2147483647. 10 --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the ConnectionTimeout property. You can specify the following character string:
  • ConnectionTimeout
 None --
<property-value> Once Specifies the timeout value (seconds) until the release of a connection, as the property value. Specify an integer value from 0 to 2147483647. 0 --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the ConnectionPoolAdjustmentInterval property. You can specify the following character string:
  • ConnectionPoolAdjustmentInterval
 None --
<property-value> Once Specifies the soft landing operation adjustment interval (seconds) of the connection count, as the property value. Specify an integer value from 0 to 2147483647. 600 --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the SweeperInterval property. You can specify the following character string:
  • SweeperInterval
 None --
<property-value> Once Specifies the connection sweeper operation time interval (seconds) as the property value. Specify an integer value from 0 to 2147483647. 0 --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the RequestQueueEnable property. You can specify the following character string:
  • RequestQueueEnable
 None --
<property-value> Once Specifies the requirement of a connection pending queue for connection depletion, as the property value. You can specify the following character strings:
  • true
  • false
 true --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the RequestQueueTimeout property. You can specify the following character string:
  • RequestQueueTimeout
 None --
<property-value> Once Specifies the maximum value (seconds) for which the connection pending queue can be retained during connection depletion, as the property value. Specify an integer value from 0 to 2147483647. 30 --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the WatchEnabled property. You can specify the following character string:
  • WatchEnabled
 None --
<property-value> Once Specifies whether to enable the output of an alert for connection pool monitoring, as the property value. You can specify the following character strings:
  • true
  • false
 true --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the WatchInterval property. You can specify the following character string:
  • WatchInterval
 None --
<property-value> Once Specifies the connection pool monitoring interval (seconds) as the property value. Specify an integer value from 1 to 2147483647. 30 --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the WatchThreshold property. You can specify the following character string:
  • WatchThreshold
 None --
<property-value> Once Specifies the threshold value (%) used for monitoring the connection pool usage status, as the property value. An integer value from 1 to 100. 80 --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the WatchWriteFileEnabled property. You can specify the following character string:
  • WatchWriteFileEnabled
 None --
<property-value> Once Specifies whether to output the connection pool monitoring results to a file, as the property value. You can specify the following character strings:
  • true
  • false
 true --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the Warmup property. You can specify the following character string:
  • Warmup
 None --
<property-value> Once Specifies whether to enable the warming up functionality of the connection pool, as the property value. You can specify the following character strings:
  • true
  • false
 true --
<connector-property> Zero or more times Sets up the information unique to the connection interface class. -- None --
<property-name> Once Specifies the NetworkFailureTimeout property. You can specify the following character string:
  • NetworkFailureTimeout
 None --
<property-value> Once Specifies whether to enable the timeout of the network failure detection functionality, as the property value. You can specify the following character strings:
  • true
  • false
 true --
<resource-external-property> Zero or more times Defines the resource. -- None --
<optional-name> Once Specifies the optional name of the resource. 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 (.), 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 only includes a slash (/) or 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 --
<res-auth> Zero or once Specifies whether to perform authentication for using a resource in the application or to entrust authentication to the container. You can specify the following character strings:
  • Application
  • Container
 Container --
<res-sharing-scope> Zero or once Specifies whether to enable the sharing of a resource connection. You can specify the following character strings:
  • Shareable
  • Unshareable
 Shareable --
<adminobject> Zero or more times Defines the administered objects provided by the resource adapter.
You must set up as many tags as the number of <adminobject> tags in the DD and in the same order (if the same number of tags is not set up, you specify an empty tag <adminobject/>).
If it is not required to set up <adminobject-name> in all the <adminobject> tags, you can omit the tag.		 -- None --
<adminobject-name>
Once
Specifies the administered object name. This name must be unique within a resource adapter.
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:
  • A name containing a period (.) at the beginning or at the end
  • A name containing only a period (.)
  • A name containing continuous underscores (_)
 None
--
<resourceadapter-property> Zero or more times Defines a resource adapter corresponding to the Connector 1.5 specifications. -- None --
<property-name> Once Specifies the MaxTPoolSize property. You can specify the following character string:
  • MaxTPoolSize
 None --
<property-value> Once Specifies the maximum number of threads executed concurrently in a thread pool, as the property value. Specify an integer value from 1 to 2147483647. 10 --
<resourceadapter-property> Zero or more times Defines a resource adapter corresponding to the Connector 1.5 specifications. -- None --
<property-name> Once Specifies the MinTPoolSize property. You can specify the following character string:
  • MinTPoolSize
 None --
<property-value> Once Specifies the minimum number of threads that exist in the thread pool, as the property value. An integer value from 0 to 1024. 0 --
<resourceadapter-property> Zero or more times Defines a resource adapter corresponding to the Connector 1.5 specifications. -- None --
<property-name> Once Specifies the TpoolKeepalive property. You can specify the following character string:
  • TPoolKeepalive
 None --
<property-value> Once Specifies the timeout value (seconds) until the release of threads of the thread pool, as the property value. Specify an integer value from 1 to 2147483647. 300 --

Legend:
--: Not applicable.

#
If an string other than the allowed value is used, specify the queue name.

[Contents][Back][Next]

[Trademarks]

All Rights Reserved. Copyright (C) 2012, 2013, Hitachi, Ltd.