Hitachi

uCosminexus Application Server Application and Resource Definition Reference Guide


3.9.1 Specifications of the HITACHI Servlet Property file

The HITACHI Servlet Property file has the following DOCTYPE declaration:

<!DOCTYPE hitachi-servlet-property PUBLIC '-//Hitachi, Ltd.//DTD Servlet Property 7.0//EN' 'file:///Cosminexus-installation-directory/CC/admin/dtds/hitachi-servlet-property_7_0.dtd'>

The HITACHI Servlet Property file is an xml file containing the following tags. Note that you can also use the earlier versions of the property file.

Tag name

Occurrence pattern

Explanation

<hitachi-servlet-property>

Once

Specifies the root tag.

<description>#1

Zero or more times#2

Describes the servlets and JSPs.

<display-name>#1

One or more times#2

Specifies the display name of the servlets and JSPs.

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.

1character-string-length

There is no restriction on the characters to be used.

<icon>#1

Zero or more times#2

Defines the Servlet icons displayed on the Deploy tool.

<small-icon>

Zero or once

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

<large-icon>

Zero or once

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

<init-param>

Zero or more times

Defines the initialization parameters.

<description>#1

Zero or more times#2

Describes init-param.

<param-name>

Once

Specifies the name of the initialization parameter.

<param-value>

Once

Specifies the initialization parameter value.

<load-on-startup>

Zero or once

Specifies load settings for startup.

You can specify the following integer values:

-2147483648 load-on-startup -1

Loaded when required.

Even if a value other than -1 is specified; it is treated as -1.

0

Loaded on startup.

The Container determines the loading order.

1 load-on-startup 2147483647

Loaded on startup.

The loading order is from the smallest value to the biggest value.

In the Servlet 2.5 or later versions, you can also specify a null character.

<run-as>

Zero or once

Defines the runtime identity. #3

<description>#1

Zero or more times#2

Describes run-as. #3

<role-name>

Once

Specifies the security role name. #3

<user-name>

Once

Specifies the user name.

<security-role-ref>

Zero or more times

Defines the security role.

<description>#1

Zero or more times#2

Describes security-role-ref.

<role-name>

Once

Specifies the security-role-ref name.

<role-link>

Zero or once

Specifies the role name to be linked to.

<url-pattern>#4

Zero or more times

Specifies the servlet URL.

If the information of this tag is replaced with the information of a different servlet using the Application Integrated Properties File, use the cjsetapppropcommand to delete the <url-pattern> information of all the servlets in the registered application, and then specify the correct information.

<method-observation-timeout>

Zero or once

Specifies the timeout value for monitoring the in-process methods among the common methods in the servlet.

You can specify a value from 0 to 86400 (unit: seconds). When you specify 0, a timeout will not occur. The default value is 0.

--

--

--

#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

If values are specified for annotations, the changes in the values are ignored.

#4

If the HITACHI Application Integrated Property File has been set by using the cjsetappprop command, the value that is set for this item is applied for each servlet (for each <hitachi-servlet-property> tag). Note that the system performs a check for duplication of <url-pattern> tags under all <hitachi-servlet-property> tags.