[Version 5.0.2]Web modules assembly settings

Use this page to set the assembly properties for web modules. Web modules are composed of one or more web components.

To view this page in the Application Assembly Tool, click

 application_instance >  Web Modules
File name
Specifies the file name of the Web module, relative to the top level of the application package.
Alternative DD
Specifies the file name for an alternative deployment descriptor file to use instead of the original deployment descriptor file in the module's JAR file.

This file is the post-assembly version of the deployment descriptor file. (The original deployment descriptor file can be edited to resolve dependencies and security information. Directing the use of the alternative deployment descriptor allows you to keep the original deployment descriptor file intact). The value of the Alternative DD property must be the full path name of the deployment descriptor file relative to the module's root directory. By convention, the file is in the ALT-INF directory. If this property is not specified, the deployment descriptor file is read directly from the module's JAR file.

Context root
Specifies the context root of the Web application. The context root is combined with the defined servlet mapping (from the WAR file) to compose the full URL that users type to access the servlet.

For example, if the context root is /gettingstarted and the servlet mapping is MySession, then the URL is http://host:port/gettingstarted/MySession.

[Version 5.0.2]http://host:9080/<contextroot>/servlet_name renders the correct page for all values except for http://host:9080/<contextroot>/servlet, which is the URL pattern to enable the extension serve servlets by class name. Use http://host:9080/<contextroot>/servlet/HelloWorld to invoke the servlet.

Classpath
Specifies the class path for resources used by the Web application, relative to the ear file..

If your Web application requires access to classes within an ear file, specify the relative path of the classes in this field.

Display name
Specifies a short name that is intended to be displayed by GUIs.
Description
Contains a description of the Web module.
Distributable
Specifies that this Web application is programmed appropriately to deploy into a distributed servlet container.
Small icon
Specifies a JPEG or GIF file containing a small image (16x16 pixels). The image is used as an icon to represent the module in a GUI.
Large icon
Specifies a JPEG or GIF file containing a large image (32x32 pixels). The image is used as an icon to represent the module in a GUI.
Session configuration
Indicates that session configuration information is present. Checking this box makes the Session timeout property editable.
Session timeout
Specifies a time period, in seconds, after which a client is considered inactive. The default value is zero, indicating that the session timeout never expires.
Login configuration -- Authentication method
Specifies an authentication method to use. As a prerequisite to gaining access to any Web resources protected by an authorization constraint, a user must authenticate by using the configured mechanism.

A Web application can authenticate a user to a Web server by using one of the following mechanisms: HTTP basic authentication, HTTP digest authentication, HTTPS client authentication, and form-based authentication.

The Login configuration properties are used to configure the authentication method that should be used, the realm name that should be used for HTTP basic authentication, and the attributes that are needed by the form-based login mechanism. Valid values for this property are Unspecified, Basic, Digest, Form, and Client certification.

HTTP digest authentication is not supported as a login configuration in this product. Also, not all login configurations are supported in all of the product's global security authentication mechanisms (Local Operating system, LTPA, and custom pluggable user registry). HTTP basic authentication and form-based login authentication are the only authentication methods supported by the Local Operating system user registry. LTPA and the custom pluggable user registry are capable of supporting HTTP basic authentication, form-based login, and HTTPS client authentication.

Login configuration -- Realm name
Specifies the realm name to use in HTTP basic authorization. It is based on a user name and password, sent as a string (with a simple Base64 encoding).

An HTTP realm is a string that allows URIs to be grouped together. For example, if a user accesses a secured resource on a Web server within the "finance realm," subsequent access to the same or different resource within the same realm does not result in a repeat prompt for a user ID and password.

Login configuration -- Login page
Specifies the location of the login form. If form-based authentication is not used, this property is disabled.
Form Login Config -- Error page
Specifies the location of the error page. If form-based authentication is not used, this property is disabled.
Reload interval
Specifies a time interval, in seconds, in which the file system of the Web application is scanned for updated files. The default is 3 seconds.
Reloading enabled
Specifies whether file reloading is enabled. The default is true.
Default error page
Specifies a file name for the default error page. If no other error page is specified in the application, this error page is used.
Additional classpath
Specifies the full class path that will be used to reference classes outside of those specified in the archive.

If your Web application requires access to classes not contained in the archive file, specify the full path for those classes in this field.

File serving enabled
Specifies whether file serving is enabled. File serving allows the application to serve static file types, such as HTML and GIF. File serving can be disabled if the application contains only dynamic components. The default value is true.
Directory browsing enabled
Specifies whether directory browsing is enabled. Directory browsing allows the application to browse disk directories. Directory browsing can be disabled if, you want to protect data. The default value is true.
Serve servlets by classname
Specifies whether a servlet can be served by requesting its class name.

Usually, servlets are served only through a URI reference. The class name is the actual name of the servlet on disk. For example, a file named SnoopServlet.java compiles into SnoopServlet.class. (This is the class name.) SnoopServlet.class is normally invoked by specifying snoop in the URI. However, if the Serve servlets by classname property is enabled, the servlet is invoked by specifying SnoopServlet. The default value is true.

Virtual hostname
Specifies a virtual host name. A virtual host is a configuration enabling a single host machine to resemble multiple host machines. This property allows you to bind the application to a virtual host in order to enable execution on that virtual host.
Filter mappings
Specifies the filter mapping declarations in this application. The container uses the filter mapping declarations to decide on the type and order of filters to apply to a request.

After the container matches the request URI to a servlet, for each filter mapping element, it determines what filters to apply based on the servlet name or the URL pattern, depending on the style specified. Filters are invoked in the same order as the one specified in the list of filter mapping elements. The value that you specify for the filter name must be the same value as that specified in the <filter><filtername> sub-element declarations in the deployment descriptor.


Related concepts
Web modules
Related tasks
Tuning performance parameter index
Related reference
Web applications: Resources for learning
Application assembly performance checklist



Searchable topic ID:   uweb_wmdprp
Last updated: Jun 21, 2007 4:55:42 PM CDT    WebSphere Application Server Network Deployment, Version 5.0.2
http://publib.boulder.ibm.com/infocenter/wasinfo/index.jsp?topic=/com.ibm.websphere.nd.doc/info/ae/ae/uweb_wmdprp.html

Library | Support | Terms of Use | Feedback