|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface DeployableObject
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 | |
|---|---|
Enumeration |
entries()
Returns an enumeration of the module file entries. |
DDBean[] |
getChildBean(String xpath)
Return an array of standard beans representing the XML content returned based upon the XPath. |
Class |
getClassFromScope(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(String filename)
Returns a DDBeanRoot object for the XML instance document named. |
InputStream |
getEntry(String name)
Returns the InputStream for the given entry name The file name must be relative to the root of the module. |
String |
getModuleDTDVersion()
Deprecated. As of version 1.1 replaced by DDBeanRoot.getDDBeanRootVersion() |
String[] |
getText(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 |
|---|
ModuleType getType()
DDBeanRoot getDDBeanRoot()
DDBean[] getChildBean(String xpath)
xpath - An XPath string identifying the data to
be extracted from the deployment descriptor.
String[] getText(String xpath)
xpath - An xpath string referring to a location in the
deployment descriptor
Class getClassFromScope(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.
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:
DDBeanRoot getDDBeanRoot(String filename)
throws FileNotFoundException,
DDBeanCreateException
java.io.FileNotFoundException, - if the named file can not
be found
DDBeanCreateException - if an error is encountered creating the DDBeanRoot object.
FileNotFoundExceptionEnumeration entries()
InputStream getEntry(String name)
name - the file name relative to the root of the module.
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved.