WebLogicDeployableObject (Java API Reference for Oracle WebLogic Server)

java.lang.Object
- weblogic.deploy.api.model.WebLogicDeployableObject

All Implemented Interfaces:

javax.enterprise.deploy.model.DeployableObject, Closable, weblogic.deploy.api.model.WebLogicDeployableObjectInterface

Direct Known Subclasses:

WebLogicJ2eeApplicationObject
```
@Service
public class WebLogicDeployableObject
extends java.lang.Object
implements Closable
```
This class is the WebLogic Server implementation of 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 ...)
 
 
```

Field Summary

Fields
Modifier and Type Field Description

protected java.lang.String contextRoot

Fields
Modifier and Type	Field	Description
`protected java.lang.String`	`contextRoot`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - contextRoot
```
protected java.lang.String contextRoot
```
- Method Detail
  - setLibraries
```
protected void setLibraries(weblogic.deploy.api.internal.utils.LibrarySpec[] libraries)
```
  - getPlandir
```
public java.io.File getPlandir()
```
  - getPlan
```
public java.io.File getPlan()
```
  - getPlanBean
```
public DeploymentPlanBean getPlanBean()
                               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - setPlanDir
```
protected void setPlanDir(java.io.File plandir)
```
  - setPlan
```
protected void setPlan(java.io.File plan)
```
  - getType
```
public 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.
    
    Specified by:
    
    getType in interface javax.enterprise.deploy.model.DeployableObject
  - getChildBean
```
public 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. Returns null if no DDBeans match the xpath expression.
    
    Specified by:
    
    getChildBean in interface javax.enterprise.deploy.model.DeployableObject
  - getClassFromScope
```
public 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. The scope is the module itself. This method honors the aplication's manifest class path. For EARs, this provides access to the application level classes only.
    
    Specified by:
    
    getClassFromScope in interface javax.enterprise.deploy.model.DeployableObject
  - getDDBeanRoot
```
public javax.enterprise.deploy.model.DDBeanRoot getDDBeanRoot()
```
    Returns the root DDBean for this module. If this object was created through SessionHelper.inspect() then it may throw an unchecked RuntimeException indicating parse failures
    
    Specified by:
    
    getDDBeanRoot in interface javax.enterprise.deploy.model.DeployableObject
  - getText
```
public java.lang.String[] getText(java.lang.String xpath)
```
    Returns XML content for each matching element in this module's descriptor.
    
    Specified by:
    
    getText in interface javax.enterprise.deploy.model.DeployableObject
    
    Parameters:
    
    xpath - Is an xpath expression relative to root element of this module.
  - getDDBeanRoot
```
public javax.enterprise.deploy.model.DDBeanRoot getDDBeanRoot(java.lang.String filename)
                                                       throws java.io.FileNotFoundException,
                                                              javax.enterprise.deploy.model.exceptions.DDBeanCreateException
```
    Returns a DDBeanRoot object for the named XML instance document. Use this method to return DDBeanRoot objects for secondary deployment descriptor XML instance documents, such as WSDL files or weblogic-cmp-jar.xml. The file may be in either the archive or in the external configuration directory (install-root/plan).
    The descriptor will be parsed and a full tree of DDBean's are created.
    
    Specified by:
    
    getDDBeanRoot in interface javax.enterprise.deploy.model.DeployableObject
    
    Specified by:
    
    getDDBeanRoot in interface weblogic.deploy.api.model.WebLogicDeployableObjectInterface
    
    Parameters:
    
    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.
    
    Returns:
    
    A DDBeanRoot object for the XML data.
    
    Throws:
    
    java.io.FileNotFoundException - If the named file cannot be found
    
    javax.enterprise.deploy.model.exceptions.DDBeanCreateException - If an error is encountered while creating the DDBeanRoot object.
  - entries
```
public java.util.Enumeration entries()
```
    Returns an enumeration of the module file entries. All elements in the enumeration are of type String. Each String in the returned enumeration represents a file name relative to the root of the module.
    
    Specified by:
    
    entries in interface javax.enterprise.deploy.model.DeployableObject
    
    Returns:
    
    An enumeration of the archive file entries. An empty enumeration is returned if any IO errors occur.
  - getEntry
```
public java.io.InputStream getEntry(java.lang.String name)
```
    Returns an InputStream for the given entry name. The file name must be relative to the root of the module.
    
    Specified by:
    
    getEntry in interface javax.enterprise.deploy.model.DeployableObject
    
    Parameters:
    
    name - The file name relative to the root of the module.
    
    Returns:
    
    The InputStream for the given entry name, or null if not found.
  - getModuleDTDVersion
```
@Deprecated
public java.lang.String getModuleDTDVersion()
```
    Deprecated.
    As of version 1.1, replaced by DDBeanRoot.getDDBeanRootVersion()
    
    A convenience method to return the deployment descriptor document version number of the primary deployment descriptor for this module (for example, web.xml, ejb-jar.xml, ra.xml, application.xml, or application-client.xml.) This method does not return the version number for documents such as webservices.xml and webservicesclient.xml; use DDBeanRoot.getDDBeanRootVersion instead. This method is deprecated. Use DDBeanRoot.getDDBeanRootVersion instead.
    
    Specified by:
    
    getModuleDTDVersion in interface javax.enterprise.deploy.model.DeployableObject
    
    Returns:
    
    A string that describes the version number of the XML instance document. Null is returned if no version number was found.
  - getDescriptorBean
```
public DescriptorBean getDescriptorBean()
                                 throws java.io.IOException
```
    Typed descriptor bean tree for this modules standard descriptor.
    
    Throws:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of the module type and archive.
    
    Overrides:
    
    toString in class java.lang.Object
  - getDDBeanRoots
```
public javax.enterprise.deploy.model.DDBeanRoot[] getDDBeanRoots()
```
    List of DDBeanRoot objects representing all of the known deployment descriptors for this module
  - setUri
```
protected void setUri(java.lang.String u)
```
  - close
```
public void close()
```
    Closes application resources and removes temporary files.
    
    Specified by:
    
    close in interface Closable
  - getContextRoot
```
public java.lang.String getContextRoot()
```
  - setContextRoot
```
public void setContextRoot(java.lang.String contextRoot)
```

Class WebLogicDeployableObject

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

contextRoot

Method Detail

setLibraries

getPlandir

getPlan

getPlanBean

setPlanDir

setPlan

getType

getChildBean

getClassFromScope

getDDBeanRoot

getText

getDDBeanRoot

entries

getEntry

getModuleDTDVersion

getDescriptorBean

toString

getDDBeanRoots

setUri

close

getContextRoot

setContextRoot