BEA WebLogic Server 9.0 API Reference

weblogic.deploy.api.model
Class WebLogicJ2eeApplicationObject

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

All Implemented Interfaces:

weblogic.deploy.api.internal.Closable, DeployableObject, J2eeApplicationObject

public final class WebLogicJ2eeApplicationObject

extends WebLogicDeployableObject

implements J2eeApplicationObject

This class is the WebLogic Server implementation of DeployableObject.

This class encapsulates an EAR for deployment purposes. A deployment tool uses the constructor for this class to present an EAR to the deployer. Instances of this class are acquired via WebLogicDeployableObject.createDeployableObject(java.io.File)

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Method Summary

void	addXpathListener(ModuleType type, String xpath, XpathListener xpl) Not implemented.
void	close() Closes application resources and removes temporary files.
DDBean[]	getChildBean(ModuleType type, String xpath) Returns a list of DDBeans based upon an XPath, searching all standard J2EE deployment descriptors of the specified type.
DeployableObject	getDeployableObject(String uri) Returns the module in the application with the specified uri, or null if no such module exists.
DeployableObject[]	getDeployableObjects() Returns all modules in the application, or null if there are no embedded modules.
DeployableObject[]	getDeployableObjects(ModuleType type) Returns all modules in the application based on the specified type, or null if there are no matching modules.
weblogic.descriptor.DescriptorBean	getDescriptorBean() Typed descriptor bean tree for this modules standard descriptor.
String[]	getModuleUris() Lists the module URI path for each embedded module.
String[]	getModuleUris(ModuleType type) Lists the module URI path for each embedded modules of the specified ModuleType.
String[]	getText(ModuleType type, String xpath) Returns the text value from the XPath, searching only the standard J2EE deployment descriptors of the specified type.
void	removeXpathListener(ModuleType type, String xpath, XpathListener xpl) Not implemented.

Methods inherited from class weblogic.deploy.api.model.WebLogicDeployableObject

createDeployableObject, createDeployableObject, createLazyDeployableObject, entries, getChildBean, getClassFromScope, getDDBeanRoot, getDDBeanRoot, getDDBeanRoots, getEntry, getModuleDTDVersion, getParent, getText, getType, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.enterprise.deploy.model.DeployableObject

entries, getChildBean, getClassFromScope, getDDBeanRoot, getDDBeanRoot, getEntry, getModuleDTDVersion, getText, getType

Method Detail

addXpathListener

public void addXpathListener(ModuleType type,
                             String xpath,
                             XpathListener xpl)

Not implemented.

Specified by:

addXpathListener in interface J2eeApplicationObject

close

public void close()

Description copied from class: WebLogicDeployableObject

Closes application resources and removes temporary files.

Specified by:

close in interface weblogic.deploy.api.internal.Closable

Overrides:

close in class WebLogicDeployableObject

getChildBean

public DDBean[] getChildBean(ModuleType type,
                             String xpath)

Returns a list of DDBeans based upon an XPath, searching all standard J2EE deployment descriptors of the specified type.

Specified by:

getChildBean in interface J2eeApplicationObject

getDeployableObject

public DeployableObject getDeployableObject(String uri)

Returns the module in the application with the specified uri, or null if no such module exists.

Specified by:

getDeployableObject in interface J2eeApplicationObject

getDeployableObjects

public DeployableObject[] getDeployableObjects()

Returns all modules in the application, or null if there are no embedded modules. The DeployableObject representing the EAR itself does not appear in the list.

Specified by:

getDeployableObjects in interface J2eeApplicationObject

getDeployableObjects

public DeployableObject[] getDeployableObjects(ModuleType type)

Returns all modules in the application based on the specified type, or null if there are no matching modules.

Specified by:

getDeployableObjects in interface J2eeApplicationObject

getDescriptorBean

public weblogic.descriptor.DescriptorBean getDescriptorBean()

Description copied from class: WebLogicDeployableObject

Typed descriptor bean tree for this modules standard descriptor.

Overrides:

getDescriptorBean in class WebLogicDeployableObject

getModuleUris

public String[] getModuleUris()

Lists the module URI path for each embedded module. This method returns null if there are no embedded modules.

Specified by:

getModuleUris in interface J2eeApplicationObject

getModuleUris

public String[] getModuleUris(ModuleType type)

Lists the module URI path for each embedded modules of the specified ModuleType. This method returns null if no modules of the specified type exist in the application.

Specified by:

getModuleUris in interface J2eeApplicationObject

getText

public String[] getText(ModuleType type,
                        String xpath)

Returns the text value from the XPath, searching only the standard J2EE deployment descriptors of the specified type.

Specified by:

getText in interface J2eeApplicationObject

removeXpathListener

public void removeXpathListener(ModuleType type,
                                String xpath,
                                XpathListener xpl)

Not implemented.

Specified by:

removeXpathListener in interface J2eeApplicationObject