|
Oracle Fusion Middleware Oracle WebLogic Server API Reference 11g Release 1 (10.3.4) Part Number E13941-04 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweblogic.deploy.api.model.WebLogicDeployableObject
public class WebLogicDeployableObject
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
WebLogicDeployableObject.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 | |
---|---|
protected String |
contextRoot
|
Method Summary | |
---|---|
void |
close()
Closes application resources and removes temporary files. |
static WebLogicDeployableObject |
createDeployableObject(File app)
Deprecated. since WLS 9.2. |
static WebLogicDeployableObject |
createDeployableObject(File app,
File appRoot)
Deprecated. since WLS 9.2. |
static WebLogicDeployableObject |
createDeployableObject(File app,
File appRoot,
File plan,
File plandir,
weblogic.deploy.api.internal.utils.LibrarySpec[] libraries)
Deprecated. since WLS 9.2. |
static WebLogicDeployableObject |
createLazyDeployableObject(File app,
File appRoot)
Deprecated. since WLS 9.2. |
Enumeration |
entries()
Returns an enumeration of the module file entries. |
DDBean[] |
getChildBean(String xpath)
Returns DDBeans based on the specified xpath expression, relative to the root element of the primary descriptor of this DeployableObject. |
Class |
getClassFromScope(String className)
Returns the Class object from this module for the named class, or null if there is no class. |
String |
getContextRoot()
|
DDBeanRoot |
getDDBeanRoot()
Returns the root DDBean for this module. |
DDBeanRoot |
getDDBeanRoot(String filename)
Returns a DDBeanRoot object for the named XML instance document. |
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. |
InputStream |
getEntry(String name)
Returns an InputStream for the given entry name. |
String |
getModuleDTDVersion()
Deprecated. As of version 1.1, replaced by DDBeanRoot.getDDBeanRootVersion() |
File |
getPlan()
|
DeploymentPlanBean |
getPlanBean()
|
File |
getPlandir()
|
ClassFinder |
getResourceFinder()
|
String[] |
getText(String xpath)
Returns XML content for each matching element in this module's descriptor. |
ModuleType |
getType()
Returns the ModuleType of the deployment descriptor (for example, the EAR, JAR, WAR, or RAR) that this DeployableObject represents. |
void |
setContextRoot(String contextRoot)
|
protected void |
setLibraries(weblogic.deploy.api.internal.utils.LibrarySpec[] libraries)
|
protected void |
setPlan(File plan)
|
protected void |
setPlanDir(File plandir)
|
void |
setResourceFinder(ClassFinder finder)
|
protected void |
setUri(String u)
|
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 |
---|
protected String contextRoot
Method Detail |
---|
protected void setLibraries(weblogic.deploy.api.internal.utils.LibrarySpec[] libraries)
public File getPlandir()
public File getPlan()
public DeploymentPlanBean getPlanBean() throws IOException
IOException
protected void setPlanDir(File plandir)
protected void setPlan(File plan)
public ModuleType getType()
public DDBean[] getChildBean(String xpath)
public Class getClassFromScope(String className)
public DDBeanRoot getDDBeanRoot()
SessionHelper.inspect()
then it may throw
an unchecked RuntimeException indicating parse failures
public String[] getText(String xpath)
xpath
- Is an xpath expression relative to root element of this
module.public DDBeanRoot getDDBeanRoot(String filename) throws FileNotFoundException, DDBeanCreateException
The descriptor will be parsed and a full tree of DDBean's are created.
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.
FileNotFoundException
- If the named file cannot be found
javax.enterprise.deploy.model.exceptions.DDBeanCreateException
- If an error is encountered while creating the DDBeanRoot object.
DDBeanCreateException
public Enumeration entries()
public InputStream getEntry(String name)
name
- The file name relative to the root of the module.
public String getModuleDTDVersion()
public DescriptorBean getDescriptorBean() throws IOException
IOException
public static WebLogicDeployableObject createDeployableObject(File app) throws InvalidModuleException, IOException
app
- is the archive or root directory of the application.
InvalidModuleException
IOException
public static WebLogicDeployableObject createDeployableObject(File app, File appRoot) throws InvalidModuleException, IOException
app
- is the archive or root directory of the application.appRoot
- is application's installation root directory.
InvalidModuleException
IOException
public static WebLogicDeployableObject createDeployableObject(File app, File appRoot, File plan, File plandir, weblogic.deploy.api.internal.utils.LibrarySpec[] libraries) throws IOException, InvalidModuleException, ConfigurationException
app
- is the archive or root directory of the application.appRoot
- is application's installation root directory. May be null.plan
- is the deployment plan to use for this session. May be null.plandir
- is the plan directory to use for this session. If null
the plan directory is derived from the plan or app root provided.libraries
- is a collection of library references to merge with the app.
This argument allows for the presence of multiple directories and plans
to be associated with the app. If null then no attempt will be made to merge.
IOException
InvalidModuleException
ConfigurationException
public static WebLogicDeployableObject createLazyDeployableObject(File app, File appRoot) throws InvalidModuleException, IOException
InvalidModuleException
IOException
public String toString()
toString
in class Object
public DDBeanRoot[] getDDBeanRoots()
protected void setUri(String u)
public void close()
public void setResourceFinder(ClassFinder finder)
public ClassFinder getResourceFinder()
public String getContextRoot()
public void setContextRoot(String contextRoot)
|
Copyright 1996, 2010, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Oracle WebLogic Server API Reference 11g Release 1 (10.3.4) Part Number E13941-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |