DeployableObject (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: 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:: 0.1
Author:: gfink

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

getType

ModuleType getType()

Return the ModuleType of deployment descriptor (i.e., EAR, JAR, WAR, RAR) this deployable object represents. Values are found in DeploymentManager.

Returns:: The ModuleType of deployable object

getDDBeanRoot

DDBeanRoot getDDBeanRoot()

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

Returns:: A standard bean representing the deployment descriptor.

getChildBean

DDBean[] getChildBean(String xpath)

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

Parameters:: xpath - An XPath string identifying the data to be extracted from the deployment descriptor.
Returns:: a array of DDBeans or 'null' if no matching data found.

getText

String[] getText(String xpath)

Return the XML content associated with the XPath from a deployment descriptor.

Parameters:: xpath - An xpath string referring to a location in the deployment descriptor
Returns:: a list XML content or 'null' if no matching data found.

getClassFromScope

Class getClassFromScope(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.

Parameters:: className - Class to retrieve.
Returns:: Class representation of the class

getModuleDTDVersion

String getModuleDTDVersion()

Deprecated. As of version 1.1 replaced by DDBeanRoot.getDDBeanRootVersion()

Returns the DTD version number given in the XML DOCTYPE text provided in every standard J2EE module's deployment descriptor file.

Returns:

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.

getDDBeanRoot

DDBeanRoot getDDBeanRoot(String filename)
                         throws FileNotFoundException,
                                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.

Returns:: a DDBeanRoot object for the XML data.
Throws:: java.io.FileNotFoundException, - if the named file can not be found; DDBeanCreateException - if an error is encountered creating the DDBeanRoot object.; FileNotFoundException

entries

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.

Returns:: an enumeration of the archive file entries.

getEntry

InputStream getEntry(String name)

Returns the InputStream for the given entry name The file name must be relative to the root of the module.

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.

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature

DeployableObject (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

javax.enterprise.deploy.model Interface DeployableObject

getType

getDDBeanRoot

getChildBean

getText

getClassFromScope

getModuleDTDVersion

getDDBeanRoot

entries

getEntry

javax.enterprise.deploy.model
Interface DeployableObject