|
BEA Systems, Inc. | |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
MBeanHome
interface.)AppDeploymentMBean
An application represents a J2EE application contained in an EAR file or EAR directory. The EAR file contains a set of components such as WAR, EJB, and RAR connector components, each of which can be deployed on one or more targets. A target is a server or a cluster. If the application is provided as a standalone module, then this MBean is a synthetic wrapper application only.
This is a type-safe interface for a
WebLogic Server MBean, which you can import into your client
classes and access through
weblogic.management.MBeanHome
. As of 9.0, the
MBeanHome
interface and all type-safe interfaces for
WebLogic Server MBeans are deprecated. Instead, client classes that
interact with WebLogic Server MBeans should use standard JMX design
patterns in which clients use the
javax.management.MBeanServerConnection
interface to
discover MBeans, attributes, and attribute types at runtime. For
more information, see "Developing Manageable Applications with JMX"
on http://www.oracle.com/technology/documentation/index.html.
TargetMBean
,
EJBComponentMBean
,
WebAppComponentMBean
,
ConnectorComponentMBean
Field Summary | |
static String |
DEFAULT_STAGE
Deprecated. Indicates that applications deployed to the Admin Server will not be staged, and that the Admin Server does not copy deployment files to Managed Servers. |
static int |
DEPLOYMENT_TIMEOUT
Deprecated. Default deployment timeout value for two-phase deployments. |
static String |
EXTERNAL_STAGE
Deprecated. Indicates that the files will be located in the staging directory but that an external application will be responsible for delivering them there. |
static String |
NO_STAGE
Deprecated. Indicates that the application will not be staged. |
static String |
STAGE
Deprecated. Indicates that WebLogic Server will stage the application to the staging directory. |
static boolean |
TWOPHASE_DEFAULT
Deprecated. Default value for for TwoPhase attribute |
static String |
TYPE_COMPONENT
Deprecated. Application is an archived component/module |
static String |
TYPE_EAR
Deprecated. Application is an archived EAR |
static String |
TYPE_EXPLODED_COMPONENT
Deprecated. Application is an unarchived component/module |
static String |
TYPE_EXPLODED_EAR
Deprecated. Application is an unarchived EAR |
static String |
TYPE_UNKNOWN
Deprecated. Application is of unknown type - default |
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean |
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
void |
destroyConnectorComponent(ConnectorComponentMBean connectorComponent)
Deprecated. destroys ConnectorComponents |
void |
destroyEJBComponent(EJBComponentMBean ejbComponent)
Deprecated. destroys EJBComponents |
void |
destroyWebServiceComponent(WebServiceComponentMBean webserviceComponent)
Deprecated. destroys WebServiceComponents |
String |
getAltDescriptorPath()
Deprecated. A path on the file system for the application descriptor for this application. |
String |
getAltWLSDescriptorPath()
Deprecated. A path on the file system for the WLS-specific application descriptor for this application. |
ComponentMBean[] |
getComponents()
Deprecated. The J2EE modules (components) that make up this application. |
ConnectorComponentMBean[] |
getConnectorComponents()
Deprecated. Returns the Connector components that make up this application. |
int |
getDeploymentTimeout()
Deprecated. 9.0.0.0 Replaced by DeploymentOptions.getClusterDeploymentTimeout() |
String |
getDeploymentType()
Deprecated. Specifies the category of this application. |
EJBComponentMBean[] |
getEJBComponents()
Deprecated. Returns the EJB components that make up this application. |
int |
getLoadOrder()
Deprecated. A numerical value that indicates when this module or application is deployed, relative to other deployable modules and applications. |
String |
getPath()
Deprecated. The URI, located on the Administration Server, of the original source files for this application. |
String[] |
getStagedTargets()
Deprecated. List of servers on which this application is known to be staged. |
String |
getStagingMode()
Deprecated. The mode that specifies whether an application's files are copied from a source on the Administration Server to the Managed Server's staging area during application preparation. |
String |
getStagingPath()
Deprecated. The directory that a Managed Server uses to prepare and activate an application. |
WebServiceComponentMBean[] |
getWebServiceComponents()
Deprecated. Returns the WebService components that make up this application. |
boolean |
isTwoPhase()
Deprecated. Always returns true |
ConnectorComponentMBean |
lookupConnectorComponent(String name)
Deprecated. |
EJBComponentMBean |
lookupEJBComponent(String name)
Deprecated. |
WebServiceComponentMBean |
lookupWebServiceComponent(String name)
Deprecated. |
void |
setAltDescriptorPath(String value)
Deprecated. Sets the value of the StandardDescriptorPath attribute. |
void |
setAltWLSDescriptorPath(String value)
Deprecated. Sets the value of the WebLogicDescriptorPath attribute. |
void |
setDeploymentTimeout(int timeInMillis)
Deprecated. 9.0.0.0 Replaced by DeploymentOptions.setClusterDeploymentTimeout(int) ()} |
void |
setDeploymentType(String deploymentType)
Deprecated. Sets the value of the DeploymentType attribute. |
void |
setLoadOrder(int order)
Deprecated. Sets the value of the LoadOrder attribute. |
void |
setPath(String path)
Deprecated. Sets the value of the Path attribute. |
void |
setStagingMode(String mode)
Deprecated. Sets the value of the Staging Mode attribute. |
void |
setTwoPhase(boolean mode)
Deprecated. Has no effect |
boolean |
staged(String server)
Deprecated. Convenience method for determining whether this application is currently staged on a particular server. |
boolean |
stagingEnabled(String server)
Deprecated. Convenience method for determining whether this application is to be staged on a particular server. |
boolean |
useStagingDirectory(String server)
Deprecated. 9.0.0.0 |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
freezeCurrentValue, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet |
Methods inherited from interface weblogic.management.WebLogicMBean |
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent |
Methods inherited from interface javax.management.DynamicMBean |
getAttribute, getAttributes, invoke, setAttribute, setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
postDeregister, postRegister, preDeregister, preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
addNotificationListener, getNotificationInfo, removeNotificationListener |
Methods inherited from interface weblogic.descriptor.DescriptorBean |
addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener |
Methods inherited from interface weblogic.management.deploy.DeploymentCompatibilityEventManager |
addHandler |
Field Detail |
public static final String DEFAULT_STAGE
Indicates that applications deployed to the Admin Server will not be staged, and that the Admin Server does not copy deployment files to Managed Servers. With this staging mode, Managed Servers are treated as staged, and external application (not the Admin Server) is resonsible for delivering deployment files to the staging directory.
public static final int DEPLOYMENT_TIMEOUT
Default deployment timeout value for two-phase deployments. Time is in milliseconds.
The default timeout should far exceed our worst case expected deployment of a large application to a large number of destinations.
public static final String EXTERNAL_STAGE
Indicates that the files will be located in the staging directory but that an external application will be responsible for delivering them there.
public static final String NO_STAGE
Indicates that the application will not be staged.
public static final String STAGE
Indicates that WebLogic Server will stage the application to the staging directory.
public static final boolean TWOPHASE_DEFAULT
public static final String TYPE_COMPONENT
public static final String TYPE_EAR
public static final String TYPE_EXPLODED_COMPONENT
public static final String TYPE_EXPLODED_EAR
public static final String TYPE_UNKNOWN
Method Detail |
public void destroyConnectorComponent(ConnectorComponentMBean connectorComponent)
destroys ConnectorComponents
public void destroyEJBComponent(EJBComponentMBean ejbComponent)
destroys EJBComponents
public void destroyWebServiceComponent(WebServiceComponentMBean webserviceComponent)
destroys WebServiceComponents
public String getAltDescriptorPath()
A path on the file system for the application descriptor for this application. If null, the usual location within the ear is used (META-INF/application.xml);
public String getAltWLSDescriptorPath()
A path on the file system for the WLS-specific application descriptor for this application. If null, the usual location within the EAR file is used (META-INF/weblogic-application.xml);
public ComponentMBean[] getComponents()
The J2EE modules (components) that make up this application.
public ConnectorComponentMBean[] getConnectorComponents()
Returns the Connector components that make up this application. Components represent the J2EE modules associated with this application.
public int getDeploymentTimeout()
DeploymentOptions.getClusterDeploymentTimeout()
Milliseconds granted for a cluster deployment task on this application. If any deployment tasks remain active for longer, the task will be cancelled.
The larger the application, the larger the timeout value should be, as the gating factor is associated with download time and processing time required to load the application files.
A server instance checks for timed out deployments about once a minute.
Only cluster deployments can be timed out.
public String getDeploymentType()
Specifies the category of this application. This attribute will be derived if not specified in the configuration.
public EJBComponentMBean[] getEJBComponents()
Returns the EJB components that make up this application. Components represent the J2EE modules associated with this application.
public int getLoadOrder()
A numerical value that indicates when this module or application is deployed, relative to other deployable modules and applications. Modules with lower Load Order values are deployed before those with higher values. (Requires that you enable the two-phase deployment protocol.)
isTwoPhase()
public String getPath()
The URI, located on the Administration Server, of the original source files for this application.
Relative paths are based on the root of the Administration Server installation directory. It is highly recommended that you use absolute paths to minimize possible issues when upgrading the server.
If the application is not being staged (StagingMode==nostage) then the path must be valid on the target server.
The path to an Enterprise application (EAR) is the location of the EAR file or the root of the EAR if it is unarchived. e.g. Path="myapps/app.ear" is valid. If the application is a standalone module, then the path is the parent directory of the module. For example, if the module is located at myapps/webapp/webapp.war, the Path="myapps/webapp" is correct, whereas Path="myapps/webapp/webapp.war" is incorrect.
public String[] getStagedTargets()
List of servers on which this application is known to be staged. This makes no distinction regarding the version or state of the staged files, just that they are staged. The array returned contains the names of the target servers. This list should not include cluster names.
public String getStagingMode()
The mode that specifies whether an application's files are copied from a source on the Administration Server to the Managed Server's staging area during application preparation. Staging mode for an application can only be set the first time the application is deployed. Once staging mode for an application is set, it cannot be changed while the application is configured in the domain. The only way to change staging mode is to undeploy then redeploy the application.
Staging involves distributing the application files from the Administration Server to the targeted Managed Servers staging directory. This attribute is used to override the Managed Server's StagingMode attribute.
ServerMBean
public String getStagingPath()
The directory that a Managed Server uses to prepare and activate an application.
The directory path is relative to the Managed Server's Staging Path. It is derived from the Path attribute, and depends on whether the application is being staged. If the Path attribute for application, myapp, is foo.ear, the staging path is set to myapp/foo.ear. If the path is C:/myapp.ear, the staging path is myapp/myapp.ear. If the application is not being staged (StagingMode==nostage), then the staging path is the same as the Path attribute. If this application is not being staged, the staging path is equivalent to the source path (Path attribute).
public WebServiceComponentMBean[] getWebServiceComponents()
Returns the WebService components that make up this application. Components represent the J2EE modules associated with this application.
public boolean isTwoPhase()
Specifies whether this application is deployed using the two-phase deployment protocol.
DeployerRuntimeMBean
public ConnectorComponentMBean lookupConnectorComponent(String name)
name
-
public EJBComponentMBean lookupEJBComponent(String name)
name
-
public WebServiceComponentMBean lookupWebServiceComponent(String name)
name
-
public void setAltDescriptorPath(String value)
Sets the value of the StandardDescriptorPath attribute.
value
- The new standardDescriptorPath valuegetAltDescriptorPath()
public void setAltWLSDescriptorPath(String value)
Sets the value of the WebLogicDescriptorPath attribute.
value
- The new webLogicDescriptorPath valuegetAltWLSDescriptorPath()
public void setDeploymentTimeout(int timeInMillis)
DeploymentOptions.setClusterDeploymentTimeout(int)
()}
Sets the value of the DeploymentTimeout attribute
timeInMillis
- The new deploymentTimeout valuegetDeploymentTimeout()
public void setDeploymentType(String deploymentType)
Sets the value of the DeploymentType attribute.
deploymentType
- The new deploymentType valuegetDeploymentType()
public void setLoadOrder(int order)
Sets the value of the LoadOrder attribute.
order
- The new loadOrder valuegetLoadOrder()
public void setPath(String path) throws weblogic.management.ManagementException, InvalidAttributeValueException
Sets the value of the Path attribute.
path
- The new path value
InvalidAttributeValueException
weblogic.management.ManagementException
- if path is invalidgetPath()
public void setStagingMode(String mode) throws weblogic.management.ManagementException
Sets the value of the Staging Mode attribute.
mode
- The new stagingMode value
weblogic.management.ManagementException
weblogic.management.ManagementException
- if staging has already been established for this application.getStagingMode()
public void setTwoPhase(boolean mode)
mode
- The new twoPhase valuepublic boolean staged(String server)
Convenience method for determining whether this application is currently staged on a particular server.
server
-
public boolean stagingEnabled(String server)
Convenience method for determining whether this application is to be staged on a particular server.
server
-
public boolean useStagingDirectory(String server)
Convenience method for determining where the file will be loaded from on the managed servers.
server
-
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs90 Copyright 2005 BEA Systems Inc. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |