Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> enterprise >> deploy >> [ model overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.enterprise.deploy.model
Interface DeployableObject  

All Known Subinterfaces:

J2eeApplicationObject

---

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.

Version:

$Rev: 46019 $ $Date: 2004-09-14 02:56:06 -0700 (Tue, 14 Sep 2004) $

---

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.
java.lang.String	getModuleDTDVersion()           Deprecated. As of version 1.1, replace by DDBeanRoot.getDDBeanRootVersion()
java.lang.String[]	getText(java.lang.String xpath)
javax.enterprise.deploy.shared.ModuleType	getType()           Return the ModuleType of deployment descriptor (i.e., EAR, JAR, WAR, RAR) this deployable object represents.

 

Method Detail

getType

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.

---

getDDBeanRoot

public DDBeanRoot getDDBeanRoot()

Return the top level standard bean representing the root of the deployment descriptor.

---

getChildBean

public DDBean[] getChildBean(java.lang.String xpath)

Return an array of standard beans representing the XML content returned based upon the XPath.

---

getText

public java.lang.String[] getText(java.lang.String xpath)

---

getClassFromScope

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 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.

---

getModuleDTDVersion

public java.lang.String getModuleDTDVersion()

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.

---

getDDBeanRoot

public DDBeanRoot getDDBeanRoot(java.lang.String filename)
                         throws java.io.FileNotFoundException,
                                javax.enterprise.deploy.model.exceptions.DDBeanCreateException

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.

Since:

1.1

---

entries

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.

Since:

1.1

---

getEntry

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.

Since:

1.1

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> enterprise >> deploy >> [ model overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---