javax.enterprise.deploy.model

Interface DeployableObject

All Known Subinterfaces:

J2eeApplicationObject

public interface DeployableObject

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

Version:

$Revision$

Author:

Adrian Brock

Method Summary

Methods

Modifier and Type	Method and Description
Enumeration	entries() Returns an enumeration of file names (as strings) for each file relative to the root of the module
DDBean[]	getChildBean(String xpath) Get the child elements with the specified xpath
Class	getClassFromScope(String className) Retrieves the specified class from the deployment module
DDBeanRoot	getDDBeanRoot() Get the top level element of the deployment descriptor
DDBeanRoot	getDDBeanRoot(String filename) Returns a DDBeanRoot for the xml document.
InputStream	getEntry(String name) Get an input stream to the module entry.
String	getModuleDTDVersion() Deprecated. use DDBeanRoot.getDDBeanRootVersion
String[]	getText(String xpath) Get the text for the given xpath
ModuleType	getType() Get the module type of this deployment module

Method Detail

getType

ModuleType getType()

Get the module type of this deployment module

Returns:

the module type

getDDBeanRoot

DDBeanRoot getDDBeanRoot()

Get the top level element of the deployment descriptor

Returns:

the root of the deployment descriptor

getChildBean

DDBean[] getChildBean(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

String[] getText(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

Class getClassFromScope(String className)

Retrieves the specified class from the deployment module

Parameters:

className - the name of the class

Returns:

the class

getModuleDTDVersion

String getModuleDTDVersion()

Deprecated. use DDBeanRoot.getDDBeanRootVersion

Get the dtd version

Returns:

the dtd version

getDDBeanRoot

DDBeanRoot getDDBeanRoot(String filename)
                         throws FileNotFoundException,
                                DDBeanCreateException

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:

FileNotFoundException - if the file is not found

DDBeanCreateException - for other errors creating the object

entries

Enumeration entries()

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

Returns:

the enumeration

getEntry

InputStream getEntry(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