public abstract class AbstractDeployableObject
extends java.lang.Object
implements javax.enterprise.deploy.model.DeployableObject
DeployableObject
interface.
DeployableObject represents a bundle being deployed to an application server.
The bundle could be an individual component, like an EJB module, or it could
be a complete application containing multiple modules.
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
_altDD |
protected java.util.Vector |
_entries |
protected java.net.URL |
_overrideUrl |
protected java.util.Map |
_rootMap |
protected java.net.URL |
_url |
static java.lang.String |
WEB_WS_STD_XML_ENTRY |
static java.lang.String |
WS_STD_XML_ENTRY |
Modifier | Constructor and Description |
---|---|
|
AbstractDeployableObject(java.net.URL moduleURL,
java.lang.String altDD)
Constructs a new DeployableObject implementation.
|
protected |
AbstractDeployableObject(java.net.URL moduleURL,
java.lang.String altDD,
java.net.URL overrideURL) |
Modifier and Type | Method and Description |
---|---|
void |
cleanup() |
void |
close()
This method is called to clean the state associated
with this instance.
|
java.util.Enumeration |
entries() |
java.util.Map<java.lang.String,java.io.InputStream> |
findJarEntries(java.lang.String folder,
java.lang.String entryName)
Find the InputStreams of all embedded jars that match the given filter
and contain the given entry.
|
javax.enterprise.deploy.model.DDBean[] |
getChildBean(java.lang.String xpath) |
java.lang.Class |
getClassFromScope(java.lang.String className) |
javax.enterprise.deploy.model.DDBeanRoot |
getDDBeanRoot() |
javax.enterprise.deploy.model.DDBeanRoot |
getDDBeanRoot(java.lang.String filename) |
protected abstract java.lang.String |
getDefaultRoot()
Retrieves the name of the default deployment descriptor
|
java.io.InputStream |
getEntry(java.lang.String entryName)
Get an entry within this DeployableObject as an InputStream
instance.
|
java.io.InputStream |
getEntry(java.lang.String uri,
java.lang.String entryName)
Get an entry within a child DeployableObject as an InputStream
instance.
|
java.io.File |
getEntryAsFile(java.lang.String entryName)
Get an entry within this DeployableObject as a File
instance.
|
protected java.net.URL |
getEntryURL(java.lang.String name) |
java.io.File |
getFile()
Get the File used for this DeployableObject
|
java.lang.String |
getModuleDTDVersion() |
protected java.net.URL |
getModuleURL()
Retrieves the URL for the module represented by this DeployableObject
|
java.lang.String |
getStdXmlEntry()
Get the standard xml entry for this DeployableObject
|
java.lang.String[] |
getText(java.lang.String xpath) |
abstract javax.enterprise.deploy.shared.ModuleType |
getType() |
java.lang.String |
getWSStdXmlEntry()
Get webservices xml entry
|
oracle.xml.parser.v2.XMLDocument |
getXmlDocument(java.lang.String entryName)
Parse an XML file that is part of this J2EE file
and return the root of the DOM tree.
|
protected java.net.URL _url
protected java.lang.String _altDD
protected java.net.URL _overrideUrl
protected java.util.Map _rootMap
protected java.util.Vector _entries
public static final java.lang.String WS_STD_XML_ENTRY
public static final java.lang.String WEB_WS_STD_XML_ENTRY
public AbstractDeployableObject(java.net.URL moduleURL, java.lang.String altDD)
moduleURL
- The URL pointing to the modulealtDD
- the alternate deployment descriptor, or null
if the standard one should be usedprotected AbstractDeployableObject(java.net.URL moduleURL, java.lang.String altDD, java.net.URL overrideURL)
public void cleanup()
protected java.net.URL getModuleURL()
protected java.net.URL getEntryURL(java.lang.String name)
public abstract javax.enterprise.deploy.shared.ModuleType getType()
getType
in interface javax.enterprise.deploy.model.DeployableObject
public final javax.enterprise.deploy.model.DDBeanRoot getDDBeanRoot()
getDDBeanRoot
in interface javax.enterprise.deploy.model.DeployableObject
public final javax.enterprise.deploy.model.DDBean[] getChildBean(java.lang.String xpath)
getChildBean
in interface javax.enterprise.deploy.model.DeployableObject
public final java.lang.String[] getText(java.lang.String xpath)
getText
in interface javax.enterprise.deploy.model.DeployableObject
public java.lang.Class getClassFromScope(java.lang.String className)
getClassFromScope
in interface javax.enterprise.deploy.model.DeployableObject
public java.lang.String getModuleDTDVersion()
getModuleDTDVersion
in interface javax.enterprise.deploy.model.DeployableObject
public javax.enterprise.deploy.model.DDBeanRoot getDDBeanRoot(java.lang.String filename) throws java.io.FileNotFoundException, javax.enterprise.deploy.model.exceptions.DDBeanCreateException
getDDBeanRoot
in interface javax.enterprise.deploy.model.DeployableObject
java.io.FileNotFoundException
javax.enterprise.deploy.model.exceptions.DDBeanCreateException
public java.util.Enumeration entries()
entries
in interface javax.enterprise.deploy.model.DeployableObject
protected abstract java.lang.String getDefaultRoot()
public java.io.File getEntryAsFile(java.lang.String entryName)
entryName
- the name of the entry that needs updateExtendedRuntimeException
public java.io.InputStream getEntry(java.lang.String entryName)
getEntry
in interface javax.enterprise.deploy.model.DeployableObject
entryName
- the name of the entry to getExtendedRuntimeException
public java.io.InputStream getEntry(java.lang.String uri, java.lang.String entryName)
uri
- The uri of an embedded DeployableObject that
contains the entry to getentryName
- the name of the entry to getExtendedRuntimeException
public java.util.Map<java.lang.String,java.io.InputStream> findJarEntries(java.lang.String folder, java.lang.String entryName)
folder
- The sub-folder in which to look for jars containing the given entryentryName
- the name of the entry to find in the jarsExtendedRuntimeException
public oracle.xml.parser.v2.XMLDocument getXmlDocument(java.lang.String entryName)
entry
- the name of the XML file to retrieveExtendedRuntimeException
- if the XML document is
not found or an error occurs while extracting it,
such as a parsing error.public java.io.File getFile()
public void close()
public java.lang.String getStdXmlEntry()
public java.lang.String getWSStdXmlEntry()