InfoCenter Home >
6: Administer applications >
6.6: Tools and resources quick reference >
6.6.8: Administering Web modules (overview) >
6.6.8.0.aa: Assembly properties for Web modules
6.6.8.0.aa: Assembly properties for Web modules
- File name (Required, String)
- 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 postassembly 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 (Required, String)
- 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.
- Class path
- Specifies the full class path for the Web application. Specify the
values relative to the root of the EAR file and separate the values with
spaces. You should not use absolute values that reference files or directories
on the hard drive. Consider the following example directory structure in
which the file myapp.ear contains a Web module named mywebapp.war.
Classes reside in the files class1.jar and class2.zip.
myapp.ear/mywebapp.war
myapp.ear/class1.jar
myapp.ear/class2.zip
Specify class1.jar class2.zip as the value of the Class path
property. Note that loading of .class files from the EAR file is not supported,
as it is not Java 2 Platform, Enterprise Edition (J2EE) portable.
- 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 be
deployed 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.
- HTTP basic authentication is not a secure protocol because the user
password is transmitted with a simple Base64 encoding and the target server is
not authenticated. In basic authentication, the Web server requests a
Web client to authenticate the user and passes a string called the realm of
the request in which the user is to be authenticated.
- HTTP digest authentication transmits the password in encrypted
form.
- HTTPS client authentication uses HTTPS (HTTP over SSL) and requires the
user to possess a public key certificate.
- Form-based authentication allows the developer to control the appearance
of login screens.
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.
Note: 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. Because Advanced Single Server Edition
uses the local operating system as the user registry for authentication, it
can only support these two login methods. LTPA and the custom pluggable
user registry are capable of supporting HTTP basic authentication, form-based
login, and HTTPS client authentication. LTPA and the custom pluggable
user registry is available only in Advanced Edition.
- 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 (Required, String)
- Specifies the location of the login form. If form-based
authentication is not used, this property is disabled.
- Form Login Config -- Error page (Required, String)
- 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 Web application's
file system is scanned for updated files. The default is 0
(zero).
- Reloading enabled
- Specifies whether file reloading is enabled. The default is
false.
- 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 class path
- Specifies an additional class path used to reference
resources outside of those specified in the archive. Specify the values
relative to the root of the EAR file and separate the values with semicolons.
You typically use this attribute as a mechanism for extending the class path
of a WAR file without actually modifying the MANIFEST file of the file.
In general, it is better to use the Class-Path: attribute of the
MANIFEST file for assembly tasks. You should not use absolute values that
reference files or directories on the hard drive. Consider the following
WAR example directory structure in which the file myapp.ear contains
a Web module named mywebapp.war. Additional classes reside in
class1.jar and class2.zip.
myapp.ear/mywebapp.war
myapp.ear/class1.jar
myapp.ear/class2.zip
Specify class1.jar;class2.zip as the value of the additional class path
property. Note that loading of .class files from the EAR file is not
supported, as it is not J2EE portable.
- 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, for example, 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, for example, 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 Servlet Mapping reference.
The class name is the actual name of the servlet in the classpath. For example,
a servlet 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 Serve Servlets by Classname is enabled, the servlet can be
invoked by specifying servlet/SnoopServlet.
- Precompile JSPs
- Specifies whether to precompile Java Server Pages (JSP) files as part of
creating or updating the Web archive (.war) file.
Note: The Precompile JSPs option is only
available in WebSphere Application Server, Single Server Edition (AEs).
If you are running WebSphere Application Server Advanced Edition (AE),
use the JSP Batch Compiler tool to precompile your JSP files.
See the InfoCenter article, 4.2.2.2.4: Batch Compiling JSP files,
for more information.
- 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.
|
|