xdoclet.modules.jboss.web

Class JBossWebXmlSubTask

public class JBossWebXmlSubTask extends XmlSubTask

Generates jboss-web.xml deployment descriptor.

Version: $Revision: 1.13 $

Author: Dmitri Colebatch (dim@bigpond.net.au)

UNKNOWN: August 9, 2001 Jon Barnett (jbarnett@pobox.com) display-name = "JBoss" name = "jbosswebxml" parent = "xdoclet.modules.web.WebDocletTask" file = "jbossweb-resource-env-ref.xml" relates-to = "jboss-web.xml" description = "An XML document * containing the optional resource-env-ref elements." file = "jbossweb-resource-ref.xml" relates-to = "jboss-web.xml" description = "An XML document * containing the optional resource-ref elements." file = "jbossweb-ejb-ref.xml" relates-to = "jboss-web.xml" description = "An XML document containing * the optional ejb-ref elements." file = "jbossweb-ejb-local-ref.xml" relates-to = "jboss-web.xml" description = "An XML document * containing the optional ejb-local-ref elements."

Field Summary
protected StringcontextRoot
The Context Root, defaults to "" because it is not included if not set in the build.xml.
protected StringsecurityDomain
The Security Domain, defaults to "" because it is not included if not set in the build.xml.
protected Stringversion
The JBoss version to target.
protected StringvirtualHost
The Virtual Host, defaults to "" because it is not included if not set in the build.xml.
Constructor Summary
JBossWebXmlSubTask()
Describe what the JBossWebXmlSubTask constructor does
Method Summary
voidexecute()
StringgetContextroot()
Return the Context Root.
StringgetSecuritydomain()
Return the Security Domain.
StringgetVersion()
Get the target JBoss version
StringgetVirtualhost()
Return the Virtual Host.
voidsetContextroot(String contextRoot)
Set the Context Root.
voidsetSecuritydomain(String securityDomain)
Set the Security Domain.
voidsetVersion(JBossSubTask.JBossVersionTypes version)
Set the target JBoss version
voidsetVirtualhost(String virtualHost)
Set the Virtual Host.

Field Detail

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 Detail

JBossWebXmlSubTask

public JBossWebXmlSubTask()
Describe what the JBossWebXmlSubTask constructor does

Method Detail

execute

public void execute()

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