org.glassfish.web.deployment.node.runtime.gf

Class WebBundleRuntimeNode

java.lang.Object

com.sun.enterprise.deployment.node.DeploymentDescriptorNode<T>

com.sun.enterprise.deployment.node.runtime.RuntimeBundleNode<WebBundleDescriptorImpl>

org.glassfish.web.deployment.node.runtime.gf.WebBundleRuntimeNode

All Implemented Interfaces:

RootXMLNode<WebBundleDescriptorImpl>, XMLNode<WebBundleDescriptorImpl>

Direct Known Subclasses:

GFWebBundleRuntimeNode

public class WebBundleRuntimeNode
extends RuntimeBundleNode<WebBundleDescriptorImpl>

This node is responsible for handling all runtime information for web bundle.

Version:

Author:

Jerome Dochez

Field Summary

Fields inherited from class com.sun.enterprise.deployment.node.runtime.RuntimeBundleNode

descriptor, elementToNodeMappings

Fields inherited from class com.sun.enterprise.deployment.node.DeploymentDescriptorNode

abstractDescriptor, habitat, handlers, localStrings, parentNode, rootNode

Constructor Summary

Constructors

Constructor and Description
WebBundleRuntimeNode() Creates new WebBundleRuntimeNode
WebBundleRuntimeNode(WebBundleDescriptorImpl descriptor) Creates new WebBundleRuntimeNode

Method Summary

Modifier and Type	Method and Description
void	addDescriptor(Object newDescriptor) Adds a new DOL descriptor instance to the descriptor instance associated with this XMLNode
String	getDocType()
Object	getSunDescriptor()
String	getSystemID()
List<String>	getSystemIDs()
protected XMLElement	getXMLRootTag()
protected void	init() Initialize the child handlers
static String	registerBundle(Map<String,String> publicIDToDTD, Map<String,List<Class>> versionUpgrades) register this node as a root node capable of loading entire DD files
protected boolean	setAttributeValue(XMLElement elementName, XMLElement attributeName, String value) parsed an attribute of an element
void	setElementValue(XMLElement element, String value) receives notification of the value for a particular tag
void	startElement(XMLElement element, Attributes attributes) SAX Parser API implementation, we don't really care for now.
Node	writeDescriptor(Node parent, WebBundleDescriptorImpl bundleDescriptor) write the descriptor class to a DOM tree and return it

Methods inherited from class com.sun.enterprise.deployment.node.runtime.RuntimeBundleNode

appendChildNS, getDescriptor, getDispatchTable, getNodeMappings, getSpecVersion, recordNodeMapping, restrictDTDDeclarations, setDocType, setSpecVersion, writeMessageDestinationInfo

Methods inherited from class com.sun.enterprise.deployment.node.DeploymentDescriptorNode

addNamespaceDeclaration, addNodeDescriptor, addPrefixMapping, appendChild, appendQNameChild, appendTextChild, appendTextChild, composeQNameValue, createDescriptor, endElement, forceAppendTextChild, getHandlerFor, getLocalPartFromQName, getOwnerDocument, getParentNode, getPrefixFromQName, getRootNode, getXMLPath, handlesElement, postParsing, registerElementHandler, registerElementHandler, resolvePrefix, setAttribute, setAttributeNS, setDescriptorInfo, setParentNode, setXMLRootTag, writeDescriptor, writeDescriptors, writeEjbReferenceDescriptors, writeEntityManagerFactoryReferenceDescriptors, writeEntityManagerReferenceDescriptors, writeEnvEntryDescriptors, writeJNDIEnvironmentRefs, writeLifeCycleCallbackDescriptors, writeLocalizedDescriptions, writeMessageDestinationRefDescriptors, writeResourceDescriptors, writeResourceEnvRefDescriptors, writeResourceRefDescriptors, writeServiceReferenceDescriptors, writeSimpleTextDescriptor, writeSubDescriptors

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sun.enterprise.deployment.node.XMLNode

addPrefixMapping, endElement, getHandlerFor, getParentNode, getRootNode, getXMLPath, handlesElement, resolvePrefix

Constructor Detail

WebBundleRuntimeNode

public WebBundleRuntimeNode(WebBundleDescriptorImpl descriptor)

Creates new WebBundleRuntimeNode

Parameters:

descriptor -

WebBundleRuntimeNode

public WebBundleRuntimeNode()

Creates new WebBundleRuntimeNode

Method Detail

init

protected void init()

Initialize the child handlers

Overrides:

init in class RuntimeBundleNode<WebBundleDescriptorImpl>

getXMLRootTag

protected XMLElement getXMLRootTag()

Overrides:

getXMLRootTag in class DeploymentDescriptorNode<WebBundleDescriptorImpl>

Returns:

the XML tag associated with this XMLNode

getDocType

public String getDocType()

Returns:

the DOCTYPE that should be written to the XML file

getSystemID

public String getSystemID()

Returns:

the SystemID of the XML file

getSystemIDs

public List<String> getSystemIDs()

Returns:

NULL for all runtime nodes.

registerBundle

public static String registerBundle(Map<String,String> publicIDToDTD,
                                    Map<String,List<Class>> versionUpgrades)

register this node as a root node capable of loading entire DD files

Parameters:

publicIDToDTD - is a mapping between xml Public-ID to DTD

versionUpgrades - The list of upgrades from older versions to the latest schema

Returns:

the doctype tag name

getSunDescriptor

public Object getSunDescriptor()

Returns:

the descriptor instance to associate with this XMLNode

addDescriptor

public void addDescriptor(Object newDescriptor)

Adds a new DOL descriptor instance to the descriptor instance associated with this XMLNode

Specified by:

addDescriptor in interface XMLNode<WebBundleDescriptorImpl>

Overrides:

addDescriptor in class RuntimeBundleNode<WebBundleDescriptorImpl>

Parameters:

newDescriptor - the new descriptor

startElement

public void startElement(XMLElement element,
                         Attributes attributes)

Description copied from class: DeploymentDescriptorNode

SAX Parser API implementation, we don't really care for now.

Specified by:

startElement in interface XMLNode<WebBundleDescriptorImpl>

Overrides:

startElement in class DeploymentDescriptorNode<WebBundleDescriptorImpl>

Parameters:

element - the XML element type name

attributes - the specified or defaultted attritutes

setAttributeValue

protected boolean setAttributeValue(XMLElement elementName,
                                    XMLElement attributeName,
                                    String value)

parsed an attribute of an element

Overrides:

setAttributeValue in class DeploymentDescriptorNode<WebBundleDescriptorImpl>

Parameters:

elementName - the element name

attributeName - the attribute name

value - the attribute value

Returns:

true if the attribute was processed

setElementValue

public void setElementValue(XMLElement element,
                            String value)

receives notification of the value for a particular tag

Specified by:

setElementValue in interface XMLNode<WebBundleDescriptorImpl>

Overrides:

setElementValue in class RuntimeBundleNode<WebBundleDescriptorImpl>

Parameters:

element - the xml element

value - it's associated value

writeDescriptor

public Node writeDescriptor(Node parent,
                            WebBundleDescriptorImpl bundleDescriptor)

write the descriptor class to a DOM tree and return it

Specified by:

writeDescriptor in interface XMLNode<WebBundleDescriptorImpl>

Overrides:

writeDescriptor in class DeploymentDescriptorNode<WebBundleDescriptorImpl>

Parameters:

parent - node for the DOM tree

bundleDescriptor - the descriptor to write

Returns:

the DOM tree top node