javax.enterprise.deploy.model.DeployableObject
, Closable
, weblogic.deploy.api.model.WebLogicDeployableObjectInterface
WebLogicJ2eeApplicationObject
@Service public class WebLogicDeployableObject extends java.lang.Object implements Closable
DeployableObject
.
WebLogicDeployableObject encapsulates a single module for deployment purposes.
A deployment tool uses the constructors for this class to present an application module to
the deployer. When the tool is done with this object it is highly recommended that it be formally closed (see
close()
). This ensures resources are closed and removes any temporary files that may have been
created.
Applications can be part of a parent installation directory. This directory structure has the following organization:
install-root (eg myapp) -- app ----- archive (eg myapp.ear) -- plan ----- deployment plan (eg plan.xml) ----- external descriptors (eg META-INF/weblogic-application.xml ...)
Modifier and Type | Field | Description |
---|---|---|
protected java.lang.String |
contextRoot |
Modifier and Type | Method | Description |
---|---|---|
void |
close() |
Closes application resources and removes temporary files.
|
java.util.Enumeration |
entries() |
Returns an enumeration of the module file entries.
|
javax.enterprise.deploy.model.DDBean[] |
getChildBean(java.lang.String xpath) |
Returns DDBeans based on the specified xpath expression, relative to the
root element of the primary descriptor of this DeployableObject.
|
java.lang.Class |
getClassFromScope(java.lang.String className) |
Returns the Class object from this module for the named class, or null if
there is no class.
|
java.lang.String |
getContextRoot() |
|
javax.enterprise.deploy.model.DDBeanRoot |
getDDBeanRoot() |
Returns the root DDBean for this module.
|
javax.enterprise.deploy.model.DDBeanRoot |
getDDBeanRoot(java.lang.String filename) |
Returns a DDBeanRoot object for the named XML instance document.
|
javax.enterprise.deploy.model.DDBeanRoot[] |
getDDBeanRoots() |
List of DDBeanRoot objects representing all of the known deployment descriptors for this module
|
DescriptorBean |
getDescriptorBean() |
Typed descriptor bean tree for this modules standard descriptor.
|
java.io.InputStream |
getEntry(java.lang.String name) |
Returns an InputStream for the given entry name.
|
java.lang.String |
getModuleDTDVersion() |
Deprecated.
As of version 1.1, replaced by
DDBeanRoot.getDDBeanRootVersion()
|
java.io.File |
getPlan() |
|
DeploymentPlanBean |
getPlanBean() |
|
java.io.File |
getPlandir() |
|
java.lang.String[] |
getText(java.lang.String xpath) |
Returns XML content for each matching element in this module's descriptor.
|
javax.enterprise.deploy.shared.ModuleType |
getType() |
Returns the ModuleType of the deployment descriptor (for example, the EAR,
JAR, WAR, or RAR) that this DeployableObject represents.
|
void |
setContextRoot(java.lang.String contextRoot) |
|
protected void |
setLibraries(weblogic.deploy.api.internal.utils.LibrarySpec[] libraries) |
|
protected void |
setPlan(java.io.File plan) |
|
protected void |
setPlanDir(java.io.File plandir) |
|
protected void |
setUri(java.lang.String u) |
|
java.lang.String |
toString() |
Returns a String representation of the module type and archive.
|
protected void setLibraries(weblogic.deploy.api.internal.utils.LibrarySpec[] libraries)
public java.io.File getPlandir()
public java.io.File getPlan()
public DeploymentPlanBean getPlanBean() throws java.io.IOException
java.io.IOException
protected void setPlanDir(java.io.File plandir)
protected void setPlan(java.io.File plan)
public javax.enterprise.deploy.shared.ModuleType getType()
getType
in interface javax.enterprise.deploy.model.DeployableObject
public javax.enterprise.deploy.model.DDBean[] getChildBean(java.lang.String xpath)
getChildBean
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 javax.enterprise.deploy.model.DDBeanRoot getDDBeanRoot()
SessionHelper.inspect()
then it may throw
an unchecked RuntimeException indicating parse failuresgetDDBeanRoot
in interface javax.enterprise.deploy.model.DeployableObject
public java.lang.String[] getText(java.lang.String xpath)
getText
in interface javax.enterprise.deploy.model.DeployableObject
xpath
- Is an xpath expression relative to root element of this
module.public javax.enterprise.deploy.model.DDBeanRoot getDDBeanRoot(java.lang.String filename) throws java.io.FileNotFoundException, javax.enterprise.deploy.model.exceptions.DDBeanCreateException
The descriptor will be parsed and a full tree of DDBean's are created.
getDDBeanRoot
in interface javax.enterprise.deploy.model.DeployableObject
getDDBeanRoot
in interface weblogic.deploy.api.model.WebLogicDeployableObjectInterface
filename
- The full path name of the XML instance document to return,
specified from the root of the module. The path must be either relative to
the root of this module, or in the same relative location in the module's
external configuration directory.java.io.FileNotFoundException
- If the named file cannot be foundjavax.enterprise.deploy.model.exceptions.DDBeanCreateException
- If an error is encountered while creating the DDBeanRoot object.public java.util.Enumeration entries()
entries
in interface javax.enterprise.deploy.model.DeployableObject
public java.io.InputStream getEntry(java.lang.String name)
getEntry
in interface javax.enterprise.deploy.model.DeployableObject
name
- The file name relative to the root of the module.@Deprecated public java.lang.String getModuleDTDVersion()
getModuleDTDVersion
in interface javax.enterprise.deploy.model.DeployableObject
public DescriptorBean getDescriptorBean() throws java.io.IOException
java.io.IOException
public java.lang.String toString()
toString
in class java.lang.Object
public javax.enterprise.deploy.model.DDBeanRoot[] getDDBeanRoots()
protected void setUri(java.lang.String u)
public void close()
public java.lang.String getContextRoot()
public void setContextRoot(java.lang.String contextRoot)