Configures the web container.
The following table describes subelements for the web-container element.
Table 1–188 web-container Subelements
Element |
Required |
Description |
---|---|---|
zero or one |
Specifies session configuration information for the web container. |
|
zero or more |
Specifies a property or a variable. |
The following table describes properties for the web-container element.
Table 1–189 web-container Properties
Property |
Default |
Description |
---|---|---|
20 |
Prevents recursive include or forward statements from creating an infinite loop by setting a maximum nested dispatch level. If this level is exceeded, the following message is written to the server log: Exceeded maximum depth for nested request dispatches |
Enables availability in the web container, including HTTP session persistence. If HADB is installed and you have selected the enterprise profile, sessions are persisted to the HADB.
If availability is disabled, there is no high availability for HTTP session persistence. In other words, persistence-type=memory.
If availability is enabled but no other web-container-availability attributes are specified, the default session persistence configuration is as follows:
persistence-type=replicated persistence-frequency=time-based persistence-scope=session
If HADB is installed and you have selected the enterprise profile, the default persistence type is ha.
The default configuration for all applications can be changed by setting the various web-container-availability attributes and properties.
You can override the various web-container-availability attributes and properties for a specific application in sun-web.xml. For details, see the Sun Java System Application Server 9.1 Developer’s Guide.
For additional replicated session persistence properties you can set, see availability-service.
The following table describes subelements for the web-container-availability element.
Table 1–190 web-container-availability Subelements
Element |
Required |
Description |
---|---|---|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the web-container-availability element.
Table 1–191 web-container-availability Attributes
Attribute |
Default |
Description |
---|---|---|
true |
(optional) If set to true, and if availability is enabled for the server instance (see availability-service), high-availability features apply to all web applications deployed to the server instance that do not have availability disabled. All instances in a cluster should have the same availability value to ensure consistent behavior. |
|
memory |
(optional) Specifies the session persistence mechanism for web applications that have availability enabled. Allowed values are memory (no persistence), file (the file system) and replicated (other servers). If HADB is installed and you have selected the enterprise profile, you can also specify ha. For production environments that require session persistence, use ha. If set to memory, the manager-properties element’s session-file-name attribute specifies the file system location where the HTTP session state is stored if the server instance is gracefully shut down. This is useful for internal testing but is not supported for production environments. If set to file, the store-properties element’s directory attribute specifies the file system location where the HTTP session state is stored. Persisting to the file system is useful for internal testing but is not supported for production environments. |
|
web-method |
(optional) Specifies how often the session state is stored. Applicable only if the persistence-type is replicated or ha. Allowed values are as follows:
|
|
session |
(optional) Specifies how much of the session state is stored. Applicable only if the persistence-type is replicated or ha. Allowed values are as follows:
|
|
false |
(optional) If true, the single sign-on state is highly available. To enable single sign-on, use the sso-enabled property of the virtual-server element. |
|
availability-service store-pool-name attribute value |
(optional) Specifies the jndi-name of the jdbc-resource used for connections to the HADB for session persistence. Applicable if HADB is installed and you have selected the enterprise profile. For more information about setting up a connection pool and JDBC resource for the HADB, see the description of the configure-ha-cluster command in the Sun Java System Application Server 9.1 Reference Manual. |
If the persistence-scope attribute is set to modified-attribute , your web application must follow these guidelines:
Call setAttribute() every time the session state is modified.
Make sure there are no cross-references between attributes. The object graph under each distinct attribute key is serialized and stored separately. If there are any object cross references between the objects under each separate key, they are not serialized and deserialized correctly.
Distribute the session state across multiple attributes, or at least between a read-only attribute and a modifiable attribute.
The following table describes properties for the web-container-availability element.
Table 1–192 web-container-availability Properties
Property |
Default |
Description |
---|---|---|
none |
Specifies the name of the class that generates session IDs. If this property is not specified, the Application Server's internal session ID generator is used. It is the developer's responsibility to ensure that generated IDs are universally unique even when running on multiple JVMs on multiple machines in a cluster. Failure to ensure this in the algorithm results in nondeterministic behavior and likely corruption of HTTP session data. |
Specifies a deployed web module.
The following table describes subelements for the web-module element.
Table 1–193 web-module Subelements
Element |
Required |
Description |
---|---|---|
zero or one |
Contains a text description of this element. |
|
zero or more |
Configures a web service endpoint. |
|
zero or more |
Specifies a property or a variable. |
The following table describes attributes for the web-module element.
Table 1–194 web-module Attributes
Attribute |
Default |
Description |
---|---|---|
none |
The name of the web module. |
|
none |
The context root at which the web module is deployed. The context root can be the empty string or just /. The context root can start with the / character, but doesn’t have to. For load balancing to work, web module context roots must be unique within a cluster. See the Sun Java System Application Server 9.1 High Availability Administration Guide for more information about load balancing. Note – Some topics in the documentation pertain to features that are available only in domains that are configured to support clusters. Examples of domains that support clusters are domains that are created with the cluster profile or the enterprise profile. For information about profiles, see Usage Profiles in Sun Java System Application Server 9.1 Administration Guide. |
|
none |
A fully qualified or relative path to the directory to which the contents of the .war file have been extracted. If relative, it is relative to the following directory: domain-dir/applications/j2ee-modules/ |
|
user |
(optional) Defines the type of the resource. Allowed values are:
|
|
enabled |
true |
(optional) Determines whether the web module is enabled. |
none |
(optional) Specifies an absolute or relative path to libraries specific to this module or application. A relative path is relative to domain-dir/lib/applibs. If the path is absolute, the path must be accessible to the domain administration server (DAS), which means it must be under domain-dir. To include more than one path, use a system-specific separator, such as a colon for Solaris or a semicolon for Windows. The libraries are made available to the application in the order in which they are specified. |
|
false |
(optional) Specifies whether availability is enabled in this web application for HTTP session persistence (and potentially passivation). Availability must also be enabled for the application or stand-alone web module during deployment. For more information about availability, see availability-service. |
|
false |
(optional) Specifies whether the application has been deployed as a directory. |
Configures a web service endpoint, which can be a JAX-RPC/JAXWS 2.0 or JSR-109 web service.
ejb-module, j2ee-application, web-module
The following table describes subelements for the web-service-endpoint element.
Table 1–195 web-service-endpoint Subelements
Element |
Required |
Description |
---|---|---|
zero or more |
Specifies the registry where web service endpoint artifacts are published. |
|
zero or more |
Configures an eXtensible Stylesheet Language Transformation (XSLT) rule. |
The following table describes attributes for the web-service-endpoint element.
Table 1–196 web-service-endpoint Attributes
Attribute |
Default |
Description |
---|---|---|
none |
The fully qualified name of the web service. For a web service endpoint within an application, the format is as follows: module-name#endpoint-name For example: jaxrpc-simple.war#HelloIF For a web service endpoint that is a stand-alone module, the name is just the endpoint-name. |
|
OFF |
(optional) Specifies the monitoring level for this web service. For information about monitoring levels, see module-monitoring-levels. |
|
25 |
(optional) Specifies the maximum number of monitoring records stored for this endpoint. |
|
false |
(optional) Determines whether the visibility of this endpoint as a Java Business Integration service is enabled or disabled. |