xdoclet.modules.ibm.websphere.web

Class WebSphereWebXmlSubTask

Implemented Interfaces:
Serializable

public class WebSphereWebXmlSubTask
extends xdoclet.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 $
Authors:
Ed Ward
Magnus Larsson
ant.element
display-name = "WebSphere" name = "webspherewebxml" parent = "xdoclet.modules.web.WebDocletTask"
created
22 August 2002

Nested Class Summary

Nested classes/interfaces inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

WebSphereWebXmlSubTask()

Method Summary

protected void
engineStarted()
TODO: Describe what the method does
void
execute()
Called by xdoclet to execute the subtask.
String
getAdditionalClassPath()
String
getAutoLoadFilters()
String
getAutoRequestEncoding()
String
getAutoResponseEncoding()
String
getDefaultErrorPage()
String
getDirectoryBrowsingEnabled()
String
getFileServingEnabled()
String
getPreCompileJSPs()
String
getReloadInterval()
String
getReloadingEnabled()
String
getServeServletsByClassnameEnabled()
String
getVirtualHostName()
void
setAdditionalClassPath(String additionalClassPath)
Specifies an additional class path that will be used to reference resources outside of those specified in the archive.
void
setAutoLoadFilters(String autoLoadFilters)
See IBM WebSphere documentation regarding this attribute.
void
setAutoRequestEncoding(String autoRequestEncoding)
See IBM WebSphere documentation regarding this attribute.
void
setAutoResponseEncoding(String autoResponseEncoding)
See IBM WebSphere documentation regarding this attribute.
void
setDefaultErrorPage(String defaultErrorPage)
Specifies a file name for the default error page.
void
setDirectoryBrowsingEnabled(String directoryBrowsingEnabled)
Specifies whether directory browsing is enabled.
void
setFileServingEnabled(String fileServingEnabled)
Specifies whether file serving is enabled.
void
setPreCompileJSPs(String preCompileJSPs)
Specifies wheter JSP pages will be precompiled at deploy time or not.
void
setReloadInterval(String reloadInterval)
A Reload Interval.
void
setReloadingEnabled(String reloadingEnabled)
Specifies whether reloading is enabled.
void
setServeServletsByClassnameEnabled(String serveServletsByClassnameEnabled)
Specifies whether a servlet can be served by requesting its class name.
void
setVirtualHostName(String name)
The virtual host name.
void
validateOptions()
Called to validate configuration parameters.

Methods inherited from class xdoclet.XmlSubTask

copyAttributesFrom, engineFinished, getDtdURL, getPublicId, getSchema, getSchemaURL, getSystemId, getUseIds, getXmlencoding, isValidateXML, setDtdURL, setPublicId, setSchema, setSchemaURL, setSystemId, setUseIds, setValidateXML, setXmlencoding, startProcess

Methods inherited from class xdoclet.TemplateSubTask

addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, engineStarted, execute, generateForClass, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGeneratedFileName, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, matchesGenerationRules, processInnerClasses, setAcceptAbstractClasses, setAcceptInterfaces, setDestinationFile, setEngine, setExtent, setExtentValue, setGenerationManager, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess, startProcessForAll, startProcessPerClass, validateOptions

Methods inherited from class xdoclet.SubTask

addConfigParam, copyAttributesFrom, execute, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, init, setDestDir, setMergeDir, setSubTaskName, validateOptions

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage

Constructor Details

WebSphereWebXmlSubTask

public WebSphereWebXmlSubTask()

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
TODO: Describe what the method does
Overrides:
engineStarted in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException -

execute

public void execute()
            throws xdoclet.XDocletException
Called by xdoclet to execute the subtask.
Overrides:
execute in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException -

getAdditionalClassPath

public String getAdditionalClassPath()
Returns:

getAutoLoadFilters

public String getAutoLoadFilters()
Returns:

getAutoRequestEncoding

public String getAutoRequestEncoding()
Returns:

getAutoResponseEncoding

public String getAutoResponseEncoding()
Returns:

getDefaultErrorPage

public String getDefaultErrorPage()
Returns:

getDirectoryBrowsingEnabled

public String getDirectoryBrowsingEnabled()
Returns:

getFileServingEnabled

public String getFileServingEnabled()
Returns:

getPreCompileJSPs

public String getPreCompileJSPs()
Returns:

getReloadInterval

public String getReloadInterval()
Returns:
the reload interval

getReloadingEnabled

public String getReloadingEnabled()
Returns:

getServeServletsByClassnameEnabled

public String getServeServletsByClassnameEnabled()
Returns:

getVirtualHostName

public String getVirtualHostName()
Returns:
the virtual host name

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 -
ant.not-required
No.Defaultis ""

setAutoLoadFilters

public void setAutoLoadFilters(String autoLoadFilters)
See IBM WebSphere documentation regarding this attribute.
Parameters:
autoLoadFilters -
ant.not-required
No.Defaultis "false"

setAutoRequestEncoding

public void setAutoRequestEncoding(String autoRequestEncoding)
See IBM WebSphere documentation regarding this attribute.
Parameters:
autoRequestEncoding -
ant.not-required
No.Defaultis "false"

setAutoResponseEncoding

public void setAutoResponseEncoding(String autoResponseEncoding)
See IBM WebSphere documentation regarding this attribute.
Parameters:
autoResponseEncoding -
ant.not-required
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 -
ant.not-required
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 -
ant.not-required
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 -
ant.not-required
No.Defaultis "true"

setPreCompileJSPs

public void setPreCompileJSPs(String preCompileJSPs)
Specifies wheter JSP pages will be precompiled at deploy time or not.
Parameters:
preCompileJSPs -
ant.not-required
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 -
ant.not-required
No.Defaultis "3"

setReloadingEnabled

public void setReloadingEnabled(String reloadingEnabled)
Specifies whether reloading is enabled.
Parameters:
reloadingEnabled -
ant.not-required
No.Defaultis "true"

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 -
ant.not-required
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
ant.not-required
No.Defaultis "default_host"

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Called to validate configuration parameters.
Overrides:
validateOptions in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException - Description of Exception