xdoclet.modules.jboss.web

Class JBossWebXmlSubTask

Implemented Interfaces:
Serializable

public class JBossWebXmlSubTask
extends xdoclet.XmlSubTask

Generates jboss-web.xml deployment descriptor.
Version:
$Revision: 1.13 $
Author:
Dmitri Colebatch (dim@bigpond.net.au)
ant.element
display-name = "JBoss" name = "jbosswebxml" parent = "xdoclet.modules.web.WebDocletTask"
created
August 9, 2001

Nested Class Summary

Nested classes/interfaces inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

protected String
contextRoot
The Context Root, defaults to "" because it is not included if not set in the build.xml.
protected String
securityDomain
The Security Domain, defaults to "" because it is not included if not set in the build.xml.
protected String
version
The JBoss version to target.
protected String
virtualHost
The Virtual Host, defaults to "" because it is not included if not set in the build.xml.

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

JBossWebXmlSubTask()
Describe what the JBossWebXmlSubTask constructor does

Method Summary

void
execute()
String
getContextroot()
Return the Context Root.
String
getSecuritydomain()
Return the Security Domain.
String
getVersion()
Get the target JBoss version
String
getVirtualhost()
Return the Virtual Host.
void
setContextroot(String contextRoot)
Set the Context Root.
void
setSecuritydomain(String securityDomain)
Set the Security Domain.
void
setVersion(JBossSubTask.JBossVersionTypes version)
Set the target JBoss version
void
setVirtualhost(String virtualHost)
Set the Virtual Host.

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

Field Details

contextRoot

protected String contextRoot
The Context Root, defaults to "" because it is not included if not set in the build.xml.

securityDomain

protected String securityDomain
The Security Domain, defaults to "" because it is not included if not set in the build.xml.

version

protected String version
The JBoss version to target. Possible subversion are the values present in JBossSubTask.JBossVersionTypes

virtualHost

protected String virtualHost
The Virtual Host, defaults to "" because it is not included if not set in the build.xml.

Constructor Details

JBossWebXmlSubTask

public JBossWebXmlSubTask()
Describe what the JBossWebXmlSubTask constructor does

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

getSecuritydomain

public String getSecuritydomain()
Return the Security Domain.
Returns:
The Security Domain value

getVersion

public String getVersion()
Get the target JBoss version
Returns:
the version

getVirtualhost

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

setContextroot

public void setContextroot(String contextRoot)
Set the Context Root.
Parameters:
contextRoot - The new Context Root value

setSecuritydomain

public void setSecuritydomain(String securityDomain)
Set the Security Domain.
Parameters:
securityDomain - The new Security Domain value

setVersion

public void setVersion(JBossSubTask.JBossVersionTypes version)
Set the target JBoss version
Parameters:
version - the version

setVirtualhost

public void setVirtualhost(String virtualHost)
Set the Virtual Host.
Parameters:
virtualHost - The new Virtual Host value