com.sun.enterprise.deployment.node

Class DeploymentDescriptorNode<T>

java.lang.Object

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

All Implemented Interfaces:

XMLNode<T>

Direct Known Subclasses:

ActivationSpecNode, AdministeredObjectDefinitionNode, AdminObjectNode, ApplicationParamNode, AuthMechNode, ConfigPropertyNode, ConfigurableNode, ConnectionDefNode, ConnectionFactoryDefinitionNode, DataSourceDefinitionNode, DefaultResourcePrincipalNode, DisplayableComponentNode, EjbReferenceNode, EjbRefNode, EntityManagerFactoryReferenceNode, EntityManagerReferenceNode, EnvEntryNode, GroupNode, InBoundRANode, InjectionTargetNode, JavaWebStartAccessNode, JMSConnectionFactoryDefinitionNode, JMSDestinationDefinitionNode, JnlpDocNode, LicenseNode, LifecycleCallbackNode, LocalizedNode, MailConfigurationNode, MailSessionNode, MessageDestinationRefNode, MessageDestinationRefNode, MessageDestinationRuntimeNode, MessageListenerNode, MessageNode, MessageSecurityBindingNode, MessageSecurityNode, MethodNode, ModuleNode, NameValuePairNode, OutBoundRANode, PermissionItemNode, PersistenceUnitNode, PrincipalNode, PropertiesNode, ProtectionNode, RANode, ReliabilityConfigNode, RequiredConfigNode, ResourceEnvRefNode, ResourceEnvRefNode, ResourcePropertyNode, ResourceRefNode, ResourceRefNode, RunAsNode, RuntimeBundleNode, RuntimeDescriptorNode, SecurityPermissionNode, SecurityRoleNode, SecurityRoleRefNode, ServiceRefNode, ServiceRefPortInfoRuntimeNode, WebServiceEndpointRuntimeNode, WebServiceRuntimeNode, WLServiceRefNode, WLServiceRefPortInfoRuntimeNode, WLUnSupportedNode, WLWebServiceEndpointNode, WLWebServiceEndpointNode.ServiceEndpointAddressNode, WLWebServiceEndpointNode.WSDLNode

public abstract class DeploymentDescriptorNode<T>
extends Object
implements XMLNode<T>

Superclass of all Nodes implementation XMLNode implementation represents all the DOL classes responsible for handling the XML deployment descriptors. These nodes are called by the SAX parser when reading and are constructed to build the DOM tree for saving the XML files. XMLNode are organized like a tree with one root XMLNode (which implement the RootXMLNode interface) and sub XMLNodes responsible for handling subparts of the XML documents. Sub XMLNodes register themselves to their parent XMLNode as handlers for a particular XML subtag of the tag handled by the parent XMLNode Each XMLNode is therefore associated with a xml tag (located anywhere in the tree of tags as defined by the DTD). It owns the responsibility for reading and writing the tag, its attributes and all subtags (by using delegation to sub XMLNode if necessary).

Version:

Author:

Jerome Dochez

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	abstractDescriptor
protected org.glassfish.hk2.api.ServiceLocator	habitat
protected Hashtable<String,Class>	handlers
protected static com.sun.enterprise.util.LocalStringManagerImpl	localStrings
protected XMLNode	parentNode
protected XMLNode	rootNode

Constructor Summary

Constructors

Constructor and Description
DeploymentDescriptorNode() Creates new DeploymentDescriptorNode

Method Summary

Methods

Modifier and Type	Method and Description
void	addDescriptor(Object descriptor) Adds a new DOL descriptor instance to the descriptor instance associated with this XMLNode
protected void	addNamespaceDeclaration(Element node, org.glassfish.deployment.common.Descriptor descriptor) Any node can now declare its own namespace.
protected void	addNodeDescriptor(DeploymentDescriptorNode node) Adds a new DOL descriptor instance to the descriptor associated with this XMLNode
void	addPrefixMapping(String prefix, String uri) notify of a new prefix mapping used in this document
static Element	appendChild(Node parent, String elementName) Append a new element child to the current node
void	appendQNameChild(String elementName, Node parent, String namespaceUri, String localPart, String prefix)
static Node	appendTextChild(Node parent, String elementName, int value) Append a new text child
static Node	appendTextChild(Node parent, String elementName, String text) Append a new text child
String	composeQNameValue(String prefix, String localPart)
protected Object	createDescriptor()
boolean	endElement(XMLElement element) receives notification of the end of an XML element by the Parser
static Node	forceAppendTextChild(Node parent, String elementName, String text) Append a new text child even if text is empty
T	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.
XMLNode	getHandlerFor(XMLElement element) Return the XMLNode implementation respionsible for handling the sub-element of the current node
String	getLocalPartFromQName(String qname) Return local part from qname, where qname is an xsd:QName.
protected static Document	getOwnerDocument(Node node)
XMLNode	getParentNode()
String	getPrefixFromQName(String qname)
XMLNode	getRootNode()
String	getXMLPath()
protected XMLElement	getXMLRootTag()
boolean	handlesElement(XMLElement element) Return true if the XMLNode is responisble for handling the XML element
void	postParsing() notification of the end of XML parsing for this node
protected void	registerElementHandler(XMLElement element, Class handler) register a new XMLNode handler for a particular XML tag.
void	registerElementHandler(XMLElement element, Class handler, String addMethodName) register a new XMLNode handler for a particular XML tag.
String	resolvePrefix(XMLElement element, String prefix) Resolve a QName prefix to its corresponding Namespace URI by searching up node chain starting with child.
static void	setAttribute(Element parent, String elementName, String text) Append a new attribute to an element
static void	setAttributeNS(Element element, String prefix, String namespaceURI) Set a namespace attribute on an element.
protected boolean	setAttributeValue(XMLElement elementName, XMLElement attributeName, String value) parsed an attribute of an element
protected void	setDescriptorInfo(Object target, String methodName, String value) call a setter method on a descriptor with a new value
void	setElementValue(XMLElement element, String value) receives notification of the value for a particular tag
void	setParentNode(XMLNode parentNode) set the parent node for the current instance.
protected void	setXMLRootTag(XMLElement element) sets the XML tag associated with this XMLNode
void	startElement(XMLElement element, Attributes attributes) SAX Parser API implementation, we don't really care for now.
Node	writeDescriptor(Node parent, String nodeName, T descriptor) write the descriptor class to a DOM tree and return it
Node	writeDescriptor(Node parent, T descriptor) write the descriptor class to a DOM tree and return it
Node	writeDescriptors(Node parent, String nodeName, org.glassfish.deployment.common.Descriptor parentDesc) write all occurrences of the descriptor corresponding to the current node from the parent descriptor to an JAXP DOM node and return it This API will be invoked by the parent node when the parent node writes out a mix of statically and dynamically registered sub nodes.
protected void	writeEjbReferenceDescriptors(Node parentNode, Iterator refs) write the ejb references (local or remote) to the DOM tree
protected void	writeEntityManagerFactoryReferenceDescriptors(Node parentNode, Iterator entityMgrFactoryRefs) write a list of entity manager factory reference descriptors to a DOM Tree
protected void	writeEntityManagerReferenceDescriptors(Node parentNode, Iterator entityMgrRefs) write a list of entity manager reference descriptors to a DOM Tree
protected void	writeEnvEntryDescriptors(Node parentNode, Iterator envEntries) write a list of env entry descriptors to a DOM Tree
protected void	writeJNDIEnvironmentRefs(Node node, JndiNameEnvironment descriptor) writes jndi environment references group nodes
protected void	writeLifeCycleCallbackDescriptors(Node parentNode, String tagName, Collection<LifecycleCallbackDescriptor> lifecycleCallbacks) write a list of life-cycle-callback descriptors to a DOM Tree
protected void	writeLocalizedDescriptions(Node node, org.glassfish.deployment.common.Descriptor desc) writes iocalized descriptions (if any) to the DOM node
protected void	writeMessageDestinationRefDescriptors(Node parentNode, Iterator msgDestRefs) write a list of message destination reference descriptors to a DOM Tree
protected void	writeResourceDescriptors(Node parentNode, Iterator<ResourceDescriptor> descriptorIterator) write a list of all descriptors to a DOM Tree
protected void	writeResourceEnvRefDescriptors(Node parentNode, Iterator resRefs) write a list of resource env reference descriptors to a DOM Tree
protected void	writeResourceRefDescriptors(Node parentNode, Iterator resRefs) write a list of resource reference descriptors to a DOM Tree
protected void	writeServiceReferenceDescriptors(Node parentNode, Iterator refs)
Node	writeSimpleTextDescriptor(Node parent, String nodeName, org.glassfish.deployment.common.Descriptor parentDesc) write out simple text element based on the node name to an JAXP DOM node and return it This API will be invoked by the parent node when the parent node writes out a mix of statically and dynamically registered sub nodes.
Node	writeSubDescriptors(Node node, String nodeName, org.glassfish.deployment.common.Descriptor descriptor) write out descriptor in a generic way to an JAXP DOM node and return it This API will generally be invoked when the parent node needs to write out a mix of statically and dynamically registered sub nodes.

Methods inherited from class java.lang.Object

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

Field Detail

habitat

protected org.glassfish.hk2.api.ServiceLocator habitat

handlers

protected Hashtable<String,Class> handlers

parentNode

protected XMLNode parentNode

rootNode

protected XMLNode rootNode

abstractDescriptor

protected Object abstractDescriptor

localStrings

protected static final com.sun.enterprise.util.LocalStringManagerImpl localStrings

Constructor Detail

DeploymentDescriptorNode

public DeploymentDescriptorNode()

Creates new DeploymentDescriptorNode

Method Detail

getDescriptor

public T getDescriptor()

Specified by:

getDescriptor in interface XMLNode<T>

Returns:

the descriptor instance to associate with this XMLNode

createDescriptor

protected Object createDescriptor()

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<T>

Parameters:

descriptor - the new descriptor

addNodeDescriptor

protected void addNodeDescriptor(DeploymentDescriptorNode node)

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

Parameters:

node - the sub-node adding the descriptor;

setParentNode

public void setParentNode(XMLNode parentNode)

set the parent node for the current instance.

getParentNode

public XMLNode getParentNode()

Specified by:

getParentNode in interface XMLNode<T>

Returns:

the parent node of the current instance

getRootNode

public XMLNode getRootNode()

Specified by:

getRootNode in interface XMLNode<T>

Returns:

the root node of the current instance

registerElementHandler

protected void registerElementHandler(XMLElement element,
                          Class handler)

register a new XMLNode handler for a particular XML tag.

Parameters:

element - XMLElement is the XML tag this XMLNode will handle

handler - the class implemenenting the XMLNode interface

registerElementHandler

public void registerElementHandler(XMLElement element,
                          Class handler,
                          String addMethodName)

register a new XMLNode handler for a particular XML tag.

Parameters:

element - XMLElement is the XML tag this XMLNode will handle

handler - the class implemenenting the XMLNode interface

addMethodName - is the method name for adding the descriptor extracted by the handler node to the current descriptor

getXMLRootTag

protected XMLElement getXMLRootTag()

Returns:

the XML tag associated with this XMLNode

setXMLRootTag

protected void setXMLRootTag(XMLElement element)

sets the XML tag associated with this XMLNode

getHandlerFor

public XMLNode getHandlerFor(XMLElement element)

Description copied from interface: XMLNode

Return the XMLNode implementation respionsible for handling the sub-element of the current node

Specified by:

getHandlerFor in interface XMLNode<T>

Parameters:

element - the XML element type name

Returns:

the handler registered for the subtag element of the curent XMLNode

startElement

public void startElement(XMLElement element,
                Attributes attributes)

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

Specified by:

startElement in interface XMLNode<T>

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

Parameters:

elementName - the element name

attributeName - the attribute name

value - the attribute value

Returns:

true if the attribute was processed

endElement

public boolean endElement(XMLElement element)

receives notification of the end of an XML element by the Parser

Specified by:

endElement in interface XMLNode<T>

Parameters:

element - the xml tag identification

Returns:

true if this node is done processing the XML sub tree

postParsing

public void postParsing()

notification of the end of XML parsing for this node

handlesElement

public boolean handlesElement(XMLElement element)

Description copied from interface: XMLNode

Return true if the XMLNode is responisble for handling the XML element

Specified by:

handlesElement in interface XMLNode<T>

Parameters:

element - the XML element type name

Returns:

true if the element tag can be handled by any registered sub nodes of the current XMLNode

setElementValue

public void setElementValue(XMLElement element,
                   String value)

receives notification of the value for a particular tag

Specified by:

setElementValue in interface XMLNode<T>

Parameters:

element - the xml element

value - it's associated value

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.

Returns:

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

setDescriptorInfo

protected void setDescriptorInfo(Object target,
                     String methodName,
                     String value)
                          throws NoSuchMethodException,
                                 IllegalAccessException,
                                 InvocationTargetException

call a setter method on a descriptor with a new value

Parameters:

target - the descriptor to use

methodName - the setter method to invoke

value - the new value for the field in the descriptor

Throws:

NoSuchMethodException

IllegalAccessException

InvocationTargetException

getXMLPath

public String getXMLPath()

Specified by:

getXMLPath in interface XMLNode<T>

Returns:

the XPath this XML Node is handling

writeDescriptor

public Node writeDescriptor(Node parent,
                   T descriptor)

write the descriptor class to a DOM tree and return it

Specified by:

writeDescriptor in interface XMLNode<T>

Parameters:

parent - node in the DOM tree

descriptor - the descriptor to write

Returns:

the DOM tree top node

writeDescriptor

public Node writeDescriptor(Node parent,
                   String nodeName,
                   T descriptor)

write the descriptor class to a DOM tree and return it

Parameters:

parent - node in the DOM tree

nodeName - name for the root element for this DOM tree fragment

descriptor - the descriptor to write

Returns:

the DOM tree top node

writeDescriptors

public Node writeDescriptors(Node parent,
                    String nodeName,
                    org.glassfish.deployment.common.Descriptor parentDesc)

write all occurrences of the descriptor corresponding to the current node from the parent descriptor to an JAXP DOM node and return it This API will be invoked by the parent node when the parent node writes out a mix of statically and dynamically registered sub nodes. This method should be overriden by the sub classes if it needs to be called by the parent node.

Parameters:

parent - node in the DOM tree

nodeName - the name of the node

parentDesc - parent descriptor of the descriptor to be written

Returns:

the JAXP DOM node

writeSimpleTextDescriptor

public Node writeSimpleTextDescriptor(Node parent,
                             String nodeName,
                             org.glassfish.deployment.common.Descriptor parentDesc)

write out simple text element based on the node name to an JAXP DOM node and return it This API will be invoked by the parent node when the parent node writes out a mix of statically and dynamically registered sub nodes. And this API is to write out the simple text sub element that the parent node handles itself. This method should be overriden by the sub classes if it needs to be called by the parent node.

Parameters:

parent - node in the DOM tree

nodeName - node name of the node

parentDesc - parent descriptor of the descriptor to be written

Returns:

the JAXP DOM node

writeSubDescriptors

public Node writeSubDescriptors(Node node,
                       String nodeName,
                       org.glassfish.deployment.common.Descriptor descriptor)

write out descriptor in a generic way to an JAXP DOM node and return it This API will generally be invoked when the parent node needs to write out a mix of statically and dynamically registered sub nodes.

Parameters:

node - current node in the DOM tree

nodeName - node name of the node

descriptor - the descriptor to be written

Returns:

the JAXP DOM node for this descriptor

getOwnerDocument

protected static Document getOwnerDocument(Node node)

Returns:

the Document for the given node

appendChild

public static Element appendChild(Node parent,
                  String elementName)

Append a new element child to the current node

Parameters:

parent - is the parent node for the new child element

elementName - is new element tag name

Returns:

the newly created child node

appendTextChild

public static Node appendTextChild(Node parent,
                   String elementName,
                   String text)

Append a new text child

Parameters:

parent - for the new child element

elementName - is the new element tag name

text - the text for the new element

appendTextChild

public static Node appendTextChild(Node parent,
                   String elementName,
                   int value)

Append a new text child

Parameters:

parent - for the new child element

elementName - is the new element tag name

value - the int value for the new element

forceAppendTextChild

public static Node forceAppendTextChild(Node parent,
                        String elementName,
                        String text)

Append a new text child even if text is empty

Parameters:

parent - for the new child element

elementName - is the new element tag name

text - the text for the new element

setAttribute

public static void setAttribute(Element parent,
                String elementName,
                String text)

Append a new attribute to an element

Parameters:

parent - for the new child element

elementName - is the new element tag name

text - the text for the new element

setAttributeNS

public static void setAttributeNS(Element element,
                  String prefix,
                  String namespaceURI)

Set a namespace attribute on an element.

Parameters:

element - on which to set attribute

prefix - raw prefix (without "xmlns:")

namespaceURI - namespace URI to which prefix is mapped.

writeEnvEntryDescriptors

protected void writeEnvEntryDescriptors(Node parentNode,
                            Iterator envEntries)

write a list of env entry descriptors to a DOM Tree

Parameters:

parentNode - parent node for the DOM tree

envEntries - the iterator over the descriptors to write

writeEjbReferenceDescriptors

protected void writeEjbReferenceDescriptors(Node parentNode,
                                Iterator refs)

write the ejb references (local or remote) to the DOM tree

Parameters:

parentNode - parent node for the DOM tree

refs - the set of EjbReferenceDescriptor to write

writeServiceReferenceDescriptors

protected void writeServiceReferenceDescriptors(Node parentNode,
                                    Iterator refs)

writeResourceRefDescriptors

protected void writeResourceRefDescriptors(Node parentNode,
                               Iterator resRefs)

write a list of resource reference descriptors to a DOM Tree

Parameters:

parentNode - parent node for the DOM tree

resRefs - the iterator over the descriptors to write

writeResourceEnvRefDescriptors

protected void writeResourceEnvRefDescriptors(Node parentNode,
                                  Iterator resRefs)

write a list of resource env reference descriptors to a DOM Tree

Parameters:

parentNode - parent node for the DOM tree

resRefs - the iterator over the descriptors to write

writeMessageDestinationRefDescriptors

protected void writeMessageDestinationRefDescriptors(Node parentNode,
                                         Iterator msgDestRefs)

write a list of message destination reference descriptors to a DOM Tree

Parameters:

parentNode - parent node for the DOM tree

msgDestRefs - the iterator over the descriptors to write

writeEntityManagerReferenceDescriptors

protected void writeEntityManagerReferenceDescriptors(Node parentNode,
                                          Iterator entityMgrRefs)

write a list of entity manager reference descriptors to a DOM Tree

Parameters:

parentNode - parent node for the DOM tree

entityMgrRefs - the iterator over the descriptors to write

writeEntityManagerFactoryReferenceDescriptors

protected void writeEntityManagerFactoryReferenceDescriptors(Node parentNode,
                                                 Iterator entityMgrFactoryRefs)

write a list of entity manager factory reference descriptors to a DOM Tree

Parameters:

parentNode - parent node for the DOM tree

entityMgrFactoryRefs - the iterator over the descriptors to write

writeLifeCycleCallbackDescriptors

protected void writeLifeCycleCallbackDescriptors(Node parentNode,
                                     String tagName,
                                     Collection<LifecycleCallbackDescriptor> lifecycleCallbacks)

write a list of life-cycle-callback descriptors to a DOM Tree

Parameters:

parentNode - parent node for the DOM tree

tagName - the tag name for the descriptors

lifecycleCallbacks - the iterator over the descriptors to write

writeResourceDescriptors

protected void writeResourceDescriptors(Node parentNode,
                            Iterator<ResourceDescriptor> descriptorIterator)

write a list of all descriptors to a DOM Tree

Parameters:

parentNode - parent node for the DOM tree

descriptorIterator - the iterator over the descriptors to write

writeLocalizedDescriptions

protected void writeLocalizedDescriptions(Node node,
                              org.glassfish.deployment.common.Descriptor desc)

writes iocalized descriptions (if any) to the DOM node

writeJNDIEnvironmentRefs

protected void writeJNDIEnvironmentRefs(Node node,
                            JndiNameEnvironment descriptor)

writes jndi environment references group nodes

addNamespaceDeclaration

protected void addNamespaceDeclaration(Element node,
                           org.glassfish.deployment.common.Descriptor descriptor)

Any node can now declare its own namespace. this apply to DDs only when dealing with deployment extensions. Write any declared namespace declaration

Parameters:

node - from which this namespace is declared

descriptor - containing the namespace declaration if any

addPrefixMapping

public void addPrefixMapping(String prefix,
                    String uri)

notify of a new prefix mapping used in this document

Specified by:

addPrefixMapping in interface XMLNode<T>

resolvePrefix

public String resolvePrefix(XMLElement element,
                   String prefix)

Resolve a QName prefix to its corresponding Namespace URI by searching up node chain starting with child.

Specified by:

resolvePrefix in interface XMLNode<T>

getPrefixFromQName

public String getPrefixFromQName(String qname)

Returns:

namespace URI prefix from qname, where qname is an xsd:QName, or the empty string if there is no prefix. QName ::= (Prefix ':')? LocalPart

getLocalPartFromQName

public String getLocalPartFromQName(String qname)

Return local part from qname, where qname is an xsd:QName. QName ::= (Prefix ':')? LocalPart

composeQNameValue

public String composeQNameValue(String prefix,
                       String localPart)

appendQNameChild

public void appendQNameChild(String elementName,
                    Node parent,
                    String namespaceUri,
                    String localPart,
                    String prefix)