org.glassfish.webservices.node

Class WebServicesDescriptorNode

java.lang.Object

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

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

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

org.glassfish.webservices.node.WebServicesDescriptorNode

All Implemented Interfaces:

BundleNode, RootXMLNode<BundleDescriptor>, XMLNode<BundleDescriptor>

@Service
public class WebServicesDescriptorNode
extends AbstractBundleNode<BundleDescriptor>

Root node for web services deployment descriptor

Version:

Author:

Kenneth Saks

Field Summary

Fields

Modifier and Type	Field and Description
static XMLElement	ROOT_ELEMENT
static String	SCHEMA_ID
static String	SCHEMA_ID_12
static String	SCHEMA_ID_13
static String	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
WebServicesDescriptorNode()
WebServicesDescriptorNode(BundleDescriptor descriptor)

Method Summary

Modifier and Type	Method and Description
void	addDescriptor(Object descriptor) Adds a new DOL descriptor instance to the descriptor instance associated with this XMLNode
BundleDescriptor	getDescriptor()
String	getDocType()
String	getSpecVersion()
String	getSystemID()
List<String>	getSystemIDs()
protected XMLElement	getXMLRootTag()
String	registerBundle(Map<String,String> publicIDToSystemIDMapping) Registers the standard bundle node in the map.
Map<String,Class<?>>	registerRuntimeBundle(Map<String,String> publicIDToSystemIDMapping, Map<String,List<Class<?>>> versionUpgrades) Registers all appropriate runtime bundle nodes for this standard node into the map.
void	setElementValue(XMLElement element, String value) Receives notiification of the value for a particular tag
Node	writeDescriptor(Node parent, BundleDescriptor descriptor) write the descriptor class to a DOM tree and return it

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

addBundleNodeAttributes, addPrefixMapping, appendChildNS, elementsAllowingEmptyValue, elementsPreservingWhiteSpace, getDispatchTable, 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, endElement, 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

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

Field Detail

ROOT_ELEMENT

public static final XMLElement ROOT_ELEMENT

SCHEMA_ID

public static final String SCHEMA_ID

See Also:

Constant Field Values

SCHEMA_ID_12

public static final String SCHEMA_ID_12

See Also:

Constant Field Values

SCHEMA_ID_13

public static final String SCHEMA_ID_13

See Also:

Constant Field Values

SPEC_VERSION

public static final String SPEC_VERSION

See Also:

Constant Field Values

Constructor Detail

WebServicesDescriptorNode

public WebServicesDescriptorNode()

WebServicesDescriptorNode

public WebServicesDescriptorNode(BundleDescriptor descriptor)

Method Detail

registerBundle

public String registerBundle(Map<String,String> publicIDToSystemIDMapping)

Description copied from interface: BundleNode

Registers the standard bundle node in the map.

The implementation class must add to the map an entry with the key equal to the public ID of the DTD and the value the system ID.

Parameters:

publicIDToSystemIDMapping - map prepared by the caller

Returns:

top-level element name for the standard descriptor

registerRuntimeBundle

public Map<String,Class<?>> registerRuntimeBundle(Map<String,String> publicIDToSystemIDMapping,
                                                  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

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

getXMLRootTag

protected XMLElement getXMLRootTag()

Overrides:

getXMLRootTag in class DeploymentDescriptorNode<BundleDescriptor>

Returns:

the XML tag associated with this XMLNode

setElementValue

public void setElementValue(XMLElement element,
                            String value)

Receives notiification of the value for a particular tag

Specified by:

setElementValue in interface XMLNode<BundleDescriptor>

Overrides:

setElementValue in class AbstractBundleNode<BundleDescriptor>

Parameters:

element - the xml element

value - it's associated value

addDescriptor

public void addDescriptor(Object descriptor)

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

Specified by:

addDescriptor in interface XMLNode<BundleDescriptor>

Overrides:

addDescriptor in class DeploymentDescriptorNode<BundleDescriptor>

Parameters:

descriptor - the new descriptor

getDescriptor

public BundleDescriptor getDescriptor()

Specified by:

getDescriptor in interface XMLNode<BundleDescriptor>

Overrides:

getDescriptor in class DeploymentDescriptorNode<BundleDescriptor>

Returns:

the descriptor instance to associate with this XMLNode

writeDescriptor

public Node writeDescriptor(Node parent,
                            BundleDescriptor descriptor)

write the descriptor class to a DOM tree and return it

Specified by:

writeDescriptor in interface XMLNode<BundleDescriptor>

Overrides:

writeDescriptor in class AbstractBundleNode<BundleDescriptor>

Parameters:

parent - node for the DOM tree

descriptor - to write

Returns:

the DOM tree top node

getSpecVersion

public String getSpecVersion()

Returns:

the default spec version level this node complies to