3.7.1 Specifications of the HITACHI WAR Property file

The HITACHI WAR Property file has the following DOCTYPE declaration:

<!DOCTYPE hitachi-war-property PUBLIC '-//Hitachi, Ltd.//DTD War Property 9.0//EN' 'file:///Cosminexus-installation-directory/CC/admin/dtds/hitachi-war-property_9_0.dtd'>

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

Organization of this subsection
(1) When web.xml is included
(2) When web.xml is not included (Servlet 2.5 or later versions)

(1) When web.xml is included

Tag nameOccurrence patternExplanation
<hitachi-war-property>OnceSpecifies the root tag.

<description>#1Zero or more times#1Describes the WAR.

<display-name>#1One or more times#1Specifies the WAR display name.
Make sure you specify display-name with xml:lang property as en. Even if the display name of the corresponding resource is specified using the command argument, specify display-name with xml:lang as en.
1[Figure] character-string-length
For tags where xml:lang property is en, you can use alphanumeric characters (0 to 9, A to Z, a to z), and the following special characters:
Plus sign (+),hyphen (-), period (.), caret (^), and underscore (_)
For tags where xml:lang property is not en, the characters to be used are not restricted.

<icon>#1Zero or more times#1Defines the Web application icons displayed on the Deploy tool.

<small-icon>Zero or onceSpecifies the file name for small icons (16[Figure] 16).

<large-icon>Zero or onceSpecifies the file name for large icons (32[Figure] 32).

<distributable>Zero or onceSpecified when WAR is programmed so that it can be deployed on the distributed servlet container. Note that this tag does not have a value.

<context-param>Zero or more timesDefines the context initialization parameter.

<description>#1Zero or more times#1Describes Context-param.

<param-name>OnceSpecifies the context initialization parameter name.

<param-value>OnceSpecifies the context initialization parameter value.

<filter-mapping>Zero or more timesDefines the Web application filter mapping.

<filter-name>OnceSpecifies the name of the filter that performs the mapping.

<url-pattern>
2.9 in the Web Container Functionality Guide
One or more timesSpecifies the URL of the servlet that performs the mapping.
For a WAR of the Servlet 2.4 or earlier versions, you can specify this tag once. Specify either <url-pattern> or <servlet-name>.
However, for a Servlet 2.5 WAR, you can specify both the <url-pattern> and <servlet-name>.

<servlet-name>One or more timesSpecifies the name of the servlet that performs the mapping.
You can specify an asterisk (*) that implies all the servlets. For a WAR of the Servlet 2.4 or earlier versions, you can specify this tag once. Specify either <url-pattern> or <servlet-name>.
However, for a Servlet 2.5 WAR, you can specify both the <url-pattern> and <servlet-name>.

<dispatcher>Zero, or five times or lessSpecifies the applicable conditions for the filter.
Specify one of the following values:
FORWARD
Applies the filter only when processing RequestDispatcher.forward ( ).
INCLUDE
Applies the filter only when processing RequestDispatcher.include( ).
REQUEST
Applies the filter only when accessing from a normal client.
ASYNC
Applies the filter only when the request is dispatched from AsyncContext. In 09-00, ASYNC is ignored even if specified.
ERROR
Applies the filter only in the case of exception handling.
You cannot specify this tag for the WARs of Servlet 2.3 or earlier versions.

<listener>Zero or more timesDefines the listener.

<description>#1Zero or more timesDescribes the Web application listener Bean.
You cannot specify this tag for the WARs of Servlet 2.3 or earlier versions.

<display-name>#1Zero or more timesSpecifies the Web application listener Bean name displayed on the GUI tool.
The specified character string need not be unique.
You cannot specify this tag for the WARs of Servlet 2.3 or earlier versions.

<icon>#1Zero or more times#1Defines the Web application listener Bean icons displayed on the GUI tool.
You cannot specify this tag for the WARs of Servlet 2.3 or earlier versions.

<small-icon>Zero or onceSpecifies the image file name for the small icons of the Web application listener Bean.
Specify the location of the image file in the WAR file as a relative path from the root. The size of the image file is 16 [Figure]16. The image file format is either a JPEG or GIF file.

<large-icon>Zero or onceSpecifies the image file name for the large icons of the Web application listener Bean.
Specify the location of the image file in the WAR file as a relative path from the root. The size of the image file is 32 [Figure]32. The image file format is either a JPEG or GIF file.

<listener-class>OnceSpecifies the listener class name that is set up.

<session-config>Zero or more timesDefines the session.
You cannot specify this tag multiple times.

<session-timeout>Zero or onceSpecifies the default session timeout interval (minutes).
You can specify -1 (no timeout), 0 (equal to -1), or 1[Figure] session-timeout[Figure] 35791394​. The default value is 30.

<mime-mapping>Zero or more timesDefines the MIME type mapping. #3

<extension>OnceSpecifies the file extension. #3

<mime-type>OnceSpecifies the MIME type. #3

<welcome-file-list>Zero or more times#1Defines the welcome file.

<welcome-file>One or more timesSpecifies the welcome file name.

<error-page>Zero or more timesDefines the error page.

<error-code>#4Either one once or neitherSpecifies the HTTP error code.
This tag is specified when mapping an HTTP error code and error page resource.
Specify a value so that -2147483648​[Figure] error-code[Figure] 2147483647​. Specify either <error-code> or <exception-type>, or neither of them.

<exception-type>#4Either one once or neitherSpecifies the exception class name (fully qualified name).
This tag is specified when mapping an exception type and error page resource.
Specify either <error-code> or <exception-type>, or neither of them.

<location>OnceSpecifies a value beginning with a forward slash (/).

<jsp-config>Zero or more timesDefines the JSPs in the Web application.
You cannot specify this tag multiple times. Also, you cannot specify this tag for the WARs of Servlet 2.3 or earlier versions.

<taglib>Zero or more timesDefines the tag library in the Servlet 2.4 or later versions.
In the Servlet 2.3 or earlier versions, you define the tag library in <taglib> in the <hitachi-war-property> tag.

<taglib-uri>OnceSpecifies the value set up in the uri property of the taglib directive of a JSP program.

<taglib-location>OnceSpecifies the deployment location of a tld file (relative path from the context root).

<jsp-property-group>Zero or more timesSpecifies the individual settings for JSP programs conforming to the specified URL pattern.

<description>#1Zero or more timesDescribes the Web application listener Bean.

<display-name>#1Zero or more timesSpecifies the JSP property group name displayed on the GUI tool.
The specified character string need not be unique.

<icon>#1Zero or more timesDefines the JSP property group icons displayed on the GUI tool.

<small-icon>Zero or onceSpecifies the image file name for the small icons of the JSP property group.
Specify the location of the image file in the WAR file as a relative path from the root. The size of the image file is 16 [Figure]16. The image file format is either a JPEG or GIF file.

<large-icon>Zero or onceSpecifies the image file name for the large icons of the JSP property group.
Specify the location of the image file in the WAR file as a relative path from the root. The size of the image file is 32 [Figure]32. The image file format is either a JPEG or GIF file.

<url-pattern>One or more timesSpecifies the URL pattern where parameters are applied.

<el-ignored>Zero or onceSpecifies whether to ignore EL (expression language).
You can specify the following character strings:
  • true (when you want to ignore EL)
  • false (when you do not want to ignore EL)

<page-encoding>Zero or onceSpecifies the page-encoding name.

<scripting-invalid>Zero or onceSpecifies whether to invalidate the scripting element.

<is-xml>Zero or onceSpecifies whether the WAR is coded in the XML syntax.

<include-prelude>Zero or more timesSpecifies the file path to be included as the header of each page (relative path from the context root).

<include-coda>Zero or more timesSpecifies the file path to be included as the footer of each page (relative path from the context root).

<deferred-syntax-allowed-as-literal>Zero or onceDefines whether the existence of the string #{ will be considered as an error at locations where EL cannot be used. The default value is false.
true
The string will be used as literal.
false
The string will not be used as literal.
You cannot specify this tag for WARs in Servlet 2.4 or earlier versions.

<trim-directive-whitespaces>Zero or onceDefines whether extra spaces will be output from JSPs. The default value is false.
true
Extra spaces will be deleted.
false
Extra spaces will not be deleted.
You cannot specify this tag for WARs in Servlet 2.4 or earlier versions.

<taglib>Zero or more timesDefines the tag library in the Servlet 2.3 or earlier versions.
In the Servlet 2.4 or later versions, you define the tag library in <taglib> under the <jsp-config> tag.

<taglib-uri>OnceSpecifies the tag library URI (relative URI for web.xml).

<taglib-location>OnceSpecifies the location of the tag library descriptor file (TLD) (relative position from the root of the Web application).

<security-constraint>Zero or more timesDefines the security constraints.

<display-name>#1Zero or more times#1Specifies the security constraint name.

<web-resource-collection>One or more timesDefines the Web resource collection.

<description>#1Zero or more times#1Describes web-resource-collection.

<web-resource-name>OnceSpecifies the Web resource collection name.

<url-pattern>One or more timesSpecifies the Web resource URL.
For a WAR of the Servlet 2.3 or earlier versions, you can specify this tag zero or more times.

<http-method>One or more timesSpecifies the HTTP methods to which the security constraints will be applied.
You can specify the following character strings in this tag for a WAR of the Servlet 2.4 or earlier versions:
  • DELETE
  • GET
  • HEAD
  • OPTIONS
  • POST
  • PUT
  • TRACE
For a WAR of the Servlet 2.5 or later versions, you can specify alphanumeric characters and special characters (!#$%&'*+-.^_`|~) one or more times.

<http-method-omission>One or more timesSpecifies the HTTP methods to which the security constraints will not be applied.
For a WAR of the Servlet 3.0 or later versions, you can specify alphanumeric characters and special characters (!#$%&'*+-.^_`|~) one or more times.

<auth-constraint>Zero or onceDefines the role that will be allowed to access the Web resource collection.

<description>#1Zero or more times#1Describes auth-constraint.

<role-name>Zero or more timesSpecifies the role that will be allowed to access the Web resource collection.

<user-data-constraint>Zero or onceDefines how to protect the data communication between the client and the container.

<description>#1Zero or more times#1Describes user-data-constraint.

<transport-guarantee>OnceDefines how to protect the data communication between the client and the container.
You can specify the following character strings:
NONE
The application does not need transport guarantee.
INTEGRAL
The application requests for data communication using a method so that changes are not added while the communication data is being transmitted.
CONFIDENTIAL
The application requests for data communication using a method so that other entities cannot view the transmission contents.

<original-name>OnceSaves and stores the display-name settings of security-constraint when properties are output. #5
You cannot change the settings of this tag and delete the tag.

<login-config>Zero or more timesDefines the login method.
You cannot specify this tag multiple times.

<auth-method>Zero or onceSpecifies the authentication method.
You can specify the following character strings:
  • BASIC
  • FORM
  • CLIENT-CERT
The default value is BASIC (DIGEST is not supported).

<realm-name>Zero or onceSpecifies the realm name.
When BASIC is specified in auth-method
This tag is mandatory.
When a value other than BASIC is specified in auth-method
This tag is ignored in the cjsetappprop and cjsetresprop commands.

<form-login-config>Zero or once
When FORM is specified in auth-method
This tag is mandatory.
When a value other than FORM is specified in auth-method
This tag is ignored in the cjsetappprop and cjsetresprop commands.

<form-login-page>OnceSpecifies the page used for log in. The value that you specify must begin with a forward slash (/).

<form-error-page>OnceSpecifies the error page displayed when log in fails. The value that you specify must begin with a forward slash (/).

<security-role>Zero or more timesDefines a security role. #6

<description>#1Zero or more times#1Describes security-role. #6

<role-name>OnceSpecifies the role name. #6

<linked-to>Zero or onceSpecifies the role name defined with the cjaddsec command.
This tag is ignored when used with the cjsetresprop command.

<env-entry>Zero or more timesDefines the environment entry. #5

<description>#1Zero or more times#1Describes the environment entry. #5

<env-entry-name>OnceSpecifies the environment entry name. #5

<env-entry-type>Zero or onceSpecifies the environment entry data type. #6
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>OnceSpecifies the environment entry value. #5
Specify a value appropriate to the type specified in env-entry-type. You cannot specify a null character when a value other than java.lang.String is specified in env-entry-type.

<injection-target>Zero or more timesSpecifies the Dependency Injection settings. #6

<injection-target-class>OnceSpecifies the injection target class name. #5
Displayed from the package when the package is defined.

<injection-target-name>OnceSpecifies the injection target identifier of the specified class. #5

<ejb-ref>Zero or more timesDefines the reference information for the Enterprise Bean with a remote interface. #6

<description>#1Zero or more times#1Describes ejb-ref. #6

<ejb-ref-name>OnceSpecifies the ejb-ref name. #6

<ejb-ref-type>Zero or onceSpecifies the Enterprise Bean to be linked to. #6
You can specify the following character strings:
  • Entity
  • Session

<home>Zero or onceSpecifies the name of the Home interface class to be linked to. #6

<remote>Zero or onceSpecifies the name of the Component interface class to be linked to. #6

<ejb-link>Zero or onceSpecifies the ejb-name to be linked to.#6
When setting the link destination with the naming service switching functionality, use the following format:
corbaname::Namespace-host-name:Namespace-port-number#JNDI-name-of-EJB-Home-object-reference

<injection-target>Zero or more timesSpecifies the Dependency Injection settings. #6

<injection-target-class>OnceSpecifies the injection target class name. #5
Displayed from the package when the package is defined.

<injection-target-name>OnceSpecifies the injection target identifier of the specified class. #5

<ejb-local-ref>Zero or more timesDefines the reference information for the Enterprise Bean with a local interface. #6

<description>#1Zero or more times#1Describes ejb-local-ref. #6

<ejb-ref-name>OnceSpecifies the ejb-local-ref name. #6

<ejb-ref-type>OnceSpecifies the Enterprise Bean type to be linked to. #6
You can specify the following character strings:
  • Entity
  • Session

<local-home>OnceSpecifies the Local Home interface name of the Enterprise Bean to be linked to. #6

<local>OnceSpecifies the Local Component interface name of the Enterprise Bean to be linked to. #6

<ejb-link>Zero or onceSpecifies the ejb-name to be linked to. #6

<injection-target>Zero or more timesSpecifies the Dependency Injection settings. #6

<injection-target-class>OnceSpecifies the injection target class name. #5
Displayed from the package when the package is defined.

<injection-target-name>OnceSpecifies the injection target identifier of the specified class. #5

<resource-ref>Zero or more timesDefines the resource reference.

<description>#1Zero or more times#1Describes resource-ref. #6

<res-ref-name>OnceSpecifies the resource-ref name. #6

<res-type>Zero or onceSpecifies the resource type. #6
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>Zero or onceSpecifies the authentication method. #6
You can specify the following character strings:
  • Application
  • Container
In the Servlet 2.5 or later versions, the default value is Container.

<res-sharing-scope>Zero or onceSpecifies whether to share the referenced resources. #6
You can specify the following character strings:
  • Shareable
  • Unshareable

<mapped-name>Zero or onceSpecifies the corresponding resource adapter display name or mail display name. #6
When you specify this tag at the same time as <linked-to> tag, the <linked-to> tag becomes valid.

<injection-target>Zero or more timesSpecifies the Dependency Injection settings. #6

<injection-target-class>OnceSpecifies the injection target class name. #5
Displayed from the package when the package is defined.

<injection-target-name>OnceSpecifies the injection target identifier of the specified class. #5

<linked-to>Zero or onceSpecifies the corresponding resource adapter display name, data source display name, or mail display name. #6
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 adapters of Connector 1.5 or later versions
Resource-adapter-display-name!connection-definition-identifier
The connection-definition-identifier is a value specified in the <connectionfactory-interface> tag in the ra.xml.
You cannot specify the member resource adapters of the cluster connection pool.
This tag is ignored in the cjsetresprop command.

<resource-env-ref>Zero or more timesDefines the resource environment variable. #6

<description>#1Zero or more times#1Describes resource-env-ref. #6

<resource-env-ref-name>OnceSpecifies the resource-env-ref name. #6

<resource-env-ref-type>Zero or onceSpecifies the class type of the resource environment variable value. #6
You can specify the following character strings:
  • javax.jms.Queue
  • javax.jms.Topic
  • javax.transaction.UserTransaction
  • javax.ejb.TimerService
  • javax.ejb.EJBContext
  • JavaBeans resource class name
The strings javax.transaction.UserTransaction, javax.ejb.TimerService, and javax.ejb.EJBContext are output only when annotations are used. However, you cannot set these values.
When you specify <linked-adminobject>, any class name is displayed.

<mapped-name>Zero or onceDisplays the corresponding queue#6 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.

<injection-target>Zero or more timesSpecifies the Dependency Injection settings. #6

<injection-target-class>OnceSpecifies the injection target class name. #5
Displayed from the package when the package is defined.

<injection-target-name>OnceSpecifies the injection target identifier of the specified class. #5

<linked-queue>Zero or onceSpecifies the corresponding data source display name or mail display name. #6
This tag is ignored when used in the cjsetresprop command.
The tag is valid only when javax.jms.Queue is specified in <resource-env-ref-type>.

<resource-adapter>OnceSpecifies the resource adapter display name. #6
You cannot specify the resource adapters conforming to Connector1.5 specifications.

<queue>OnceSpecifies the display name of the queue.#6

<linked-adminobject>Zero or onceSpecifies the administered object.
This tag is ignored in the cjsetresprop command.

<resourceadapter-name>OnceSpecifies the resource adapter display name.
You cannot specify the resource adapters conforming to Connector1.0 or earlier versions.

<adminobject-name>OnceSpecifies 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 (:), semi-colon (;), 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 onceSpecifies the display name of JavaBeans resource. #6
This tag is valid only when JavaBeans-resource-class-name is specified for <resource-env-ref-type>.
This tag is ignored when used in the cjsetresprop command.

<persistence-context-ref>Zero or more timesDescribes the settings of the persistence context.

<description>#1Zero or more times#2Describes the persistence context. #6

<persistence-context-ref-name>OnceSets up the name of the persistence context reference. The name is a JNDI name correlated to the java:comp/env context. #6

<persistence-unit-name>Zero or onceSets up the name of the persistence unit. #6

<persistence-context-type>Zero or onceSets up the transactional nature of the persistence context reference. You can specify the following strings: #6
  • Transaction
  • Extended

<persistence-property>Zero or more timesSets up properties of the container or persistence provider. #6

<name>OnceSets up the name of the property. #6

<value>OnceSets up the value of the property. #6

<injection-target>Zero or more timesDescribes the Dependency Injection settings. #6

<injection-target-class>OnceSpecifies the injection target class name. Specified from the package when the package is defined. #6

<injection-target-name>OnceSpecifies the injection target identifier of the specified class.

<persistence-unit-ref>Zero or more timesDescribes the settings for the persistence unit reference. #6

<description>Zero or more timesDescribes the persistence unit reference. #6

<persistence-unit-ref-name>OnceSets up the name of the persistence unit reference. The name is a JNDI name correlated to the java:comp/env context. #6

<persistence-unit-name>Zero or onceSets up the name of the persistence unit. #6

<injection-target>Zero or more timesDescribes the Dependency Injection settings. #6

<injection-target-class>OnceSpecifies the injection target class name. Specified from the package when the package is defined. #6

<injection-target-name>OnceSpecifies the injection target identifier of the specified class. #6

<post-construct>Zero or more timesDefines the post-construct method. #6

<lifecycle-callback-class>Zero or onceDescribes the name of the class that stores the post-construct method. If this tag is omitted, the specification of the <post-construct> tag is ignored. #6

<lifecycle-callback-method>OnceDescribes the post-construct method name. #6

<pre-destroy>Zero or more timesDefines the pre-destroy method. #6

<lifecycle-callback-class>Zero or onceDescribes name of the class that stores the pre-destroy method. If this tag is omitted, the specification of the <pre-destroy> tag is ignored. #6

<lifecycle-callback-method>OnceDescribes the pre-destroy method name. #6

<locale-encoding-mapping-list>Zero or more times#1Specifies the settings for mapping the locale to the encoding method.
You cannot specify this tag for the WARs of Servlet 2.3 or earlier versions.

<locale-encoding-mapping>One or more timesSpecifies the settings for mapping the locale to the encoding method.

<locale>OnceDescribes the locale.

<encoding>OnceDescribes the encoding method.

<runtime>Zero or once
When used in the cjsetappprop command
This tag is mandatory.
When used in the cjsetresprop command
This tag is ignored.

<context-root>OnceSpecifies the context root.
The characters that you can specify are those that can be used in URI (RFC3986). When specifying the root, you specify either a blank character string or a forward slash (/).

<thread-control>

2.17 in the Web Container Functionality Guide
Zero or onceSpecifies the settings for the thread control group.
This tag is ignored when used in the cjsetresprop command.

<thread-control-max-threads>OnceSpecifies the maximum number of concurrently executed threads for the Web applications.
Specify a value equal to at least the number of exclusive threads.
1 to 1024

<thread-control-exclusive-threads>OnceSpecifies the number of exclusive threads.
Specify a value not more than the maximum number of concurrently executed threads for the Web applications.
0 to 1024

<thread-control-queue-size>OnceSpecifies the pending queue size of the Web applications.
0 to 2147483647​

<thread-control-stats-monitor>OnceSpecifies the settings for monitoring the operation statistics.

<whole-waiting-request-count>OnceMonitors the whole pending request count of the Web applications.

<enabled>OnceSpecifies whether to enable the threshold value event for monitoring the whole pending request count of the Web applications.
You can specify the following character strings:
  • true (the threshold value event is enabled)
  • false (the threshold value event is disabled)
The default value is true.

<high-threshold>OnceSpecifies an integer from 1 to 100 (unit: %) as the high threshold value for the output of the threshold value event. The default value is 80.
However, the value must be equal to or greater than the value specified in the <low-threshold> tag.

<low-threshold>OnceSpecifies an integer from 0 to 99 (unit: %) as the low threshold value for the output of the threshold value event.
The default value is 0.
However, the value must be equal to or less than the value specified in the <high-threshold> tag.

<waiting-request-count>OnceMonitors the number of pending requests of the Web applications.

<enabled>OnceSpecifies 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 (the threshold value event is enabled)
  • false (the threshold value event is disabled)
The default value is true.

<high-threshold>OnceSpecifies an integer from 1 to 100 (unit: %) as the high threshold value for the output of the threshold value event. The default value is 80.
However, the value must be equal to or greater than the value specified in the <low-threshold> tag.

<low-threshold>OnceSpecifies an integer from 0 to 99 (unit: %) as the low threshold value for the output of the threshold value event.
The default value is 0.
However, the value must be equal to or less than the value specified in the <high-threshold> tag.

<resource-watcher>OnceSpecifies the properties related to the monitoring of the number of saved request pending queues of the Web applications.

<watcher-threshold>OnceSpecifies the threshold value to output an alert message.
Specify an integer value from 1 to 100 (unit: %). The default value is 80.

<watcher-interval>OnceSpecifies the monitoring interval.
Specify an integer value from 1 to 2147483647​ (unit: seconds). Default is 30.

<watcher-enabled>OnceSpecifies 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 (Monitoring is enabled)
  • false (Monitoring is disabled)
The default value is true. However, monitoring is disabled when 0 is specified in <thread-control-queue-size>.

<watcher-writefile-enabled>OnceSpecifies whether to output the resource usage status to a file.
You can specify the following character strings:
  • true (Output to a file)
  • false (Not output to a file)
The default value is true.

<urlgroup-thread-control>

2.18 in the Web Container Functionality Guide
Zero or more timesSpecifies the control of the number of concurrently executed threads for the URL groups.

<urlgroup-thread-control-name>OnceSpecifies the definition name for controlling the concurrently executed thread count of the URL groups.
Specify a character string unique in the Web application as the definition name for controlling the concurrently executed thread count of the URL groups. You can use alphanumeric characters (0 to 9, A to Z, a to z), hyphen (-), and underscore (_). Specify the length of the character string as 1 [Figure]character-string-length[Figure] 64.

<urlgroup-thread-control-max-threads>OnceSpecifies the maximum number of concurrently executed threads for the URL groups.
Specify an integer value from 1 to thread-control-max-threads.

<urlgroup-thread-control-exclusive-threads>OnceSpecifies the number of exclusive threads for the URL groups.
The value that you can specify ranges from 0 to urlgroup-thread-control-max-threads and thread-control-exclusive-threads value or less. Note that, when <urlgroup-thread-control> is defined, the following range of settings need to be fulfilled:
  • If thread-control-max-threads[Figure] thread-control-exclusive-threads, then thread-control-exclusive-threads[Figure] total urlgroup-thread-control-exclusive-threads.
  • If thread-control-max-threads = thread-control-exclusive-threads, then thread-control-exclusive-threads > total urlgroup-thread-control-exclusive-threads.

<urlgroup-thread-control-queue-size>OnceSpecifies the pending queue size for the URL groups.
You can specify an integer value from 0 to 2147483647​.

<urlgroup-thread-control-mapping>Zero or more timesSpecifies the mapping information of the URL to be controlled.
When omitting, operate in the status in which no URL is to be controlled.

<url-pattern>OnceSpecifies the URL pattern to be controlled.
You cannot specify the same URL pattern in one Web application. Some examples of specification are as follows:
  • /soda/grape/*
  • /foo/*
  • /contents
  • *.foo

<stats-monitor>OnceSpecifies the operation statistics settings.

<waiting-request-count>OnceMonitors the pending requests of the URL groups.

<enabled>OnceSpecifies whether to enable the threshold value event for monitoring the pending requests of the URL groups.
You can specify the following character strings:
  • true (the threshold value event is enabled)
  • false (the threshold value event is disabled)

<high-threshold>OnceSpecifies an integer from 1 to 100 (unit: %) as the high threshold value for the output of the threshold value event.
Make sure you specify a value that is equal to or greater than <low-threshold>.

<low-threshold>OnceSpecifies an integer from 0 to 99 (unit: %) as the low threshold value for the output of the threshold value event.
Make sure you specify a value that is equal to or less than <high-threshold>.

<http-request>Zero or once--

<encoding>Zero or onceSpecifies the default encoding used to decode a request body and query.
Specify a character encoding that JavaVM supports.#7
By default, this tag is not specified.

<http-response>Zero or once--

<encoding>Zero or onceSpecifies the default encoding used to encode a response body.
Specify a character encoding that JavaVM supports.#7
By default, this tag is not specified.

<jsp>Zero or once--

<page-encoding>Zero or onceSpecifies the default encoding used to read a JSP file.
Specify a character encoding that JavaVM supports.#7
By default, this tag is not specified.

<http-session>Zero or once--

<http-session-max-number>OnceSpecifies the maximum number of usable HttpSessions.
You can specify an integer value from -1 to 2147483647​. When -1 is specified, the number of usable HttpSessions is infinite. The default value is -1.

<resource-watcher>OnceSpecifies the properties related to the monitoring of the number of HttpSessions.

<watcher-threshold>OnceSpecifies the threshold value to output an alert message.
You can specify an integer value from 1 to 100 (unit: %). The default value is 80.

<watcher-interval>OnceSpecifies the monitoring interval.
You can specify an integer value from 1 to 2147483647​ (unit: seconds). The default value is 30.

<watcher-enabled>OnceSpecifies whether to enable the monitoring of the number of HttpSessions.
You can specify the following character strings:
  • true (Monitoring is enabled)
  • false (Monitoring is disabled)
The default value is true. However, if you specify 0 in http-session-max-number, monitoring is disabled.

<watcher-writefile-enabled>OnceSpecifies whether to output the resource usage status to a file. You can specify the following character strings:
  • true (Output to a file)
  • false (Not output to a file)
The default value is true.

<dbsfo>

Chapter 6 in the Expansion Guide
Zero or onceSets up the database session failover functionality.

<enabled>Zero or onceSpecifies whether to enable the database session failover functionality.
You can specify the following character strings:
  • true (Enable)
  • false (Disable)

<application-id>Zero or onceSets up the application identifier. You can use only alphanumeric characters (0 to 9, A to Z, a to z) and underscores (_). You can specify up to 16 characters.

<attribute-data-size-max>Zero or onceSets up the maximum size for the property information of an HTTP session that can be included in the global session information. The specifiable range is an integer value from 128 to 10485760​ (unit: bytes).

<exclude-extensions>Zero or onceSets up an extension to control the database session failover functionality.
If the URL path is the same as the specified extension, the database session failover functionality is disabled in the corresponding request. The comparison of the specified extension and URL is not case sensitive.
If you do not want to set up the extension that controls the database session failover functionality, specify a blank character string.
Specify up to 512 of the following characters:
  • Alphanumeric characters
  • Parentheses ((), ())
  • Exclamation mark (!)
  • Percent sign (%)
  • Dollar sign ($)
  • Ampersand (&)
  • Single quotation mark (')
  • Plus sign (+)
  • Hyphen (-)
  • Equal sign (=)
  • at mark (@)
  • Underscore (_)
  • Tilde (~)
  • Period (.)
  • Comma (,)
When specifying multiple extensions, demarcate with commas (,).

<start-notify-error>Zero or onceSpecifies whether to report an error when starting a J2EE application.
You specify whether to report the error and suspend application startup when a J2EE application is being started and an error occurs during the initialization of the servlets and JSPs for which load-on-startup is specified and during the parsing of taglib.
You can specify the following character strings:
  • true (Error is reported)
  • false (Error is not reported)
The default value is true.

<start-order>Zero or onceSpecifies the order used when 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.
0 [Figure]start-order[Figure] 2147483647​
#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 the WARs of Servlet 2.3 or earlier versions.
#3
For details on the default mapping values of the extensions specified in the mime-mapping tag and the MIME types, see Appendix B.1 Mapping the extensions and MIME types in the manual uCosminexus Application Server Definition Reference Guide.
#4
Specify either error-code or exception-type.
#5
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.
#6
Do not change the values for the annotation settings.
#7
The characters that you can specify as the default character encoding are the character encoding supported by JavaVM. For details on the character encoding that JavaVM supports, see the description related to the supported encoding in the JDK documentation. Also, the character strings that you can specify are the character encoding described in the canonical names for java.nio API and canonical names for java.lang API, and their optional names.

(2) When web.xml is not included (Servlet 2.5 or later versions)

Tag nameOccurrence patternExplanation
<hitachi-war-property>OnceSpecifies the root tag.

<description>#1Zero or more times#1Describes the WAR. #5

<display-name>#1One or more times#1Specifies the WAR display name. #5
Make sure you specify display-name with xml:lang property as en. Even if the display name of the corresponding resource is specified using the command argument, specify display-name with xml:lang as en.
1[Figure] character-string-length
For tags where xml:lang property is en, you can use alphanumeric characters (0 to 9, A to Z, a to z), and the following special characters:
Plus sign (+), hyphen (-), period (.), caret (^), and underscore (_)
For tags where xml:lang property is not en, the characters to be used are not restricted.

<icon>#1Zero or more times#1Defines the Web application icons displayed on the Deploy tool. #5

<small-icon>Zero or onceSpecifies the file name for small icons (16[Figure] 16).

<large-icon>Zero or onceSpecifies the file name for large icons (32[Figure] 32).

<security-role>Zero or more timesDefines a security role.

<description>#1Zero or more times#1Describes security-role. #5

<role-name>OnceSpecifies the role name. #5

<linked-to>Zero or onceSpecifies the role name defined with the cjaddsec command.
This tag is ignored when used in the cjsetresprop command.

<env-entry>Zero or onceDefines the environment entry. #5

<description>#1Zero or more times#1Describes the environment entry. #5

<env-entry-name>OnceSpecifies the environment entry name. #5

<env-entry-type>OnceSpecifies the environment entry data type. #5
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>OnceSpecifies the environment entry value. #5
Specify a value appropriate to the type specified in env-entry-type. You cannot specify a null character when a value other than java.lang.String is specified in env-entry-type.

<injection-target>Zero or more timesSpecifies the Dependency Injection settings. #5

<injection-target-class>OnceSpecifies the injection target class name. #5
Displayed from the package when the package is defined.

<injection-target-name>OnceSpecifies the injection target identifier of the specified class. #5

<ejb-ref>Zero or more timesDefines the reference information for the Enterprise Bean with a remote interface. #5

<description>#1Zero or more times#1Describes ejb-ref. #6

<ejb-ref-name>OnceSpecifies the ejb-ref name. #6

<ejb-ref-type>Zero or onceSpecifies the Enterprise Bean type to be linked to. #6
You can specify the following character strings:
  • Entity
  • Session

<home>Zero or onceSpecifies the name of the Home interface class to be linked to. #6

<remote>Zero or onceSpecifies the name of the Component interface class to be linked to. #6

<ejb-link>Zero or onceSpecifies the ejb-name to be linked to. #6
When setting the link destination with the naming service switching functionality, use the following format:
corbaname::Namespace-host-name:Namespace-port-number#JNDI-name-of-EJB-Home-object-reference

<injection-target>Zero or more timesSpecifies the Dependency Injection settings. #5

<injection-target-class>OnceSpecifies the injection target class name. #5
Displayed from the package when the package is defined.

<injection-target-name>OnceSpecifies the injection target identifier of the specified class. #5

<ejb-local-ref>Zero or more timesDefines the reference information for the Enterprise Bean with a local interface. #6

<description>#1Zero or more times#1Describes ejb-local-ref. #6

<ejb-ref-name>OnceSpecifies the ejb-local-ref name. #6

<ejb-ref-type>OnceSpecifies the Enterprise Bean type to be linked to. #6
You can specify the following character strings:
  • Entity
  • Session

<local-home>OnceSpecifies the Local Home interface name of the Enterprise Bean to be linked to. #6

<local>OnceSpecifies the Local Component interface name of the Enterprise Bean to be linked to. #6

<ejb-link>Zero or onceSpecifies the ejb-name to be linked to. #6

<injection-target>Zero or more timesSpecifies the Dependency Injection settings. #5

<injection-target-class>OnceSpecifies the injection target class name. #5
Displayed from the package when the package is defined.

<injection-target-name>OnceSpecifies the injection target identifier of the specified class. #5

<resource-ref>Zero or more timesDefines the resource reference. #5

<description>#1Zero or more times#1Describes resource-ref. #6

<res-ref-name>OnceSpecifies the resource-ref name. #6

<res-type>Zero or onceSpecifies the resource type. #6
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>Zero or onceSpecifies the authentication method. #6
You can specify the following character strings:
  • Application
  • Container
In the Servlet 2.5 or later versions, the default value is Container.

<res-sharing-scope>Zero or onceSpecifies whether to share the referenced resources. #6
You can specify the following character strings:
  • Shareable
  • Unshareable

<mapped-name>Zero or onceSpecifies the corresponding resource adapter display name or mail display name. #5
When you specify this tag at the same time as <linked-to> tag, the <linked-to> tag becomes valid.

<injection-target>Zero or more timesSpecifies the Dependency Injection settings. #5

<injection-target-class>OnceSpecifies the injection target class name. #5
Displayed from the package when the package is defined.

<injection-target-name>OnceSpecifies the injection target identifier of the specified class. #5

<linked-to>Zero or onceSpecifies the corresponding resource adapter display name, data source display name, or mail display name. #6
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 adapters of Connector 1.5 or later versions
Resource-adapter-display-name!connection-definition-identifier
The connection-definition-identifier is a value specified in the <connectionfactory-interface> tag in the ra.xml.
You cannot specify the member resource adapters of the cluster connection pool.
This tag is ignored in the cjsetresprop command.

<resource-env-ref>Zero or more timesDefines the resource environment variable. #6

<description>#1Zero or more times#1Describes resource-env-ref. #6

<resource-env-ref-name>OnceSpecifies the resource-env-ref name. #6

<resource-env-ref-type>OnceSpecifies the class type of the resource environment variable value. #6
You can specify the following character strings:
  • javax.jms.Queue
  • javax.jms.Topic
  • javax.transaction.UserTransaction
  • javax.ejb.TimerService
  • javax.ejb.EJBContext
  • JavaBeans resource class name
The strings javax.transaction.UserTransaction, javax.ejb.TimerService, and javax.ejb.EJBContext are output only when annotations are used. However, you cannot set these values.
When you specify <linked-adminobject>, any class name is displayed.

<mapped-name>Zero or onceDisplays the corresponding queue #5 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.

<injection-target>Zero or more timesSpecifies the Dependency Injection settings. #5

<injection-target-class>OnceSpecifies the injection target class name. #5
Displayed from the package when the package is defined.

<injection-target-name>OnceSpecifies the injection target identifier of the specified class. #5

<linked-queue>Zero or onceSpecifies the corresponding data source display name or mail display name. #6
This tag is ignored when used in the cjsetresprop command.
The tag is valid only when javax.jms.Queue is specified in <resource-env-ref-type>.

<resource-adapter>OnceSpecifies the resource adapter display name. #6
You cannot specify the resource adapters conforming to Connector 1.5 specifications.

<queue>OnceSpecifies the display name of the queue.#6

<linked-adminobject>Zero or onceSpecifies the administered object.
This tag is ignored in the cjsetresprop command.

<resourceadapter-name>OnceSpecifies the resource adapter display name.
You cannot specify the resource adapters conforming to Connector 1.0 or earlier versions.

<adminobject-name>OnceSpecifies 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 (:), semi-colon (;), 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 onceSpecifies the display name of JavaBeans resource. #6
This tag is valid only when JavaBeans-resource-class-name is specified for <resource-env-ref-type>.
This tag is ignored when used in the cjsetresprop command.

<persistence-context-ref>Zero or more timesDescribes the settings of the persistence context. #5

<description>#1Zero or more timesDescribes the persistence context. #6

<persistence-context-ref-name>OnceSets up the name of the persistence context reference. The name is a JNDI name correlated to the java:comp/env context. #6

<persistence-unit-name>Zero or onceSets up the name of the persistence unit. #6

<persistence-context-type>Zero or onceSets up the transactional nature of the persistence context reference. You can specify the following strings: #6
  • Transaction
  • Extended

<persistence-property>Zero or more timesSets up properties of the container or persistence provider. #6

<name>OnceSets up the name of the property. #6

<value>OnceSets up the value of the property. #6

<injection-target>Zero or more timesDescribes the Dependency Injection settings. #6

<injection-target-class>OnceSpecifies the injection target class name. Specified from the package when the package is defined. #6

<injection-target-name>OnceSpecifies the injection target identifier of the specified class.

<persistence-unit-ref>Zero or more timesDescribes the settings for the persistence unit reference #5

<description>#1Zero or more timesDescribes the persistence unit reference. #6

<persistence-unit-ref-name>OnceSets up the name of the persistence unit reference. The name is a JNDI name correlated to the java:comp/env context. #6

<persistence-unit-name>Zero or onceSets up the name of the persistence unit. #6

<injection-target>Zero or more timesSpecifies the Dependency Injection settings. #6

<injection-target-class>OnceSpecifies the injection target class name. Specified from the package when the package is defined. #6

<injection-target-name>OnceSpecifies the injection target identifier of the specified class. #6

<post-construct>Zero or more timesDefines the post-construct method. #5

<lifecycle-callback-class>Zero or onceDescribes the name of the class that stores the post-construct method. If this tag is omitted, the specification of the <post-construct> tag is ignored. #6

<lifecycle-callback-method>OnceDescribes the post-construct method name. #6

<pre-destroy>Zero or more timesDefines the pre-destroy method. #5

<lifecycle-callback-class>Zero or onceDescribes name of the class that stores the pre-destroy method. If this tag is omitted, the specification of the <pre-destroy> tag is ignored. #6

<lifecycle-callback-method>OnceDescribes the pre-destroy method name. #6

<runtime>Zero or once
When used in the cjsetappprop command
This tag is mandatory.
When used in the cjsetresprop command
This tag is ignored.

<context-root>OnceSpecifies the context root.
The characters that you can specify are those that can be used in URI (RFC3986). When specifying the root, you specify either a blank character string or a forward slash (/).

<thread-control>

2.17 in the Web Container Functionality Guide
Zero or onceSpecifies the settings for the thread control group.
This tag is ignored when used in the cjsetresprop command.

<thread-control-max-threads>OnceSpecifies the maximum number of concurrently executed threads for the Web applications.
Specify a value equal to at least the number of exclusive threads.
1 to 1024

<thread-control-exclusive-threads>OnceSpecifies the number of exclusive threads.
Specify a value not more than the maximum number of concurrently executed threads for the Web applications.
0 to 1024

<thread-control-queue-size>OnceSpecifies the pending queue size of the Web applications.
0 to 2147483647​

<thread-control-stats-monitor>OnceSpecifies the settings for monitoring the operation statistics.

<whole-waiting-request-count>OnceMonitors the whole pending request count of the Web applications.

<enabled>OnceSpecifies whether to enable the threshold value event for monitoring the whole pending request count of the Web applications.
You can specify the following character strings:
  • true (the threshold value event is enabled)
  • false (the threshold value event is disabled)
The default value is true.

<high-threshold>OnceSpecifies an integer from 1 to 100 (unit: %) as the high threshold value for the output of the threshold value event. The default value is 80.
However, the value must be equal to or greater than the value specified in the <low-threshold> tag.

<low-threshold>OnceSpecifies an integer from 0 to 99 (unit: %) as the low threshold value for the output of the threshold value event.
The default value is 0.
However, the value must be equal to or less than the value specified in the <high-threshold> tag.

<waiting-request-count>OnceMonitors the number of pending requests of the Web applications.

<enabled>OnceSpecifies 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 (the threshold value event is enabled)
  • false (the threshold value event is disabled)
The default value is true.

<high-threshold>OnceSpecifies an integer from 1 to 100 (unit: %) as the high threshold value for the output of the threshold value event. The default value is 80.
However, the value must be equal to or greater than the value specified in the <low-threshold> tag.

<low-threshold>OnceSpecifies an integer from 0 to 99 (unit: %) as the low threshold value for the output of the threshold value event.
The default value is 0.
However, the value must be equal to or less than the value specified in the <high-threshold> tag.

<resource-watcher>OnceSpecifies the properties related to the monitoring of the number of saved request pending queues of the Web applications.

<watcher-threshold>OnceSpecifies the threshold value to output an alert message.
Specify an integer value from 1 to 100 (unit: %). The default value is 80.

<watcher-interval>OnceSpecifies the monitoring interval.
Specify an integer value from 1 to 2147483647​ (unit: seconds). The default value is 30.

<watcher-enabled>OnceSpecifies 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 (Monitoring is enabled)
  • false (Monitoring is disabled)
The default value is true. However, monitoring is disabled when 0 is specified in thread-control-queue-size.

<watcher-writefile-enabled>OnceSpecifies whether to output the resource usage status to a file.
You can specify the following character strings:
  • true (Output to a file)
  • false (Not output to a file)
The default value is true.

<urlgroup-thread-control>
2.18 in the Web Container Functionality Guide
Zero or more timesSpecifies the control of the number of concurrently executed threads for the URL groups.

<urlgroup-thread-control-name>OnceSpecifies the definition name for controlling the concurrently executed thread count of the URL groups.
Specify a character string unique in the Web application as the definition name for controlling the concurrently executed thread count of the URL groups. You can use alphanumeric characters (0 to 9, A to Z, a to z), hyphen (-), and underscore (_). Specify the length of the character string as 1 [Figure]character-string-length[Figure] 64.

<urlgroup-thread-control-max-threads>OnceSpecifies the maximum number of concurrently executed threads for the URL groups.
Specify an integer value from 1 to thread-control-max-threads.

<urlgroup-thread-control-exclusive-threads>OnceSpecifies the number of exclusive threads for the URL groups.
The value that you can specify ranges from 0 to urlgroup-thread-control-max-threads and thread-control-exclusive-threads value or less. Note that, when <urlgroup-thread-control> is defined, the following range of settings need to be fulfilled:
  • If thread-control-max-threads[Figure] thread-control-exclusive-threads, then thread-control-exclusive-threads[Figure] total urlgroup-thread-control-exclusive-threads.
  • If thread-control-max-threads = thread-control-exclusive-threads, then thread-control-exclusive-threads > total urlgroup-thread-control-exclusive-threads.

<urlgroup-thread-control-queue-size>OnceSpecifies the pending queue size for the URL groups.
You can specify an integer value from 0 to 2147483647​.

<urlgroup-thread-control-mapping>Zero or more timesSpecifies the mapping information of the URL to be controlled.

<url-pattern>OnceSpecifies the URL pattern to be controlled.
You cannot specify the same URL pattern in one Web application. Some examples of specification are as follows:
  • /soda/grape/*
  • /foo/*
  • /contents
  • *.foo

<stats-monitor>OnceSpecifies the operation statistics settings.

<waiting-request-count>OnceMonitors the pending requests of the URL groups.

<enabled>OnceSpecifies whether to enable the threshold value event for monitoring the pending requests of the URL groups.
You can specify the following character strings:
  • true (the threshold value event is enabled)
  • false (the threshold value event is disabled)

<high-threshold>OnceSpecifies an integer from 1 to 100 (unit: %) as the high threshold value for the output of the threshold value event.
Make sure you specify a value that is equal to or greater than low-threshold.

<low-threshold>OnceSpecifies an integer from 0 to 99 (unit: %) as the low threshold value for the output of the threshold value event.
Make sure you specify a value that is equal to or less than high-threshold.

<http-request>Zero or once--

<encoding>Zero or onceSpecifies the default encoding used to decode a request body and query.
Specify a character encoding that JavaVM supports.#7
By default, this tag is not specified.

<http-response>Zero or once--

<encoding>Zero or onceSpecifies the default encoding used to encode a response body.
Specify a character encoding that JavaVM supports.#7
By default, this tag is not specified.

<jsp>Zero or once--

<page-encoding>Zero or onceSpecifies the default encoding used to read a JSP file.
Specify a character encoding that JavaVM supports.#7
By default, this tag is not specified.

<http-session>Zero or once--

<http-session-max-number>OnceSpecifies the maximum number of usable HttpSessions.
You can specify an integer value from -1 to 2147483647​. When -1 is specified, the number of usable HttpSessions is infinite. The default value is -1.

<resource-watcher>OnceSpecifies the properties related to the monitoring of the number of HttpSessions.

<watcher-threshold>OnceSpecifies the threshold value to output an alert message.
You can specify an integer value from 1 to 100 (unit: %). The default value is 80.

<watcher-interval>OnceSpecifies the monitoring interval.
You can specify an integer value from 1 to 2147483647​ (unit: seconds). The default value is 30.

<watcher-enabled>OnceSpecifies whether to enable the monitoring of the number of HttpSessions.
You can specify the following character strings:
  • true (Monitoring is enabled)
  • false (Monitoring is disabled)
The default value is true. However, if you specify 0 in http-session-max-number, monitoring is disabled.

<watcher-writefile-enabled>OnceSpecifies whether to output the resource usage status to a file. You can specify the following character strings:
  • true (Output to a file)
  • false (Not output to a file)
The default value is true.

<dbsfo>

Chapter 6 in the Expansion Guide
Zero or onceSets up the database session failover functionality.

<enabled>Zero or onceSpecifies whether to enable or disable the database session failover functionality.
Specify true to enable the functionality and false to disable the functionality.

<application-id>Zero or onceSets up the application identifier. You can use only alphanumeric characters (0 to 9, A to Z, a to z) and underscores (_). You can specify up to 16 characters.

<attribute-data-size-max>Zero or onceSets up the maximum size for the property information of an HTTP session that can be included in the global session information. The specifiable range is an integer value from 128 to 10485760​ (unit: bytes).

<exclude-extensions>Zero or onceSets up an extension to control the database session failover functionality.
If the URL path is the same as the specified extension, the database session failover functionality is disabled in the corresponding request. The comparison of the specified extension and URL is not case sensitive.
If you do not want to set up the extension that controls the database session failover functionality, specify a blank character string.
Specify up to 512 of the following characters:
  • Alphanumeric characters
  • Parentheses ((), ())
  • Exclamation mark (!)
  • Percent sign (%)
  • Dollar sign ($)
  • Ampersand (&)
  • Single quotation mark (')
  • Plus sign (+)
  • Hyphen (-)
  • Equal sign (=)
  • at mark (@)
  • Underscore (_)
  • Tilde (~)
  • Period (.)
  • Comma (,)
When specifying multiple extensions, demarcate with commas (,).

<start-notify-error>Zero or onceSpecifies whether to report an error when starting a J2EE application.
You specify whether to report the error and suspend application startup when a J2EE application is being started and an error occurs during the initialization of the servlets and JSPs for which load-on-startup is specified and during the parsing of taglib.
You can specify the following character strings:
  • true (Error is reported)
  • false (Error is not reported)
The default value is true.

<start-order>Zero or onceSpecifies the order used when 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.
0 [Figure]start-order[Figure] 2147483647​
#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 the WARs of Servlet 2.3 or earlier versions.
#3
For details on the default mapping values of the extensions specified in the mime-mapping tag and the MIME types, see Appendix B.1 Mapping the extensions and MIME types in the manual uCosminexus Application Server Definition Reference Guide.
#4
Specify either error-code or exception-type.
#5
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.
#6
Do not change the values for the annotation settings.
#7
The characters that you can specify as the default character encoding are the character encoding supported by JavaVM. For details on the character encoding that JavaVM supports, see the description related to the supported encoding in the JDK documentation. Also, the character strings that you can specify are the character encoding described in the canonical names for java.nio API and canonical names for java.lang API, and their optional names.