org.codehaus.cargo.module.webapp.jboss

Class JBossWebXml

java.lang.Object

org.jdom.Document

org.codehaus.cargo.module.AbstractDescriptor

org.codehaus.cargo.module.webapp.jboss.JBossWebXml

All Implemented Interfaces:

Serializable, Cloneable, Descriptor, VendorDescriptor, VendorWebAppDescriptor, org.jdom.Parent

public class JBossWebXml
extends AbstractDescriptor
implements VendorWebAppDescriptor

Encapsulates the DOM representation of a web deployment descriptor jboss-web.xml to provide convenience methods for easy access and manipulation.

Version:

$Id: JBossWebXml.java 1705 2008-09-02 13:14:55Z adriana $

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jdom.Document

baseURI

Constructor Summary

Constructors

Constructor and Description
JBossWebXml(org.jdom.Element rootElement, DescriptorType type) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEjbReference(EjbRef ref) Adds an ejb reference to the descriptor.
String	getContextRoot()
String	getFileName() Returns the file name of this descriptor.

Methods inherited from class org.codehaus.cargo.module.AbstractDescriptor

addElement, checkElement, createNestedText, getChildText, getChildText, getDescriptorType, getDocument, getElements, getElements, getImmediateChild, getInsertionPointFor, getNestedElements, getNestedText, getTagByIdentifier, getTagByIdentifier, getTags, getTags, getText

Methods inherited from class org.jdom.Document

addContent, addContent, addContent, addContent, clone, cloneContent, detachRootElement, equals, getBaseURI, getContent, getContent, getContent, getContentSize, getDescendants, getDescendants, getDocType, getParent, getProperty, getRootElement, hashCode, hasRootElement, indexOf, removeContent, removeContent, removeContent, removeContent, setBaseURI, setContent, setContent, setContent, setContent, setDocType, setProperty, setRootElement, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.codehaus.cargo.module.Descriptor

addElement, getDescriptorType, getDocument, getRootElement, getTagByIdentifier, getTags

Methods inherited from interface org.jdom.Parent

clone, cloneContent, getContent, getContent, getContent, getContentSize, getDescendants, getDescendants, getParent, indexOf, removeContent, removeContent, removeContent, removeContent

Constructor Detail

JBossWebXml

public JBossWebXml(org.jdom.Element rootElement,
           DescriptorType type)

Constructor.

Parameters:

rootElement - The root document element

type - The document type

Method Detail

getContextRoot

public String getContextRoot()

Returns:

the context root element found in the jboss-web.xml file or null if not defined

getFileName

public final String getFileName()

Returns the file name of this descriptor. For example "web.xml", "weblogic.xml", etc.

Specified by:

getFileName in interface Descriptor

Returns:

the file name

See Also:

Descriptor.getFileName()

addEjbReference

public void addEjbReference(EjbRef ref)

Adds an ejb reference to the descriptor.

Specified by:

addEjbReference in interface VendorWebAppDescriptor

Parameters:

ref - ejb reference to add to the descriptor