xdoclet.modules.web

Class WebXmlSubTask

public class WebXmlSubTask extends XmlSubTask

Generates web.xml deployment descriptor.

Version: $Revision: 1.15 $

Author: Ara Abrahamian (ara_e@email.com)

UNKNOWN: June 19, 2001 display-name = "web.xml" name = "deploymentdescriptor" parent = "xdoclet.modules.web.WebDocletTask" file = "web-settings.xml" relates-to = "web.xml" description = "An XML unparsed entity containing * (icon?, display-name?, description?, distributable?, context-param*) elements, to be used instead of generating * them from config parameters." file = "filters.xml" relates-to = "web.xml" description = "An XML unparsed entity containing the * filter elements for any additional filters not processed by XDoclet." file = "filter-mappings.xml" relates-to = "web.xml" description = "An XML unparsed entity containing * the filter-mapping elements for any additional filters not processed by XDoclet." file = "listeners.xml" relates-to = "web.xml" description = "An XML unparsed entity containing the * listener elements for any additional listeners not processed by XDoclet." file = "servlets.xml" relates-to = "web.xml" description = "An XML unparsed entity containing the * servlet elements for any additional servlets not processed by XDoclet." file = "servlet-mappings.xml" relates-to = "web.xml" description = "An XML unparsed entity containing * the servlet-mapping elements for any additional servlets not processed by XDoclet." file = "web-sec-rolerefs-{0}.xml" relates-to = "web.xml" description = "An XML unparsed entity * containing any security-role-ref elements for a servlet, to use instead of generating from web.security-role-ref * tags." file = "mime-mappings.xml" relates-to = "web.xml" description = "An XML unparsed entity containing * the mime-mapping elements for the web application." file = "welcomefiles.xml" relates-to = "web.xml" description = "XML document containing a * welcome-file-list element, used instead of welcomeFiles config parameters." file = "error-pages.xml" relates-to = "web.xml" description = "An XML unparsed entity containing the * error-page elements for the web application." file = "taglibs.xml" relates-to = "web.xml" description = "An XML unparsed entity containing taglib * elements, for tag libraries not defined in tagLibs config parameters." file = "web-resource-env-refs.xml" relates-to = "web.xml" description = "An XML unparsed entity * containing resource-env-ref elements for any resources not specified by web.resource-env-ref tags." file = "ejb-resourcerefs.xml" relates-to = "web.xml" description = "An XML unparsed entity containing * resource-ref entities for any resources not specified in web.resource-ref tags." file = "ejb-resourcerefs-{0}.xml" relates-to = "web.xml" description = "An XML unparsed entity * containing resource-ref entities for any resources for a class not specified in web.resource-ref tags." file = "web-security.xml" relates-to = "web.xml" description = "An XML unparsed entity containing the * (security-constraint*, login-config?) elements for the web application." file = "web-sec-roles.xml" relates-to = "web.xml" description = "An XML unparsed entity containing * security-role entities for any roles not specified in web.security-role tags." file = "web-env-entries.xml" relates-to = "web.xml" description = "An XML unparsed entity containing * env-entry entities for any entries not specified in web.env-entry tags." file = "web-env-entries-{0}.xml" relates-to = "web.xml" description = "An XML unparsed entity * containing env-entry entities for any entries for a class not specified in web.env-entry tags." file = "web-ejbrefs.xml" relates-to = "web.xml" description = "An XML unparsed entity containing * ejb-ref entities for any EJB references not specified in web.ejb-ref tags." file = "web-ejbrefs-{0}.xml" relates-to = "web.xml" description = "An XML unparsed entity containing * ejb-ref entities for any EJB references for a class not specified in web.ejb-ref tags." file = "web-ejbrefs-local.xml" relates-to = "web.xml" description = "An XML unparsed entity * containing ejb-local-ref entities for any EJB local references not specified in web.ejb-local-ref tags." file = "web-ejbrefs-local-{0}.xml" relates-to = "web.xml" description = "An XML unparsed entity * containing ejb-local-ref entities for any EJB local references for a class not specified in web.ejb-local-ref * tags." file = "taglib-functions.ent" relates-to = "taglib_tld.xml" description = "An XML unparsed entity * containing describe functions in JSP 2.0 taglibs."

Nested Class Summary
static classWebXmlSubTask.ContextParam
The declaration of a web application's servlet context initialization parameter.
static classWebXmlSubTask.ServletVersionTypes
Supported Servlet spec versions.
static classWebXmlSubTask.TagLib
Describes a JSP tag library.
static classWebXmlSubTask.WelcomeFile
The welcomefile element contains file name to use as a default welcome file, such as index.html.
Field Summary
protected ArrayListcontextParams
protected Stringdescription
protected StringdisplayName
protected booleandistributable
protected StringlargeIcon
protected StringservletSpec
protected IntegersessionTimeout
protected StringsmallIcon
protected ArrayListtagLibs
protected ArrayListwelcomeFiles
Constructor Summary
WebXmlSubTask()
Describe what the WebXmlSubTask constructor does
Method Summary
voidaddConfiguredContextparam(WebXmlSubTask.ContextParam cp)
Defines a web application context parameter.
voidaddConfiguredTaglib(WebXmlSubTask.TagLib taglib)
Declares a custom tag library for the web application's JSPs.
voidaddConfiguredWelcomefile(WebXmlSubTask.WelcomeFile file)
Defines a welcome file for the web application.
protected voidengineStarted()
Describe what the method does
voidexecute()
Describe what the method does
ArrayListgetContextParams()
Gets the ContextParams attribute of the WebXmlSubTask object
StringgetDescription()
Gets the Description attribute of the WebXmlSubTask object
StringgetDisplayname()
Gets the Displayname attribute of the WebXmlSubTask object
booleangetDistributable()
Gets the Distributable attribute of the WebXmlSubTask object
StringgetLargeicon()
Gets the Largeicon attribute of the WebXmlSubTask object
StringgetServletspec()
Gets the Servletspec attribute of the WebXmlSubTask object
IntegergetSessiontimeout()
Gets the Sessiontimeout attribute of the WebXmlSubTask object
StringgetSmallicon()
Gets the Smallicon attribute of the WebXmlSubTask object
ArrayListgetTagLibs()
Gets the TagLibs attribute of the WebXmlSubTask object
ArrayListgetWelcomeFiles()
Gets the WelcomeFiles attribute of the WebXmlSubTask object
voidsetContextParams(ArrayList contextParams)
Sets the ContextParams attribute of the WebXmlSubTask object
voidsetDescription(String description)
Optional description of the web application.
voidsetDisplayname(String displayName)
Optional short name for the web application that is intended to be displayed by tools.
voidsetDistributable(boolean distributable)
Optional boolean flag indicating whether this web application is programmed appropriately to be deployed into a distributed servlet container.
voidsetLargeicon(String largeIcon)
Optional relative path within the web application's war file of a large (32 x 32) icon image in either JPEG or GIF format.
voidsetServletspec(WebXmlSubTask.ServletVersionTypes servletSpec)
The Servlet spec version to which the web application conforms.
voidsetSessiontimeout(Integer session_timeout)
The default session timeout interval for all sessions created in this web application.
voidsetSmallicon(String smallIcon)
Optional relative path within the web application's war file of a small (16 x 16) icon image in either JPEG or GIF format.
voidsetTagLibs(ArrayList tagLibs)
Sets the TagLibs attribute of the WebXmlSubTask object
voidsetWelcomeFiles(ArrayList welcomeFiles)
Sets the WelcomeFiles attribute of the WebXmlSubTask object

Field Detail

contextParams

protected ArrayList contextParams

description

protected String description

displayName

protected String displayName

distributable

protected boolean distributable

largeIcon

protected String largeIcon

servletSpec

protected String servletSpec

sessionTimeout

protected Integer sessionTimeout

smallIcon

protected String smallIcon

tagLibs

protected ArrayList tagLibs

welcomeFiles

protected ArrayList welcomeFiles

Constructor Detail

WebXmlSubTask

public WebXmlSubTask()
Describe what the WebXmlSubTask constructor does

Method Detail

addConfiguredContextparam

public void addConfiguredContextparam(WebXmlSubTask.ContextParam cp)
Defines a web application context parameter. May occur multiple times.

Parameters: cp Describe the method parameter

addConfiguredTaglib

public void addConfiguredTaglib(WebXmlSubTask.TagLib taglib)
Declares a custom tag library for the web application's JSPs. May occur multiple times.

Parameters: taglib Describe the method parameter

addConfiguredWelcomefile

public void addConfiguredWelcomefile(WebXmlSubTask.WelcomeFile file)
Defines a welcome file for the web application. May occur multiple times.

Parameters: file Describe the method parameter

engineStarted

protected void engineStarted()
Describe what the method does

Throws: XDocletException

execute

public void execute()
Describe what the method does

Throws: XDocletException

getContextParams

public ArrayList getContextParams()
Gets the ContextParams attribute of the WebXmlSubTask object

Returns: The ContextParams value

getDescription

public String getDescription()
Gets the Description attribute of the WebXmlSubTask object

Returns: The Description value

getDisplayname

public String getDisplayname()
Gets the Displayname attribute of the WebXmlSubTask object

Returns: The Displayname value

getDistributable

public boolean getDistributable()
Gets the Distributable attribute of the WebXmlSubTask object

Returns: The Distributable value

getLargeicon

public String getLargeicon()
Gets the Largeicon attribute of the WebXmlSubTask object

Returns: The Largeicon value

getServletspec

public String getServletspec()
Gets the Servletspec attribute of the WebXmlSubTask object

Returns: The Servletspec value

getSessiontimeout

public Integer getSessiontimeout()
Gets the Sessiontimeout attribute of the WebXmlSubTask object

Returns: The Sessiontimeout value

getSmallicon

public String getSmallicon()
Gets the Smallicon attribute of the WebXmlSubTask object

Returns: The Smallicon value

getTagLibs

public ArrayList getTagLibs()
Gets the TagLibs attribute of the WebXmlSubTask object

Returns: The TagLibs value

getWelcomeFiles

public ArrayList getWelcomeFiles()
Gets the WelcomeFiles attribute of the WebXmlSubTask object

Returns: The WelcomeFiles value

setContextParams

public void setContextParams(ArrayList contextParams)
Sets the ContextParams attribute of the WebXmlSubTask object

Parameters: contextParams The new ContextParams value

UNKNOWN:

setDescription

public void setDescription(String description)
Optional description of the web application.

Parameters: description The new Description value

setDisplayname

public void setDisplayname(String displayName)
Optional short name for the web application that is intended to be displayed by tools.

Parameters: displayName The new Displayname value

setDistributable

public void setDistributable(boolean distributable)
Optional boolean flag indicating whether this web application is programmed appropriately to be deployed into a distributed servlet container.

Parameters: distributable The new Distributable value

setLargeicon

public void setLargeicon(String largeIcon)
Optional relative path within the web application's war file of a large (32 x 32) icon image in either JPEG or GIF format.

Parameters: largeIcon The new largeIcon value

setServletspec

public void setServletspec(WebXmlSubTask.ServletVersionTypes servletSpec)
The Servlet spec version to which the web application conforms.

Parameters: servletSpec The new Servletspec value

setSessiontimeout

public void setSessiontimeout(Integer session_timeout)
The default session timeout interval for all sessions created in this web application. The specified timeout must be expressed in a whole number of minutes. If the timeout is 0 or less, the container ensures the default behaviour of sessions is never to time out.

Parameters: session_timeout The new Sessiontimeout value

setSmallicon

public void setSmallicon(String smallIcon)
Optional relative path within the web application's war file of a small (16 x 16) icon image in either JPEG or GIF format.

Parameters: smallIcon The new smallIcon value

setTagLibs

public void setTagLibs(ArrayList tagLibs)
Sets the TagLibs attribute of the WebXmlSubTask object

Parameters: tagLibs The new TagLibs value

UNKNOWN:

setWelcomeFiles

public void setWelcomeFiles(ArrayList welcomeFiles)
Sets the WelcomeFiles attribute of the WebXmlSubTask object

Parameters: welcomeFiles The new WelcomeFiles value

UNKNOWN: