org.glassfish.web.deployment.node

Class WebFragmentNode

java.lang.Object

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

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

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

org.glassfish.web.deployment.node.WebCommonNode<WebFragmentDescriptor>

org.glassfish.web.deployment.node.WebFragmentNode

All Implemented Interfaces:

BundleNode, RootXMLNode<WebFragmentDescriptor>, XMLNode<WebFragmentDescriptor>

@Service
public class WebFragmentNode
extends WebCommonNode<WebFragmentDescriptor>

This node is responsible for handling the web-fragment xml tree

Version:

Author:

Shing Wai Chan

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCHEMA_ID The system ID of my documents.
static XMLElement	tag

Fields inherited from class org.glassfish.web.deployment.node.WebCommonNode

descriptor, SPEC_VERSION

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

docType, SCHEMA_LOCATION_TAG, W3C_XML_SCHEMA, W3C_XML_SCHEMA_INSTANCE

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

abstractDescriptor, handlers, localStrings, parentNode, rootNode, serviceLocator

Constructor Summary

Constructors

Constructor and Description
WebFragmentNode() Creates new WebBundleNode

Method Summary

Modifier and Type	Method and Description
WebFragmentDescriptor	getDescriptor()
protected Map<String,String>	getDispatchTable() All sub-implementation of this class can use a dispatch table to map xml element to method name on the descriptor class for setting the element value.
String	getDocType()
String	getSystemID()
List<String>	getSystemIDs()
protected XMLElement	getXMLRootTag()
String	registerBundle(Map publicIDToDTD) Register this node as a root node capable of loading entire DD files
Map<String,Class<?>>	registerRuntimeBundle(Map<String,String> publicIDToDTD, Map<String,List<Class<?>>> versionUpgrades) Registers all appropriate runtime bundle nodes for this standard node into the map.
Node	writeDescriptor(Node parent, WebFragmentDescriptor webFragmentDesc) Write the descriptor class to a DOM tree and return it

Methods inherited from class org.glassfish.web.deployment.node.WebCommonNode

addDescriptor, endElement, getSpecVersion, setElementValue

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

addBundleNodeAttributes, addPrefixMapping, appendChildNS, elementsAllowingEmptyValue, elementsPreservingWhiteSpace, getSchemaURL, setDocType, setSpecVersion, topLevelTagName, topLevelTagValue, writeMessageDestinations

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

writeDisplayableComponentInfo

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

addNamespaceDeclaration, addNodeDescriptor, appendChild, appendQNameChild, appendTextChild, appendTextChild, composeQNameValue, createDescriptor, forceAppendTextChild, getHandlerFor, getLocalPartFromQName, getOwnerDocument, getParentNode, getPrefixFromQName, getRootNode, getXMLPath, handlesElement, postParsing, registerElementHandler, registerElementHandler, resolvePrefix, setAttribute, setAttributeNS, setAttributeValue, setDescriptorInfo, setParentNode, setXMLRootTag, startElement, 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

getHandlerFor, getParentNode, getRootNode, getXMLPath, handlesElement, resolvePrefix, startElement

Field Detail

tag

public static final XMLElement tag

SCHEMA_ID

public static final String SCHEMA_ID

The system ID of my documents.

See Also:

Constant Field Values

Constructor Detail

WebFragmentNode

public WebFragmentNode()

Creates new WebBundleNode

Method Detail

registerBundle

public String registerBundle(Map publicIDToDTD)

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

Parameters:

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

Returns:

the doctype tag name

registerRuntimeBundle

public Map<String,Class<?>> registerRuntimeBundle(Map<String,String> publicIDToDTD,
                                                  Map<String,List<Class<?>>> versionUpgrades)

Description copied from interface: BundleNode

Registers all appropriate runtime bundle nodes for this standard node into the map.

The implementation class must add to the map one entry for each associated runtime descriptor node, with the entry key equal to the public ID of the runtime DTD and the value the system ID of the runtime DTD. The implementation must also return a map containing one entry for each associated runtime node, with the entry key equal to the top-level element name for the runtime descriptor and the entry value equal to the class of the runtime node.

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

Returns:

map from top-level runtime descriptor element name to the corresponding runtime node class

getDispatchTable

protected Map<String,String> getDispatchTable()

All sub-implementation of this class can use a dispatch table to map xml element to method name on the descriptor class for setting the element value.

Overrides:

getDispatchTable in class AbstractBundleNode<WebFragmentDescriptor>

Returns:

the map with the element name as a key, the setter method as a value

getXMLRootTag

protected XMLElement getXMLRootTag()

Overrides:

getXMLRootTag in class DeploymentDescriptorNode<WebFragmentDescriptor>

Returns:

the XML tag associated with this XMLNode

getDocType

public String getDocType()

Returns:

the DOCTYPE of the XML file

getSystemID

public String getSystemID()

Returns:

the SystemID of the XML file

getSystemIDs

public List<String> getSystemIDs()

Returns:

the list of SystemID of the XML schema supported

getDescriptor

public WebFragmentDescriptor getDescriptor()

Specified by:

getDescriptor in interface XMLNode<WebFragmentDescriptor>

Overrides:

getDescriptor in class DeploymentDescriptorNode<WebFragmentDescriptor>

Returns:

the descriptor instance to associate with this XMLNode

writeDescriptor

public Node writeDescriptor(Node parent,
                            WebFragmentDescriptor webFragmentDesc)

Write the descriptor class to a DOM tree and return it

Specified by:

writeDescriptor in interface XMLNode<WebFragmentDescriptor>

Overrides:

writeDescriptor in class WebCommonNode<WebFragmentDescriptor>

Parameters:

parent - node for the DOM tree

webFragmentDesc - the descriptor to write

Returns:

the DOM tree top node