javax.enterprise.deploy.model
Interface DeployableObject

All Known Subinterfaces:

J2eeApplicationObject (src)

public interface DeployableObject

A representation of a deployment module. It provides access to the deployment descriptor and class files.

getType

public ModuleType (src)  getType()

Get the module type of this deployment module

Returns:

the module type

getDDBeanRoot

public DDBeanRoot (src)  getDDBeanRoot()

Get the top level element of the deployment descriptor

Returns:

the root of the deployment descriptor

getChildBean

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

Get the child elements with the specified xpath

Parameters:

xpath - the xpath of the children

Returns:

an array of children or null if there are none

getText

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

Get the text for the given xpath

Parameters:

xpath - the xpath

Returns:

an array of Strings for the xpath or null if there are none

getClassFromScope

public java.lang.Class getClassFromScope(java.lang.String className)

Retrieves the specified class from the deployment module

Parameters:

className - the name of the class

Returns:

the class

getModuleDTDVersion

public java.lang.String getModuleDTDVersion()

Deprecated. use DDBeanRoot.getDDBeanRootVersion

Get the dtd version

Returns:

the dtd version

getDDBeanRoot

public DDBeanRoot (src)  getDDBeanRoot(java.lang.String filename)
                         throws java.io.FileNotFoundException,
                                DDBeanCreateException (src) 

Returns a DDBeanRoot for the xml document. This method should be used to return DDBeanRoot for non deployment descriptor xml documents such as WSDL files

Parameters:

filename - the file name of the document

Returns:

the root element

Throws:

java.io.FileNotFoundException - if the file is not found

DDBeanCreateException (src) - for other errors creating the object

entries

public java.util.Enumeration entries()

Returns an enumeration of file names (as strings) for each file relative to the root of the module

Returns:

the enumeration

getEntry

public java.io.InputStream getEntry(java.lang.String name)

Get an input stream to the module entry.

Parameters:

name - the name of the module entry

Returns:

the input stream to the module entry or null if it does not exist