JBossWebXml (Codehaus Cargo 1.10.12 API)

java.lang.Object
- org.jdom2.Document
- - org.codehaus.cargo.module.AbstractDescriptor
  - - org.codehaus.cargo.module.webapp.jboss.JBossWebXml

All Implemented Interfaces:

Serializable, Cloneable, Descriptor, VendorDescriptor, VendorWebAppDescriptor, org.jdom2.NamespaceAware, org.jdom2.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.

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.jdom2.Document
  baseURI

Constructor Summary

Constructors
Constructor Description

JBossWebXml(org.jdom2.Element rootElement, DescriptorType type)
Constructor.

Method Summary

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

Methods inherited from class org.codehaus.cargo.module.AbstractDescriptor
addElement, checkElement, containsElement, createNestedText, getChildText, getChildText, getContentExceptComments, getDescriptorType, getDocument, getElements, getElements, getImmediateChild, getInsertionPointFor, getNestedElements, getNestedText, getTagByIdentifier, getTagByIdentifier, getTags, getTags, getText, sameContent, sameElement

Methods inherited from class org.jdom2.Document
addContent, addContent, addContent, addContent, canContainContent, clone, cloneContent, detachRootElement, equals, getBaseURI, getContent, getContent, getContent, getContentSize, getDescendants, getDescendants, getDocType, getNamespacesInherited, getNamespacesInScope, getNamespacesIntroduced, 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, getTagByIdentifier, getTags, getTags

Methods inherited from interface org.jdom2.NamespaceAware
getNamespacesInherited, getNamespacesInScope, getNamespacesIntroduced

Methods inherited from interface org.jdom2.Parent
addContent, addContent, addContent, addContent, canContainContent, clone, cloneContent, getContent, getContent, getContent, getContentSize, getDescendants, getDescendants, getParent, indexOf, removeContent, removeContent, removeContent, removeContent

- Constructor Detail
  - JBossWebXml
```
public JBossWebXml(org.jdom2.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
  - getVirtualHost
```
public String getVirtualHost()
```
    Returns:
    
    the virtual host element found in the jboss-web.xml file or null if not defined
  - getFileName
```
public 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
  - 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