PayaraWebBundleRuntimeNode (Payara Project 6.2022.1.Alpha3 API)

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
    - - org.glassfish.web.deployment.node.runtime.gf.GFWebBundleRuntimeNode
      - org.glassfish.web.deployment.node.runtime.gf.PayaraWebBundleRuntimeNode

All Implemented Interfaces:

RootXMLNode<WebBundleDescriptorImpl>, XMLNode<WebBundleDescriptorImpl>
```
public class PayaraWebBundleRuntimeNode
extends GFWebBundleRuntimeNode
```
This class is responsible for handling payara-web.xml in the web bundle

Author:

jonathan coustick

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, handlers, localStrings, parentNode, rootNode, serviceLocator

Constructor Summary

Constructors
Constructor Description

PayaraWebBundleRuntimeNode()

PayaraWebBundleRuntimeNode(WebBundleDescriptorImpl descriptor)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDocType()`
`String`	`getSystemID()`
`protected XMLElement`	`getXMLRootTag()`
`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

Methods inherited from class org.glassfish.web.deployment.node.runtime.gf.WebBundleRuntimeNode
addDescriptor, getSunDescriptor, getSystemIDs, init, setAttributeValue, setElementValue, startElement, writeDescriptor

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
  - PayaraWebBundleRuntimeNode
```
public PayaraWebBundleRuntimeNode(WebBundleDescriptorImpl descriptor)
```
  - PayaraWebBundleRuntimeNode
```
public PayaraWebBundleRuntimeNode()
```
- Method Detail
  - getXMLRootTag
```
protected XMLElement getXMLRootTag()
```
    Overrides:
    
    getXMLRootTag in class GFWebBundleRuntimeNode
    
    Returns:
    
    the XML tag associated with this XMLNode
  - getDocType
```
public String getDocType()
```
    Specified by:
    
    getDocType in interface RootXMLNode<WebBundleDescriptorImpl>
    
    Overrides:
    
    getDocType in class GFWebBundleRuntimeNode
    
    Returns:
    
    the DOCTYPE that should be written to the XML file
  - getSystemID
```
public String getSystemID()
```
    Specified by:
    
    getSystemID in interface RootXMLNode<WebBundleDescriptorImpl>
    
    Overrides:
    
    getSystemID in class GFWebBundleRuntimeNode
    
    Returns:
    
    the SystemID of the XML file
  - 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