xdoclet.modules.web
public class WebXmlSubTask extends XmlSubTask
Version: $Revision: 1.15 $
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 class | WebXmlSubTask.ContextParam
The declaration of a web application's servlet context initialization parameter.
|
static class | WebXmlSubTask.ServletVersionTypes
Supported Servlet spec versions.
|
static class | WebXmlSubTask.TagLib
Describes a JSP tag library.
|
static class | WebXmlSubTask.WelcomeFile
The welcomefile element contains file name to use as a default welcome file, such as index.html.
|
Field Summary | |
---|---|
protected ArrayList | contextParams |
protected String | description |
protected String | displayName |
protected boolean | distributable |
protected String | largeIcon |
protected String | servletSpec |
protected Integer | sessionTimeout |
protected String | smallIcon |
protected ArrayList | tagLibs |
protected ArrayList | welcomeFiles |
Constructor Summary | |
---|---|
WebXmlSubTask()
Describe what the WebXmlSubTask constructor does |
Method Summary | |
---|---|
void | addConfiguredContextparam(WebXmlSubTask.ContextParam cp)
Defines a web application context parameter. |
void | addConfiguredTaglib(WebXmlSubTask.TagLib taglib)
Declares a custom tag library for the web application's JSPs. |
void | addConfiguredWelcomefile(WebXmlSubTask.WelcomeFile file)
Defines a welcome file for the web application. |
protected void | engineStarted()
Describe what the method does
|
void | execute()
Describe what the method does
|
ArrayList | getContextParams()
Gets the ContextParams attribute of the WebXmlSubTask object
|
String | getDescription()
Gets the Description attribute of the WebXmlSubTask object
|
String | getDisplayname()
Gets the Displayname attribute of the WebXmlSubTask object
|
boolean | getDistributable()
Gets the Distributable attribute of the WebXmlSubTask object
|
String | getLargeicon()
Gets the Largeicon attribute of the WebXmlSubTask object
|
String | getServletspec()
Gets the Servletspec attribute of the WebXmlSubTask object
|
Integer | getSessiontimeout()
Gets the Sessiontimeout attribute of the WebXmlSubTask object
|
String | getSmallicon()
Gets the Smallicon attribute of the WebXmlSubTask object
|
ArrayList | getTagLibs()
Gets the TagLibs attribute of the WebXmlSubTask object
|
ArrayList | getWelcomeFiles()
Gets the WelcomeFiles attribute of the WebXmlSubTask object
|
void | setContextParams(ArrayList contextParams)
Sets the ContextParams attribute of the WebXmlSubTask object
|
void | setDescription(String description)
Optional description of the web application.
|
void | setDisplayname(String displayName)
Optional short name for the web application that is intended to be displayed by tools.
|
void | setDistributable(boolean distributable)
Optional boolean flag indicating whether this web application is programmed appropriately to be deployed into a
distributed servlet container.
|
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.
|
void | setServletspec(WebXmlSubTask.ServletVersionTypes servletSpec)
The Servlet spec version to which the web application conforms.
|
void | setSessiontimeout(Integer session_timeout)
The default session timeout interval for all sessions created in this web application. |
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.
|
void | setTagLibs(ArrayList tagLibs)
Sets the TagLibs attribute of the WebXmlSubTask object
|
void | setWelcomeFiles(ArrayList welcomeFiles)
Sets the WelcomeFiles attribute of the WebXmlSubTask object
|
Parameters: cp Describe the method parameter
Parameters: taglib Describe the method parameter
Parameters: file Describe the method parameter
Throws: XDocletException
Throws: XDocletException
Returns: The ContextParams value
Returns: The Description value
Returns: The Displayname value
Returns: The Distributable value
Returns: The Largeicon value
Returns: The Servletspec value
Returns: The Sessiontimeout value
Returns: The Smallicon value
Returns: The TagLibs value
Returns: The WelcomeFiles value
Parameters: contextParams The new ContextParams value
UNKNOWN:
Parameters: description The new Description value
Parameters: displayName The new Displayname value
Parameters: distributable The new Distributable value
Parameters: largeIcon The new largeIcon value
Parameters: servletSpec The new Servletspec value
Parameters: session_timeout The new Sessiontimeout value
Parameters: smallIcon The new smallIcon value
Parameters: tagLibs The new TagLibs value
UNKNOWN:
Parameters: welcomeFiles The new WelcomeFiles value
UNKNOWN: