oracle.jdeveloper.deploy.jsr88
Class AbstractDeployableObject

java.lang.Object
  oracle.jdeveloper.deploy.jsr88.AbstractDeployableObject

All Implemented Interfaces:

javax.enterprise.deploy.model.DeployableObject

Direct Known Subclasses:

CarModule, EarModule, EjbModule, RarModule, WebModule

public abstract class AbstractDeployableObject
extends java.lang.Object
implements javax.enterprise.deploy.model.DeployableObject

The base implementation of the 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.

Since:

10.1.3

Field Summary

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

Constructor Summary

	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)

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_url

protected java.net.URL _url

_altDD

protected java.lang.String _altDD

_overrideUrl

protected java.net.URL _overrideUrl

_rootMap

protected java.util.Map _rootMap

_entries

protected java.util.Vector _entries

WS_STD_XML_ENTRY

public static final java.lang.String WS_STD_XML_ENTRY

See Also:

Constant Field Values

WEB_WS_STD_XML_ENTRY

public static final java.lang.String WEB_WS_STD_XML_ENTRY

See Also:

Constant Field Values

Constructor Detail

AbstractDeployableObject

public AbstractDeployableObject(java.net.URL moduleURL,
                                java.lang.String altDD)

Constructs a new DeployableObject implementation.

Parameters:

moduleURL - The URL pointing to the module

altDD - the alternate deployment descriptor, or null if the standard one should be used

AbstractDeployableObject

protected AbstractDeployableObject(java.net.URL moduleURL,
                                   java.lang.String altDD,
                                   java.net.URL overrideURL)

Method Detail

cleanup

public void cleanup()

getModuleURL

protected java.net.URL getModuleURL()

Retrieves the URL for the module represented by this DeployableObject

Returns:

the URL of the module

getEntryURL

protected java.net.URL getEntryURL(java.lang.String name)

getType

public abstract javax.enterprise.deploy.shared.ModuleType getType()

Specified by:

getType in interface javax.enterprise.deploy.model.DeployableObject

getDDBeanRoot

public final javax.enterprise.deploy.model.DDBeanRoot getDDBeanRoot()

Specified by:

getDDBeanRoot in interface javax.enterprise.deploy.model.DeployableObject

getChildBean

public final javax.enterprise.deploy.model.DDBean[] getChildBean(java.lang.String xpath)

Specified by:

getChildBean in interface javax.enterprise.deploy.model.DeployableObject

getText

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

Specified by:

getText in interface javax.enterprise.deploy.model.DeployableObject

getClassFromScope

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

Specified by:

getClassFromScope in interface javax.enterprise.deploy.model.DeployableObject

getModuleDTDVersion

public java.lang.String getModuleDTDVersion()

Specified by:

getModuleDTDVersion in interface javax.enterprise.deploy.model.DeployableObject

getDDBeanRoot

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

Specified by:

getDDBeanRoot in interface javax.enterprise.deploy.model.DeployableObject

Throws:

java.io.FileNotFoundException

javax.enterprise.deploy.model.exceptions.DDBeanCreateException

entries

public java.util.Enumeration entries()

Specified by:

entries in interface javax.enterprise.deploy.model.DeployableObject

getDefaultRoot

protected abstract java.lang.String getDefaultRoot()

Retrieves the name of the default deployment descriptor

Returns:

the name of the default deployment descriptor for this DeployableObject

getEntryAsFile

public java.io.File getEntryAsFile(java.lang.String entryName)

Get an entry within this DeployableObject as a File instance. The returned File instance may point to a temporary file that should be deleted when no longer needed.

Parameters:

entryName - the name of the entry that needs update

Returns:

a File instance

Throws:

ExtendedRuntimeException

getEntry

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

Get an entry within this DeployableObject as an InputStream instance.

Specified by:

getEntry in interface javax.enterprise.deploy.model.DeployableObject

Parameters:

entryName - the name of the entry to get

Returns:

an InputStream instance

Throws:

ExtendedRuntimeException

getEntry

public java.io.InputStream getEntry(java.lang.String uri,
                                    java.lang.String entryName)

Get an entry within a child DeployableObject as an InputStream instance.

Parameters:

uri - The uri of an embedded DeployableObject that contains the entry to get

entryName - the name of the entry to get

Returns:

an InputStream instance

Throws:

ExtendedRuntimeException

findJarEntries

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

Parameters:

folder - The sub-folder in which to look for jars containing the given entry

entryName - the name of the entry to find in the jars

Returns:

a Map of InputStreams for the entries keyed on the uri for the jars containing them

Throws:

ExtendedRuntimeException

getXmlDocument

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

Parameters:

entry - the name of the XML file to retrieve

Returns:

the root of the DOM tree representing this XML file or null if an error occurs

Throws:

ExtendedRuntimeException - if the XML document is not found or an error occurs while extracting it, such as a parsing error.

getFile

public java.io.File getFile()

Get the File used for this DeployableObject

Returns:

the File used for this DeployableObject. It is either a J2EE archive or a directory

close

public void close()

This method is called to clean the state associated with this instance. After this method is called this instance should not be used.

getStdXmlEntry

public java.lang.String getStdXmlEntry()

Get the standard xml entry for this DeployableObject

Returns:

The standard xml entry for this DeployableObject

getWSStdXmlEntry

public java.lang.String getWSStdXmlEntry()

Get webservices xml entry

Returns:

The webservices xml entry