oracle.jdeveloper.deploy.dmf

Class DescriptorFactory

java.lang.Object

oracle.jdeveloper.deploy.dmf.DescriptorFactory

Direct Known Subclasses:

XmlDescriptorFactory

public abstract class DescriptorFactory
extends java.lang.Object

A DescriptorFactory is used to create new descriptor nodes. Each Factory can generate descriptors for only one Platform. First, create a DescriptorInfo object using either the createDescriptorInfoByFileName() or createDescriptorInfoByRootElement() methods. Once you have a DescriptorInfo object call one of the createXXX methods and pass in the DescriptorInfo to get back an actual node. Currently only XML Descriptors are supported, so mostly you will be calling the createXmlSourceNode method, which returns an XmlSourceNode that can be manipulated by using DOM methods in the XML Editing Framework.

 Example:
 
 Platform platform;
 DescriptorFactory factory;
 DescriptorInfo descInfo ;
 
 try {
   platform = PlatformRegistry.getPlatformRegistry().getPlatform(Platform.OC4J, "10.1.3")
   factory  = DescriptorManager.getDescriptorFactory( platform );
   
   descInfo = factory.createDescriptorInfoByFileName("web.xml");
   XmlSourceNode node = factory.createXmlSourceNode( descInfo, url1 );
   // Use the Node
   
   descInfo = factory.createDescriptorInfoByFileName("application.xml");
   node = factory.createXmlSourceNode( descInfo, url2);
   // Use the Node
   
 }
 catch ( MetadataException e) {}
 

Method Summary

Methods

Modifier and Type	Method and Description
abstract DescriptorInfo	createDescriptorInfoByFileName(java.lang.String fileName) Create a DescriptorInfo object by specifying the file name under which it is commonly found ( e.g "web.xml", "application.xml", "orion-ejb-jar.xml", etc).
abstract DescriptorInfo	createDescriptorInfoByRootElement(java.lang.String rootElement) Create a DescriptorInfo object by specifying the XML root element.
abstract oracle.bali.xml.addin.XMLSourceNode	createXMLSourceNode(XmlDescriptorInfo descriptorInfo, java.net.URL url)
abstract oracle.bali.xml.addin.XMLSourceNode	findOrCreateXmlSourceNode(XmlDescriptorInfo descriptor, Project project)
Platform	getPlatform()

Methods inherited from class java.lang.Object

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

Method Detail

getPlatform

public Platform getPlatform()

createXMLSourceNode

public abstract oracle.bali.xml.addin.XMLSourceNode createXMLSourceNode(XmlDescriptorInfo descriptorInfo,
                                                      java.net.URL url)

findOrCreateXmlSourceNode

public abstract oracle.bali.xml.addin.XMLSourceNode findOrCreateXmlSourceNode(XmlDescriptorInfo descriptor,
                                                            Project project)

createDescriptorInfoByFileName

public abstract DescriptorInfo createDescriptorInfoByFileName(java.lang.String fileName)
                                                       throws DescriptorNotFoundException

Create a DescriptorInfo object by specifying the file name under which it is commonly found ( e.g "web.xml", "application.xml", "orion-ejb-jar.xml", etc). The actual file name where the descriptor is persisted may be different and is specified by URL when the descriptor node is created.

Parameters:

fileName -

Returns:

a DescriptorInfo

Throws:

DescriptorNotFoundException - if metadata for a descriptor with specified common file name is not available for the platform for which this factory is instantiated

See Also:

XmlDescriptorCatalog

createDescriptorInfoByRootElement

public abstract DescriptorInfo createDescriptorInfoByRootElement(java.lang.String rootElement)
                                                          throws DescriptorNotFoundException

Create a DescriptorInfo object by specifying the XML root element.

Parameters:

rootElement -

Returns:

an XmlDescriptorInfo object.

Throws:

DescriptorNotFoundException - if metadata for a descriptor with specified root-element is not available for the platform for which this factory is instantiated.

See Also:

XmlDescriptorCatalog