xdoclet.modules.objectweb.jonas.web

Class JonasWebSubTask

Implemented Interfaces:
Serializable

public class JonasWebSubTask
extends xdoclet.XmlSubTask

Generates the web application deployment descriptor for JOnAS.
Version:
$Revision$
Author:
Andrew Stevens
ant.element
display-name = "JOnAS" name = "jonaswebxml" parent = "xdoclet.modules.web.WebDocletTask"
created
03 October 2002

Nested Class Summary

static class
JonasWebSubTask.JonasVersionTypes
JonasVersionTypes class.

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

JonasWebSubTask()
Constructor.

Method Summary

void
execute()
String
getContextroot()
Return the Context Root.
String
getHost()
Return the Host.
String
getVersion()
Gets the version attribute.
void
setContextroot(String contextRoot)
The context-root element specifies the context root for the web application.
void
setHost(String host)
The host element specifies the name of host used for deploy the web application.
void
setVersion(JonasWebSubTask.JonasVersionTypes version)
Sets the version of JOnAS.

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

JonasWebSubTask

public JonasWebSubTask()
Constructor.

Method Details

execute

public void execute()
            throws xdoclet.XDocletException
Overrides:
execute in interface xdoclet.TemplateSubTask

getContextroot

public String getContextroot()
Return the Context Root.
Returns:
The Context Root value

getHost

public String getHost()
Return the Host.
Returns:
The Host value

getVersion

public String getVersion()
Gets the version attribute.
Returns:
The version value.

setContextroot

public void setContextroot(String contextRoot)
The context-root element specifies the context root for the web application.
Parameters:
contextRoot - The new Context Root value
ant.not-required

setHost

public void setHost(String host)
The host element specifies the name of host used for deploy the web application.
Parameters:
host - The new Host value
ant.not-required

setVersion

public void setVersion(JonasWebSubTask.JonasVersionTypes version)
Sets the version of JOnAS. Supported versions are: 2.6.
Parameters:
version - The new version value. Supported versions are: 2.6.
ant.not-required
"No, default is '2.6'."