Generates WebSphere specific deployment descriptors for Web modules. The following files are generated:
ibm-web-bnd.xmi and ibm-web-ext.xmi.
NOTE: Since the WebSphere specific deployment descriptors depend on that id's are set in the web.xml file you must
genererate it with useIds set to true, e.g.
<deploymentdescriptor useIds="true"/>
.
This Ant task defines the following attributes (the rest of the attributes in the list below comes from its
baseclass):
- virtualHostName
- reloadInterval
- reloadingEnabled
- defaultErrorPage
- additionalClassPath
- fileServingEnabled
- directoryBrowsingEnabled
- serveServletsByClassnameEnabled
- preCompileJSPs
- autoRequestEncoding
- autoResponseEncoding
- autoLoadFilters
NOTE: All attributes except "virtualHostName" are IBM specific WebSphere extensions to the web.xml file and are
the same as the attributes that can be found in the IBM WSAD wizard (v5.1.2) for Web Deployment Descriptors (see tab
"Extensions" and section "General")
engineStarted
protected void engineStarted()
throws xdoclet.XDocletException
TODO: Describe what the method does
- engineStarted in interface xdoclet.TemplateSubTask
xdoclet.XDocletException
-
execute
public void execute()
throws xdoclet.XDocletException
Called by xdoclet to execute the subtask.
- execute in interface xdoclet.TemplateSubTask
xdoclet.XDocletException
-
getAdditionalClassPath
public String getAdditionalClassPath()
getAutoLoadFilters
public String getAutoLoadFilters()
getAutoRequestEncoding
public String getAutoRequestEncoding()
getAutoResponseEncoding
public String getAutoResponseEncoding()
getDefaultErrorPage
public String getDefaultErrorPage()
getDirectoryBrowsingEnabled
public String getDirectoryBrowsingEnabled()
getFileServingEnabled
public String getFileServingEnabled()
getPreCompileJSPs
public String getPreCompileJSPs()
getReloadInterval
public String getReloadInterval()
getReloadingEnabled
public String getReloadingEnabled()
getServeServletsByClassnameEnabled
public String getServeServletsByClassnameEnabled()
getVirtualHostName
public String getVirtualHostName()
setAdditionalClassPath
public void setAdditionalClassPath(String additionalClassPath)
Specifies an additional class path that will be used to reference resources outside of those specified in the
archive.
setAutoLoadFilters
public void setAutoLoadFilters(String autoLoadFilters)
See IBM WebSphere documentation regarding this attribute.
setAutoRequestEncoding
public void setAutoRequestEncoding(String autoRequestEncoding)
See IBM WebSphere documentation regarding this attribute.
setAutoResponseEncoding
public void setAutoResponseEncoding(String autoResponseEncoding)
See IBM WebSphere documentation regarding this attribute.
setDefaultErrorPage
public void setDefaultErrorPage(String defaultErrorPage)
Specifies a file name for the default error page. If no other error page is specified in the application, this
error page is used.
setDirectoryBrowsingEnabled
public void setDirectoryBrowsingEnabled(String directoryBrowsingEnabled)
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.
directoryBrowsingEnabled
-
setFileServingEnabled
public void setFileServingEnabled(String fileServingEnabled)
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.
setPreCompileJSPs
public void setPreCompileJSPs(String preCompileJSPs)
Specifies wheter JSP pages will be precompiled at deploy time or not.
setReloadInterval
public void setReloadInterval(String reloadInterval)
A Reload Interval. Every 'reload interval' seconds, the web application's files are checked and reloaded if they
have been modified. Requires that reloadingEnabled is set to true.
setReloadingEnabled
public void setReloadingEnabled(String reloadingEnabled)
Specifies whether reloading is enabled.
setServeServletsByClassnameEnabled
public void setServeServletsByClassnameEnabled(String serveServletsByClassnameEnabled)
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 Serve Servlets by Classname is enabled, the servlet is
invoked by specifying SnoopServlet.
serveServletsByClassnameEnabled
-
setVirtualHostName
public void setVirtualHostName(String name)
The 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."
name
- the virtual host name
- No.Defaultis
"default_host"
validateOptions
public void validateOptions()
throws xdoclet.XDocletException
Called to validate configuration parameters.
- validateOptions in interface xdoclet.TemplateSubTask
xdoclet.XDocletException
- Description of Exception