Package org.codehaus.cargo.module.webapp.orion

Class OrionWebXml

java.lang.Object

org.jdom2.Document

org.codehaus.cargo.module.AbstractDescriptor

org.codehaus.cargo.module.webapp.orion.OrionWebXml

All Implemented Interfaces:

Serializable, Cloneable, Descriptor, VendorDescriptor, VendorWebAppDescriptor, org.jdom2.NamespaceAware, org.jdom2.Parent

public class OrionWebXml
extends AbstractDescriptor
implements VendorWebAppDescriptor

Encapsulates the DOM representation of a oracle web deployment descriptor orion-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
OrionWebXml(org.jdom2.Element rootElement, DescriptorType type)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addEjbReference(EjbRef ref)	Adds a ejb reference description to orion-web.xml.
String	getFileName()	Returns the file name of this descriptor.

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

OrionWebXml

public OrionWebXml(org.jdom2.Element rootElement,
                   DescriptorType type)

Constructor.

Parameters:

rootElement - The root document element

type - The document descriptor type

Method Detail

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 a ejb reference description to orion-web.xml.

Specified by:

addEjbReference in interface VendorWebAppDescriptor

Parameters:

ref - reference to add