xdoclet.modules.ibm.websphere.web

Class WebSphereWebXmlSubTask

public class WebSphereWebXmlSubTask extends XmlSubTask

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):

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")

Version: $Revision: 1.8 $

Author: Ed Ward Magnus Larsson

UNKNOWN: 22 August 2002 display-name = "WebSphere" name = "webspherewebxml" parent = "xdoclet.modules.web.WebDocletTask"

Constructor Summary
WebSphereWebXmlSubTask()
Method Summary
protected voidengineStarted()
TODO: Describe what the method does
voidexecute()
Called by xdoclet to execute the subtask.
StringgetAdditionalClassPath()
StringgetAutoLoadFilters()
StringgetAutoRequestEncoding()
StringgetAutoResponseEncoding()
StringgetDefaultErrorPage()
StringgetDirectoryBrowsingEnabled()
StringgetFileServingEnabled()
StringgetPreCompileJSPs()
StringgetReloadingEnabled()
StringgetReloadInterval()
StringgetServeServletsByClassnameEnabled()
StringgetVirtualHostName()
voidsetAdditionalClassPath(String additionalClassPath)
Specifies an additional class path that will be used to reference resources outside of those specified in the archive.
voidsetAutoLoadFilters(String autoLoadFilters)
See IBM WebSphere documentation regarding this attribute.
voidsetAutoRequestEncoding(String autoRequestEncoding)
See IBM WebSphere documentation regarding this attribute.
voidsetAutoResponseEncoding(String autoResponseEncoding)
See IBM WebSphere documentation regarding this attribute.
voidsetDefaultErrorPage(String defaultErrorPage)
Specifies a file name for the default error page.
voidsetDirectoryBrowsingEnabled(String directoryBrowsingEnabled)
Specifies whether directory browsing is enabled.
voidsetFileServingEnabled(String fileServingEnabled)
Specifies whether file serving is enabled.
voidsetPreCompileJSPs(String preCompileJSPs)
Specifies wheter JSP pages will be precompiled at deploy time or not.
voidsetReloadingEnabled(String reloadingEnabled)
Specifies whether reloading is enabled.
voidsetReloadInterval(String reloadInterval)
A Reload Interval.
voidsetServeServletsByClassnameEnabled(String serveServletsByClassnameEnabled)
Specifies whether a servlet can be served by requesting its class name.
voidsetVirtualHostName(String name)
The virtual host name.
voidvalidateOptions()
Called to validate configuration parameters.

Constructor Detail

WebSphereWebXmlSubTask

public WebSphereWebXmlSubTask()

Method Detail

engineStarted

protected void engineStarted()
TODO: Describe what the method does

Throws: XDocletException

execute

public void execute()
Called by xdoclet to execute the subtask.

Throws: XDocletException

getAdditionalClassPath

public String getAdditionalClassPath()

Returns:

See Also: setAdditionalClassPath

getAutoLoadFilters

public String getAutoLoadFilters()

Returns:

See Also: setAutoLoadFilters

getAutoRequestEncoding

public String getAutoRequestEncoding()

Returns:

See Also: setAutoRequestEncoding

getAutoResponseEncoding

public String getAutoResponseEncoding()

Returns:

See Also: setAutoResponseEncoding

getDefaultErrorPage

public String getDefaultErrorPage()

Returns:

See Also: setDefaultErrorPage

getDirectoryBrowsingEnabled

public String getDirectoryBrowsingEnabled()

Returns:

See Also: setDirectoryBrowsingEnabled

getFileServingEnabled

public String getFileServingEnabled()

Returns:

See Also: setFileServingEnabled

getPreCompileJSPs

public String getPreCompileJSPs()

Returns:

See Also: setPreCompileJSPs

getReloadingEnabled

public String getReloadingEnabled()

Returns:

See Also: setReloadingEnabled

getReloadInterval

public String getReloadInterval()

Returns: the reload interval

See Also: setReloadInterval

getServeServletsByClassnameEnabled

public String getServeServletsByClassnameEnabled()

Returns:

See Also: setServeServletsByClassnameEnabled

getVirtualHostName

public String getVirtualHostName()

Returns: the virtual host name

See Also: setVirtualHostName

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.

Parameters: additionalClassPath

UNKNOWN: No.Defaultis ""

setAutoLoadFilters

public void setAutoLoadFilters(String autoLoadFilters)
See IBM WebSphere documentation regarding this attribute.

Parameters: autoLoadFilters

UNKNOWN: No.Defaultis "false"

setAutoRequestEncoding

public void setAutoRequestEncoding(String autoRequestEncoding)
See IBM WebSphere documentation regarding this attribute.

Parameters: autoRequestEncoding

UNKNOWN: No.Defaultis "false"

setAutoResponseEncoding

public void setAutoResponseEncoding(String autoResponseEncoding)
See IBM WebSphere documentation regarding this attribute.

Parameters: autoResponseEncoding

UNKNOWN: No.Defaultis "false"

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.

Parameters: defaultErrorPage

UNKNOWN: No.Defaultis ""

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.

Parameters: directoryBrowsingEnabled

UNKNOWN: No.Defaultis "true"

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.

Parameters: fileServingEnabled

UNKNOWN: No.Defaultis "true"

setPreCompileJSPs

public void setPreCompileJSPs(String preCompileJSPs)
Specifies wheter JSP pages will be precompiled at deploy time or not.

Parameters: preCompileJSPs

UNKNOWN: No.Defaultis "true"

setReloadingEnabled

public void setReloadingEnabled(String reloadingEnabled)
Specifies whether reloading is enabled.

Parameters: reloadingEnabled

UNKNOWN: No.Defaultis "true"

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.

Parameters: reloadInterval

See Also: setReloadingEnabled

UNKNOWN: No.Defaultis "3"

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.

Parameters: serveServletsByClassnameEnabled

UNKNOWN: No.Defaultis "true"

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."

Parameters: name the virtual host name

UNKNOWN: No.Defaultis "default_host"

validateOptions

public void validateOptions()
Called to validate configuration parameters.

Throws: XDocletException Description of Exception