javax.enterprise.deploy.model
public interface DeployableObject
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.
|
String | getModuleDTDVersion()
A convenience method to return the deployment descriptor
document version number of the primary deployment descriptor
for the module (e.g. web.xml, ejb-jar.xml, ra.xml, application.xml,
and application-client.xml.) |
String[] | getText(String xpath) |
ModuleType | getType()
Return the ModuleType of deployment descriptor (i.e., EAR, JAR, WAR, RAR)
this deployable object represents. |
Returns: an enumeration of the archive file entries.
Since: 1.1
Parameters: xpath AAn XPath string identifying the data to be extracted from the deployment descriptor.
Returns: an array of DDBeans or null
if no matching data is found.
One use: to get all finder methods from an EJB. If the tool is attempting to package a 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 Class-Path entries.
Parameters: className Class to retrieve.
Returns: Class representation of the class
Returns: A standard bean representing the deployment descriptor.
Parameters: filename the full path name from the root of the module of the xml instance document for which a DDBeanRoot object is to be returned.
Returns: a DDBeanRoot object for the XML data.
Throws: 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.
Since: 1.1
Parameters: name the file name relative to the root of the module.
Returns: the InputStream for the given entry name or null if not found.
Since: 1.1
Deprecated: As of version 1.1, replace by DDBeanRoot.getDDBeanRootVersion()
A convenience method to return the deployment descriptor document version number of the primary deployment descriptor for the module (e.g. web.xml, ejb-jar.xml, ra.xml, application.xml, and application-client.xml.) The version number for documents webservices.xml , webservicesclient.xml and the like are not returned by this method. DDBeanRoot.getDDBeanRootVersion should be used instead. This method is being deprecated. DDBeanRoot.getDDBeanRootVersion should be used instead.Returns: a string that is the version number of the XML instance document. Null is returned if no version number can be found.
Parameters: xpath An xpath string referring to a location in the deployment descriptor
Returns: a list XML content or null
if no matching data is found.
Returns: The ModuleType of deployable object