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.
Tag name | Occurrence pattern | Explanation | |||||
---|---|---|---|---|---|---|---|
<hitachi-war-property> | Once | Specifies the root tag. | |||||
<description>#1 | Zero or more times#1 | Describes the WAR. | |||||
<display-name>#1 | One or more times#1 | Specifies 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 ![]() 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>#1 | Zero or more times#1 | Defines the Web application icons displayed on the Deploy tool. | |||||
<small-icon> | Zero or once | Specifies the file name for small icons (16![]() | |||||
<large-icon> | Zero or once | Specifies the file name for large icons (32![]() | |||||
<distributable> | Zero or once | Specified 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 times | Defines the context initialization parameter. | |||||
<description>#1 | Zero or more times#1 | Describes Context-param. | |||||
<param-name> | Once | Specifies the context initialization parameter name. | |||||
<param-value> | Once | Specifies the context initialization parameter value. | |||||
<filter-mapping> | Zero or more times | Defines the Web application filter mapping. | |||||
<filter-name> | Once | Specifies the name of the filter that performs the mapping. | |||||
<url-pattern> 2.9 in the Web Container Functionality Guide | One or more times | Specifies 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 times | Specifies 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 less | Specifies the applicable conditions for the filter. Specify one of the following values:
| |||||
<listener> | Zero or more times | Defines the listener. | |||||
<description>#1 | Zero or more times | Describes the Web application listener Bean. You cannot specify this tag for the WARs of Servlet 2.3 or earlier versions. | |||||
<display-name>#1 | Zero or more times | Specifies 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>#1 | Zero or more times#1 | Defines 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 once | Specifies 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 ![]() | |||||
<large-icon> | Zero or once | Specifies 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 ![]() | |||||
<listener-class> | Once | Specifies the listener class name that is set up. | |||||
<session-config> | Zero or more times | Defines the session. You cannot specify this tag multiple times. | |||||
<session-timeout> | Zero or once | Specifies the default session timeout interval (minutes). You can specify -1 (no timeout), 0 (equal to -1), or 1 ![]() ![]() | |||||
<mime-mapping> | Zero or more times | Defines the MIME type mapping. #3 | |||||
<extension> | Once | Specifies the file extension. #3 | |||||
<mime-type> | Once | Specifies the MIME type. #3 | |||||
<welcome-file-list> | Zero or more times#1 | Defines the welcome file. | |||||
<welcome-file> | One or more times | Specifies the welcome file name. | |||||
<error-page> | Zero or more times | Defines the error page. | |||||
<error-code>#4 | Either one once or neither | Specifies the HTTP error code. This tag is specified when mapping an HTTP error code and error page resource. Specify a value so that -2147483648 ![]() ![]() | |||||
<exception-type>#4 | Either one once or neither | Specifies 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> | Once | Specifies a value beginning with a forward slash (/). | |||||
<jsp-config> | Zero or more times | Defines 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 times | Defines 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> | Once | Specifies the value set up in the uri property of the taglib directive of a JSP program. | |||||
<taglib-location> | Once | Specifies the deployment location of a tld file (relative path from the context root). | |||||
<jsp-property-group> | Zero or more times | Specifies the individual settings for JSP programs conforming to the specified URL pattern. | |||||
<description>#1 | Zero or more times | Describes the Web application listener Bean. | |||||
<display-name>#1 | Zero or more times | Specifies the JSP property group name displayed on the GUI tool. The specified character string need not be unique. | |||||
<icon>#1 | Zero or more times | Defines the JSP property group icons displayed on the GUI tool. | |||||
<small-icon> | Zero or once | Specifies 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 ![]() | |||||
<large-icon> | Zero or once | Specifies 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 ![]() | |||||
<url-pattern> | One or more times | Specifies the URL pattern where parameters are applied. | |||||
<el-ignored> | Zero or once | Specifies whether to ignore EL (expression language). You can specify the following character strings:
| |||||
<page-encoding> | Zero or once | Specifies the page-encoding name. | |||||
<scripting-invalid> | Zero or once | Specifies whether to invalidate the scripting element. | |||||
<is-xml> | Zero or once | Specifies whether the WAR is coded in the XML syntax. | |||||
<include-prelude> | Zero or more times | Specifies the file path to be included as the header of each page (relative path from the context root). | |||||
<include-coda> | Zero or more times | Specifies 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 once | Defines whether the existence of the string #{ will be considered as an error at locations where EL cannot be used. The default value is false.
| |||||
<trim-directive-whitespaces> | Zero or once | Defines whether extra spaces will be output from JSPs. The default value is false.
| |||||
<taglib> | Zero or more times | Defines 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> | Once | Specifies the tag library URI (relative URI for web.xml). | |||||
<taglib-location> | Once | Specifies the location of the tag library descriptor file (TLD) (relative position from the root of the Web application). | |||||
<security-constraint> | Zero or more times | Defines the security constraints. | |||||
<display-name>#1 | Zero or more times#1 | Specifies the security constraint name. | |||||
<web-resource-collection> | One or more times | Defines the Web resource collection. | |||||
<description>#1 | Zero or more times#1 | Describes web-resource-collection. | |||||
<web-resource-name> | Once | Specifies the Web resource collection name. | |||||
<url-pattern> | One or more times | Specifies 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 times | Specifies 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:
| |||||
<http-method-omission> | One or more times | Specifies 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 once | Defines the role that will be allowed to access the Web resource collection. | |||||
<description>#1 | Zero or more times#1 | Describes auth-constraint. | |||||
<role-name> | Zero or more times | Specifies the role that will be allowed to access the Web resource collection. | |||||
<user-data-constraint> | Zero or once | Defines how to protect the data communication between the client and the container. | |||||
<description>#1 | Zero or more times#1 | Describes user-data-constraint. | |||||
<transport-guarantee> | Once | Defines how to protect the data communication between the client and the container. You can specify the following character strings:
| |||||
<original-name> | Once | Saves 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 times | Defines the login method. You cannot specify this tag multiple times. | |||||
<auth-method> | Zero or once | Specifies the authentication method. You can specify the following character strings:
| |||||
<realm-name> | Zero or once | Specifies the realm name.
| |||||
<form-login-config> | Zero or once |
| |||||
<form-login-page> | Once | Specifies the page used for log in. The value that you specify must begin with a forward slash (/). | |||||
<form-error-page> | Once | Specifies the error page displayed when log in fails. The value that you specify must begin with a forward slash (/). | |||||
<security-role> | Zero or more times | Defines a security role. #6 | |||||
<description>#1 | Zero or more times#1 | Describes security-role. #6 | |||||
<role-name> | Once | Specifies the role name. #6 | |||||
<linked-to> | Zero or once | Specifies the role name defined with the cjaddsec command. This tag is ignored when used with the cjsetresprop command. | |||||
<env-entry> | Zero or more times | Defines the environment entry. #5 | |||||
<description>#1 | Zero or more times#1 | Describes the environment entry. #5 | |||||
<env-entry-name> | Once | Specifies the environment entry name. #5 | |||||
<env-entry-type> | Zero or once | Specifies the environment entry data type. #6 You can specify the following character strings:
| |||||
<env-entry-value> | Once | Specifies 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 times | Specifies the Dependency Injection settings. #6 | |||||
<injection-target-class> | Once | Specifies the injection target class name. #5 Displayed from the package when the package is defined. | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. #5 | |||||
<ejb-ref> | Zero or more times | Defines the reference information for the Enterprise Bean with a remote interface. #6 | |||||
<description>#1 | Zero or more times#1 | Describes ejb-ref. #6 | |||||
<ejb-ref-name> | Once | Specifies the ejb-ref name. #6 | |||||
<ejb-ref-type> | Zero or once | Specifies the Enterprise Bean to be linked to. #6 You can specify the following character strings:
| |||||
<home> | Zero or once | Specifies the name of the Home interface class to be linked to. #6 | |||||
<remote> | Zero or once | Specifies the name of the Component interface class to be linked to. #6 | |||||
<ejb-link> | Zero or once | Specifies 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 times | Specifies the Dependency Injection settings. #6 | |||||
<injection-target-class> | Once | Specifies the injection target class name. #5 Displayed from the package when the package is defined. | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. #5 | |||||
<ejb-local-ref> | Zero or more times | Defines the reference information for the Enterprise Bean with a local interface. #6 | |||||
<description>#1 | Zero or more times#1 | Describes ejb-local-ref. #6 | |||||
<ejb-ref-name> | Once | Specifies the ejb-local-ref name. #6 | |||||
<ejb-ref-type> | Once | Specifies the Enterprise Bean type to be linked to. #6 You can specify the following character strings:
| |||||
<local-home> | Once | Specifies the Local Home interface name of the Enterprise Bean to be linked to. #6 | |||||
<local> | Once | Specifies the Local Component interface name of the Enterprise Bean to be linked to. #6 | |||||
<ejb-link> | Zero or once | Specifies the ejb-name to be linked to. #6 | |||||
<injection-target> | Zero or more times | Specifies the Dependency Injection settings. #6 | |||||
<injection-target-class> | Once | Specifies the injection target class name. #5 Displayed from the package when the package is defined. | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. #5 | |||||
<resource-ref> | Zero or more times | Defines the resource reference. | |||||
<description>#1 | Zero or more times#1 | Describes resource-ref. #6 | |||||
<res-ref-name> | Once | Specifies the resource-ref name. #6 | |||||
<res-type> | Zero or once | Specifies the resource type. #6 You can specify the following character strings:
| |||||
<res-auth> | Zero or once | Specifies the authentication method. #6 You can specify the following character strings:
| |||||
<res-sharing-scope> | Zero or once | Specifies whether to share the referenced resources. #6 You can specify the following character strings:
| |||||
<mapped-name> | Zero or once | Specifies 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 times | Specifies the Dependency Injection settings. #6 | |||||
<injection-target-class> | Once | Specifies the injection target class name. #5 Displayed from the package when the package is defined. | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. #5 | |||||
<linked-to> | Zero or once | Specifies 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.
This tag is ignored in the cjsetresprop command. | |||||
<resource-env-ref> | Zero or more times | Defines the resource environment variable. #6 | |||||
<description>#1 | Zero or more times#1 | Describes resource-env-ref. #6 | |||||
<resource-env-ref-name> | Once | Specifies the resource-env-ref name. #6 | |||||
<resource-env-ref-type> | Zero or once | Specifies the class type of the resource environment variable value. #6 You can specify the following character strings:
When you specify <linked-adminobject>, any class name is displayed. | |||||
<mapped-name> | Zero or once | Displays 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 times | Specifies the Dependency Injection settings. #6 | |||||
<injection-target-class> | Once | Specifies the injection target class name. #5 Displayed from the package when the package is defined. | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. #5 | |||||
<linked-queue> | Zero or once | Specifies 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> | Once | Specifies the resource adapter display name. #6 You cannot specify the resource adapters conforming to Connector1.5 specifications. | |||||
<queue> | Once | Specifies the display name of the queue.#6 | |||||
<linked-adminobject> | Zero or once | Specifies the administered object. This tag is ignored in the cjsetresprop command. | |||||
<resourceadapter-name> | Once | Specifies the resource adapter display name. You cannot specify the resource adapters conforming to Connector1.0 or earlier versions. | |||||
<adminobject-name> | Once | Specifies the administered object name. You can use alphanumeric characters (0 to 9, A to Z, and a to z) and the following special characters: Space ( ), exclamation mark (!), double quotation mark ("), hash mark (#), dollar sign ($), percent sign (%), ampersand (&), single quotation ('), left parenthesis and right parenthesis (() ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), colon (:), semi-colon (;), less-than sign (<), equal sign (=), greater-than sign (>), question mark (?), at mark (@), square brackets ([) (]), yen sign ( ![]() You cannot, however, specify the following names:
Any single-byte space or linefeed at the beginning or end of the character string is removed. | |||||
<linked-to> | Zero or once | Specifies 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 times | Describes the settings of the persistence context. | |||||
<description>#1 | Zero or more times#2 | Describes the persistence context. #6 | |||||
<persistence-context-ref-name> | Once | Sets 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 once | Sets up the name of the persistence unit. #6 | |||||
<persistence-context-type> | Zero or once | Sets up the transactional nature of the persistence context reference. You can specify the following strings: #6
| |||||
<persistence-property> | Zero or more times | Sets up properties of the container or persistence provider. #6 | |||||
<name> | Once | Sets up the name of the property. #6 | |||||
<value> | Once | Sets up the value of the property. #6 | |||||
<injection-target> | Zero or more times | Describes the Dependency Injection settings. #6 | |||||
<injection-target-class> | Once | Specifies the injection target class name. Specified from the package when the package is defined. #6 | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. | |||||
<persistence-unit-ref> | Zero or more times | Describes the settings for the persistence unit reference. #6 | |||||
<description> | Zero or more times | Describes the persistence unit reference. #6 | |||||
<persistence-unit-ref-name> | Once | Sets 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 once | Sets up the name of the persistence unit. #6 | |||||
<injection-target> | Zero or more times | Describes the Dependency Injection settings. #6 | |||||
<injection-target-class> | Once | Specifies the injection target class name. Specified from the package when the package is defined. #6 | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. #6 | |||||
<post-construct> | Zero or more times | Defines the post-construct method. #6 | |||||
<lifecycle-callback-class> | Zero or once | Describes 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> | Once | Describes the post-construct method name. #6 | |||||
<pre-destroy> | Zero or more times | Defines the pre-destroy method. #6 | |||||
<lifecycle-callback-class> | Zero or once | Describes 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> | Once | Describes the pre-destroy method name. #6 | |||||
<locale-encoding-mapping-list> | Zero or more times#1 | Specifies 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 times | Specifies the settings for mapping the locale to the encoding method. | |||||
<locale> | Once | Describes the locale. | |||||
<encoding> | Once | Describes the encoding method. | |||||
<runtime> | Zero or once |
| |||||
<context-root> | Once | Specifies 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 once | Specifies the settings for the thread control group. This tag is ignored when used in the cjsetresprop command. | |||||
<thread-control-max-threads> | Once | Specifies 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> | Once | Specifies 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> | Once | Specifies the pending queue size of the Web applications. 0 to 2147483647 | |||||
<thread-control-stats-monitor> | Once | Specifies the settings for monitoring the operation statistics. | |||||
<whole-waiting-request-count> | Once | Monitors the whole pending request count of the Web applications. | |||||
<enabled> | Once | Specifies 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:
| |||||
<high-threshold> | Once | Specifies 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> | Once | Specifies 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> | Once | Monitors the number of pending requests of the Web applications. | |||||
<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:
| |||||
<high-threshold> | Once | Specifies 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> | Once | Specifies 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> | Once | Specifies the properties related to the monitoring of the number of saved request pending queues of the Web applications. | |||||
<watcher-threshold> | Once | Specifies the threshold value to output an alert message. Specify an integer value from 1 to 100 (unit: %). The default value is 80. | |||||
<watcher-interval> | Once | Specifies the monitoring interval. Specify an integer value from 1 to 2147483647 (unit: seconds). Default is 30. | |||||
<watcher-enabled> | 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:
| |||||
<watcher-writefile-enabled> | Once | Specifies whether to output the resource usage status to a file. You can specify the following character strings:
| |||||
<urlgroup-thread-control> 2.18 in the Web Container Functionality Guide | Zero or more times | Specifies the control of the number of concurrently executed threads for the URL groups. | |||||
<urlgroup-thread-control-name> | Once | Specifies 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 ![]() ![]() | |||||
<urlgroup-thread-control-max-threads> | Once | Specifies 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> | Once | Specifies 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:
| |||||
<urlgroup-thread-control-queue-size> | Once | Specifies 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 times | Specifies 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> | Once | Specifies the URL pattern to be controlled. You cannot specify the same URL pattern in one Web application. Some examples of specification are as follows:
| |||||
<stats-monitor> | Once | Specifies the operation statistics settings. | |||||
<waiting-request-count> | Once | Monitors the pending requests of the URL groups. | |||||
<enabled> | Once | Specifies whether to enable the threshold value event for monitoring the pending requests of the URL groups. You can specify the following character strings:
| |||||
<high-threshold> | Once | Specifies 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> | Once | Specifies 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 once | Specifies 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 once | Specifies 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 once | Specifies 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> | Once | Specifies 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> | Once | Specifies the properties related to the monitoring of the number of HttpSessions. | |||||
<watcher-threshold> | Once | Specifies 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> | Once | Specifies the monitoring interval. You can specify an integer value from 1 to 2147483647 (unit: seconds). The default value is 30. | |||||
<watcher-enabled> | Once | Specifies whether to enable the monitoring of the number of HttpSessions. You can specify the following character strings:
| |||||
<watcher-writefile-enabled> | Once | Specifies whether to output the resource usage status to a file. You can specify the following character strings:
| |||||
<dbsfo> Chapter 6 in the Expansion Guide | Zero or once | Sets up the database session failover functionality. | |||||
<enabled> | Zero or once | Specifies whether to enable the database session failover functionality. You can specify the following character strings:
| |||||
<application-id> | Zero or once | Sets 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 once | Sets 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 once | Sets 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:
| |||||
<start-notify-error> | Zero or once | Specifies 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:
| |||||
<start-order> | Zero or once | Specifies 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 ![]() ![]() |
Tag name | Occurrence pattern | Explanation | |||||
---|---|---|---|---|---|---|---|
<hitachi-war-property> | Once | Specifies the root tag. | |||||
<description>#1 | Zero or more times#1 | Describes the WAR. #5 | |||||
<display-name>#1 | One or more times#1 | Specifies 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 ![]() 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>#1 | Zero or more times#1 | Defines the Web application icons displayed on the Deploy tool. #5 | |||||
<small-icon> | Zero or once | Specifies the file name for small icons (16![]() | |||||
<large-icon> | Zero or once | Specifies the file name for large icons (32![]() | |||||
<security-role> | Zero or more times | Defines a security role. | |||||
<description>#1 | Zero or more times#1 | Describes security-role. #5 | |||||
<role-name> | Once | Specifies the role name. #5 | |||||
<linked-to> | Zero or once | Specifies the role name defined with the cjaddsec command. This tag is ignored when used in the cjsetresprop command. | |||||
<env-entry> | Zero or once | Defines the environment entry. #5 | |||||
<description>#1 | Zero or more times#1 | Describes the environment entry. #5 | |||||
<env-entry-name> | Once | Specifies the environment entry name. #5 | |||||
<env-entry-type> | Once | Specifies the environment entry data type. #5 You can specify the following character strings:
| |||||
<env-entry-value> | Once | Specifies 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 times | Specifies the Dependency Injection settings. #5 | |||||
<injection-target-class> | Once | Specifies the injection target class name. #5 Displayed from the package when the package is defined. | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. #5 | |||||
<ejb-ref> | Zero or more times | Defines the reference information for the Enterprise Bean with a remote interface. #5 | |||||
<description>#1 | Zero or more times#1 | Describes ejb-ref. #6 | |||||
<ejb-ref-name> | Once | Specifies the ejb-ref name. #6 | |||||
<ejb-ref-type> | Zero or once | Specifies the Enterprise Bean type to be linked to. #6 You can specify the following character strings:
| |||||
<home> | Zero or once | Specifies the name of the Home interface class to be linked to. #6 | |||||
<remote> | Zero or once | Specifies the name of the Component interface class to be linked to. #6 | |||||
<ejb-link> | Zero or once | Specifies 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 times | Specifies the Dependency Injection settings. #5 | |||||
<injection-target-class> | Once | Specifies the injection target class name. #5 Displayed from the package when the package is defined. | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. #5 | |||||
<ejb-local-ref> | Zero or more times | Defines the reference information for the Enterprise Bean with a local interface. #6 | |||||
<description>#1 | Zero or more times#1 | Describes ejb-local-ref. #6 | |||||
<ejb-ref-name> | Once | Specifies the ejb-local-ref name. #6 | |||||
<ejb-ref-type> | Once | Specifies the Enterprise Bean type to be linked to. #6 You can specify the following character strings:
| |||||
<local-home> | Once | Specifies the Local Home interface name of the Enterprise Bean to be linked to. #6 | |||||
<local> | Once | Specifies the Local Component interface name of the Enterprise Bean to be linked to. #6 | |||||
<ejb-link> | Zero or once | Specifies the ejb-name to be linked to. #6 | |||||
<injection-target> | Zero or more times | Specifies the Dependency Injection settings. #5 | |||||
<injection-target-class> | Once | Specifies the injection target class name. #5 Displayed from the package when the package is defined. | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. #5 | |||||
<resource-ref> | Zero or more times | Defines the resource reference. #5 | |||||
<description>#1 | Zero or more times#1 | Describes resource-ref. #6 | |||||
<res-ref-name> | Once | Specifies the resource-ref name. #6 | |||||
<res-type> | Zero or once | Specifies the resource type. #6 You can specify the following character strings:
| |||||
<res-auth> | Zero or once | Specifies the authentication method. #6 You can specify the following character strings:
| |||||
<res-sharing-scope> | Zero or once | Specifies whether to share the referenced resources. #6 You can specify the following character strings:
| |||||
<mapped-name> | Zero or once | Specifies 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 times | Specifies the Dependency Injection settings. #5 | |||||
<injection-target-class> | Once | Specifies the injection target class name. #5 Displayed from the package when the package is defined. | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. #5 | |||||
<linked-to> | Zero or once | Specifies 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.
This tag is ignored in the cjsetresprop command. | |||||
<resource-env-ref> | Zero or more times | Defines the resource environment variable. #6 | |||||
<description>#1 | Zero or more times#1 | Describes resource-env-ref. #6 | |||||
<resource-env-ref-name> | Once | Specifies the resource-env-ref name. #6 | |||||
<resource-env-ref-type> | Once | Specifies the class type of the resource environment variable value. #6 You can specify the following character strings:
When you specify <linked-adminobject>, any class name is displayed. | |||||
<mapped-name> | Zero or once | Displays 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 times | Specifies the Dependency Injection settings. #5 | |||||
<injection-target-class> | Once | Specifies the injection target class name. #5 Displayed from the package when the package is defined. | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. #5 | |||||
<linked-queue> | Zero or once | Specifies 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> | Once | Specifies the resource adapter display name. #6 You cannot specify the resource adapters conforming to Connector 1.5 specifications. | |||||
<queue> | Once | Specifies the display name of the queue.#6 | |||||
<linked-adminobject> | Zero or once | Specifies the administered object. This tag is ignored in the cjsetresprop command. | |||||
<resourceadapter-name> | Once | Specifies the resource adapter display name. You cannot specify the resource adapters conforming to Connector 1.0 or earlier versions. | |||||
<adminobject-name> | Once | Specifies the administered object name. You can use alphanumeric characters (0 to 9, A to Z, and a to z) and the following special characters: Space ( ), exclamation mark (!), double quotation mark ("), hash mark (#), dollar sign ($), percent sign (%), ampersand (&), single quotation ('), left parenthesis and right parenthesis (() ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), colon (:), semi-colon (;), less-than sign (<), equal sign (=), greater-than sign (>), question mark (?), at mark (@), square brackets ([) (]), yen sign ( ![]() You cannot, however, specify the following names:
Any single-byte space or linefeed at the beginning or end of the character string is removed. | |||||
<linked-to> | Zero or once | Specifies 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 times | Describes the settings of the persistence context. #5 | |||||
<description>#1 | Zero or more times | Describes the persistence context. #6 | |||||
<persistence-context-ref-name> | Once | Sets 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 once | Sets up the name of the persistence unit. #6 | |||||
<persistence-context-type> | Zero or once | Sets up the transactional nature of the persistence context reference. You can specify the following strings: #6
| |||||
<persistence-property> | Zero or more times | Sets up properties of the container or persistence provider. #6 | |||||
<name> | Once | Sets up the name of the property. #6 | |||||
<value> | Once | Sets up the value of the property. #6 | |||||
<injection-target> | Zero or more times | Describes the Dependency Injection settings. #6 | |||||
<injection-target-class> | Once | Specifies the injection target class name. Specified from the package when the package is defined. #6 | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. | |||||
<persistence-unit-ref> | Zero or more times | Describes the settings for the persistence unit reference #5 | |||||
<description>#1 | Zero or more times | Describes the persistence unit reference. #6 | |||||
<persistence-unit-ref-name> | Once | Sets 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 once | Sets up the name of the persistence unit. #6 | |||||
<injection-target> | Zero or more times | Specifies the Dependency Injection settings. #6 | |||||
<injection-target-class> | Once | Specifies the injection target class name. Specified from the package when the package is defined. #6 | |||||
<injection-target-name> | Once | Specifies the injection target identifier of the specified class. #6 | |||||
<post-construct> | Zero or more times | Defines the post-construct method. #5 | |||||
<lifecycle-callback-class> | Zero or once | Describes 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> | Once | Describes the post-construct method name. #6 | |||||
<pre-destroy> | Zero or more times | Defines the pre-destroy method. #5 | |||||
<lifecycle-callback-class> | Zero or once | Describes 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> | Once | Describes the pre-destroy method name. #6 | |||||
<runtime> | Zero or once |
| |||||
<context-root> | Once | Specifies 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 once | Specifies the settings for the thread control group. This tag is ignored when used in the cjsetresprop command. | |||||
<thread-control-max-threads> | Once | Specifies 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> | Once | Specifies 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> | Once | Specifies the pending queue size of the Web applications. 0 to 2147483647 | |||||
<thread-control-stats-monitor> | Once | Specifies the settings for monitoring the operation statistics. | |||||
<whole-waiting-request-count> | Once | Monitors the whole pending request count of the Web applications. | |||||
<enabled> | Once | Specifies 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:
| |||||
<high-threshold> | Once | Specifies 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> | Once | Specifies 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> | Once | Monitors the number of pending requests of the Web applications. | |||||
<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:
| |||||
<high-threshold> | Once | Specifies 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> | Once | Specifies 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> | Once | Specifies the properties related to the monitoring of the number of saved request pending queues of the Web applications. | |||||
<watcher-threshold> | Once | Specifies the threshold value to output an alert message. Specify an integer value from 1 to 100 (unit: %). The default value is 80. | |||||
<watcher-interval> | Once | Specifies the monitoring interval. Specify an integer value from 1 to 2147483647 (unit: seconds). The default value is 30. | |||||
<watcher-enabled> | 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:
| |||||
<watcher-writefile-enabled> | Once | Specifies whether to output the resource usage status to a file. You can specify the following character strings:
| |||||
<urlgroup-thread-control> 2.18 in the Web Container Functionality Guide | Zero or more times | Specifies the control of the number of concurrently executed threads for the URL groups. | |||||
<urlgroup-thread-control-name> | Once | Specifies 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 ![]() ![]() | |||||
<urlgroup-thread-control-max-threads> | Once | Specifies 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> | Once | Specifies 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:
| |||||
<urlgroup-thread-control-queue-size> | Once | Specifies 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 times | Specifies the mapping information of the URL to be controlled. | |||||
<url-pattern> | Once | Specifies the URL pattern to be controlled. You cannot specify the same URL pattern in one Web application. Some examples of specification are as follows:
| |||||
<stats-monitor> | Once | Specifies the operation statistics settings. | |||||
<waiting-request-count> | Once | Monitors the pending requests of the URL groups. | |||||
<enabled> | Once | Specifies whether to enable the threshold value event for monitoring the pending requests of the URL groups. You can specify the following character strings:
| |||||
<high-threshold> | Once | Specifies 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> | Once | Specifies 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 once | Specifies 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 once | Specifies 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 once | Specifies 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> | Once | Specifies 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> | Once | Specifies the properties related to the monitoring of the number of HttpSessions. | |||||
<watcher-threshold> | Once | Specifies 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> | Once | Specifies the monitoring interval. You can specify an integer value from 1 to 2147483647 (unit: seconds). The default value is 30. | |||||
<watcher-enabled> | Once | Specifies whether to enable the monitoring of the number of HttpSessions. You can specify the following character strings:
| |||||
<watcher-writefile-enabled> | Once | Specifies whether to output the resource usage status to a file. You can specify the following character strings:
| |||||
<dbsfo> Chapter 6 in the Expansion Guide | Zero or once | Sets up the database session failover functionality. | |||||
<enabled> | Zero or once | Specifies 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 once | Sets 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 once | Sets 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 once | Sets 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:
| |||||
<start-notify-error> | Zero or once | Specifies 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:
| |||||
<start-order> | Zero or once | Specifies 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 ![]() ![]() |