| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
The DeployableObject interface is an abstract representation of a J2EE deployable module (JAR, WAR, RAR, EAR). A DeployableObject provides access to the module's deployment descriptor and class files.
| Method Summary | |
|  java.util.Enumeration | entries()Returns an enumeration of the module file entries. | 
|  DDBean[] | getChildBean(java.lang.String xpath)Return an array of standard beans representing the XML content returned based upon the XPath. | 
|  java.lang.Class | getClassFromScope(java.lang.String className)Retrieve the specified class from this deployable module. | 
|  DDBeanRoot | getDDBeanRoot()Return the top level standard bean representing the root of the deployment descriptor. | 
|  DDBeanRoot | getDDBeanRoot(java.lang.String filename)Returns a DDBeanRoot object for the XML instance document named. | 
|  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. | 
|  java.lang.String | getModuleDTDVersion()Deprecated. As of version 1.1 replaced by DDBeanRoot.getDDBeanRootVersion() | 
|  java.lang.String[] | getText(java.lang.String xpath)Return the XML content associated with the XPath from a deployment descriptor. | 
|  ModuleType | getType()Return the ModuleType of deployment descriptor (i.e., EAR, JAR, WAR, RAR) this deployable object represents. | 
| Method Detail | 
public ModuleType getType()
public DDBeanRoot getDDBeanRoot()
public DDBean[] getChildBean(java.lang.String xpath)
xpath - An XPath string identifying the data to
              be extracted from the deployment descriptor.
public java.lang.String[] getText(java.lang.String xpath)
xpath - An xpath string referring to a location in the
          deployment descriptor
public java.lang.Class getClassFromScope(java.lang.String className)
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.
className - Class to retrieve.
public java.lang.String getModuleDTDVersion()
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:
public DDBeanRoot getDDBeanRoot(java.lang.String filename)
                         throws java.io.FileNotFoundException,
                                javax.enterprise.deploy.model.exceptions.DDBeanCreateException
java.io.FileNotFoundException, - if the named file can not 
  be found
javax.enterprise.deploy.model.exceptions.DDBeanCreateException - if an error is encountered creating the DDBeanRoot object.
java.io.FileNotFoundExceptionpublic java.util.Enumeration entries()
public java.io.InputStream getEntry(java.lang.String name)
name - the file name relative to the root of the module.
| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved.