File	Doc	Category	Size	Date	Package
DeployableObject.java	API Doc	Glassfish v2 API	7472	Fri May 04 22:35:44 BST 2007	javax.enterprise.deploy.model

DeployableObject

Fields Summary

Constructors Summary

Methods Summary
public java.util.Enumeration	entries() Returns an enumeration of the module file entries. All elements in the enumeration are of type String. Each String represents a file name relative to the root of the module. return an enumeration of the archive file entries.
public DDBean[]	getChildBean(java.lang.String xpath) Return an array of standard beans representing the XML content returned based upon the XPath. param xpath An XPath string identifying the data to be extracted from the deployment descriptor. return a array of DDBeans or 'null' if no matching data found.
public java.lang.Class	getClassFromScope(java.lang.String className) Retrieve the specified class from this deployable module. One use: to get all finder methods from an EJB If the tool is attempting to package an module and retrieve a class from the package, the class request may fail. The class may not yet be available. The tool should respect the manifest cross-path entries. param className Class to retrieve. return Class representation of the class
public DDBeanRoot	getDDBeanRoot() Return the top level standard bean representing the root of the deployment descriptor. return A standard bean representing the deployment descriptor.
public DDBeanRoot	getDDBeanRoot(java.lang.String filename) Returns a DDBeanRoot object for the XML instance document named. This method should be used to return DDBeanRoot objects for non deployment descriptor XML instance documents such as WSDL files. return a DDBeanRoot object for the XML data. throws java.io.FileNotFoundException, if the named file can not be found throws javax.enterprise.deploy.model.exceptions.DDBeanCreateException if an error is encountered creating the DDBeanRoot object.
public java.io.InputStream	getEntry(java.lang.String name) Returns the InputStream for the given entry name The file name must be relative to the root of the module. param name the file name relative to the root of the module. return the InputStream for the given entry name or null if not found.
public java.lang.String	getModuleDTDVersion() Returns the DTD version number given in the XML DOCTYPE text provided in every standard J2EE module's deployment descriptor file. return a string containing the DTD version number A module's deployment descriptor file always contains a document type identifier, DOCTYPE. The DOCTYPE statement contains the module DTD version number in the label of the statement. The format of the DOCTYPE statement is: <!DOCTYPE root_element PUBLIC "-//organization//label//language" "location"> root_element - is the name of the root document in the DTD. organization - is the name of the organization responsible for the creation and maintenance of the DTD being referenced. label - is a unique descriptive name for the public text being referenced. language - is the ISO 639 language id representing the natural language encoding of th DTD. location - is the URL of the DTD. An example J2EE deployment descriptor DOCTYPE statement is: <!DOCTYPE application-client PUBLIC "-//Sun Microsystems, Inc.//DTD J2EE Application Client 1.3//EN" "http://java.sun.com/dtd/application-client_1_3.dtd"> In this example the label is, "DTD J2EE Application Client 1.3", and the DTD version number is 1.3. A call to getModuleDTDVersion would return a string containing, "1.3". This method is being deprecated. With the addition of multiple deployment descritors in components for J2EE 1.4 this method is being replaced by DDBeanRoot.getDDBeanRootVersion. deprecated As of version 1.1 replaced by DDBeanRoot.getDDBeanRootVersion()
public java.lang.String[]	getText(java.lang.String xpath) Return the XML content associated with the XPath from a deployment descriptor. param xpath An xpath string referring to a location in the deployment descriptor return a list XML content or 'null' if no matching data found.
public javax.enterprise.deploy.shared.ModuleType	getType() Return the ModuleType of deployment descriptor (i.e., EAR, JAR, WAR, RAR) this deployable object represents. Values are found in DeploymentManager. return The ModuleType of deployable object