Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


weblogic.management.configuration
Interface ApplicationMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

Deprecated. 9.0.0.0 Replaced by AppDeploymentMBean

public interface ApplicationMBean
extends ConfigurationMBean

An application represents a Java EE 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.

See Also:
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 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
abstract  void addHandler(Object handler)
          Deprecated. To support binding to the NotificationTranslator.
abstract  WebAppComponentMBean createWebAppComponent(String name)
          Deprecated. Factory to create WebAppComponent instance in the domain This method is here to force the binding code to generate correctly.
abstract  void destroyConnectorComponent(ConnectorComponentMBean connectorComponent)
          Deprecated. destroys ConnectorComponents
abstract  void destroyEJBComponent(EJBComponentMBean ejbComponent)
          Deprecated. destroys EJBComponents
abstract  void destroyWebServiceComponent(WebServiceComponentMBean webserviceComponent)
          Deprecated. destroys WebServiceComponents
abstract  String getAltDescriptorPath()
          Deprecated. A path on the file system for the application descriptor for this application.
abstract  String getAltWLSDescriptorPath()
          Deprecated. A path on the file system for the WLS-specific application descriptor for this application.
abstract  ComponentMBean[] getComponents()
          Deprecated. The Java EE modules (components) that make up this application.
abstract  ConnectorComponentMBean[] getConnectorComponents()
          Deprecated. Returns the Connector components that make up this application.
abstract  int getDeploymentTimeout()
          Deprecated. 9.0.0.0 Replaced by DeploymentOptions.getClusterDeploymentTimeout()
abstract  String getDeploymentType()
          Deprecated. Specifies the category of this application.
abstract  EJBComponentMBean[] getEJBComponents()
          Deprecated.  Returns the EJB components that make up this application.
abstract  String getFullPath()
          Deprecated. The fully qualified source path of an application on an Administration Server.
abstract  int getLoadOrder()
          Deprecated. A numerical value that indicates when this module or application is deployed, relative to other deployable modules and applications.
abstract  String getPath()
          Deprecated. The URI, located on the Administration Server, of the original source files for this application.
abstract  String[] getStagedTargets()
          Deprecated. List of servers on which this application is known to be staged.
abstract  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.
abstract  String getStagingPath()
          Deprecated. The directory that a Managed Server uses to prepare and activate an application.
abstract  WebServiceComponentMBean[] getWebServiceComponents()
          Deprecated. Returns the WebService components that make up this application.
abstract  boolean isTwoPhase()
          Deprecated. Always returns true
abstract  ConnectorComponentMBean lookupConnectorComponent(String name)
          Deprecated.  
abstract  EJBComponentMBean lookupEJBComponent(String name)
          Deprecated.  
abstract  WebServiceComponentMBean lookupWebServiceComponent(String name)
          Deprecated.  
abstract  void setAltDescriptorPath(String value)
          Deprecated. Sets the value of the StandardDescriptorPath attribute.
abstract  void setAltWLSDescriptorPath(String value)
          Deprecated. Sets the value of the WebLogicDescriptorPath attribute.
abstract  void setDeploymentTimeout(int timeInMillis)
          Deprecated. 9.0.0.0 Replaced by DeploymentOptions.setClusterDeploymentTimeout(int) ()}
abstract  void setDeploymentType(String deploymentType)
          Deprecated. Sets the value of the DeploymentType attribute.
abstract  void setInternalApp(boolean internal)
          Deprecated.  
abstract  void setLoadOrder(int order)
          Deprecated. Sets the value of the LoadOrder attribute.
abstract  void setPath(String path)
          Deprecated. Sets the value of the Path attribute.
abstract  void setStagingMode(String mode)
          Deprecated. Sets the value of the Staging Mode attribute.
abstract  void setTwoPhase(boolean mode)
          Deprecated. Has no effect
abstract  boolean staged(String server)
          Deprecated. Convenience method for determining whether this application is currently staged on a particular server.
abstract  boolean stagingEnabled(String server)
          Deprecated. Convenience method for determining whether this application is to be staged on a particular server.
abstract  boolean useStagingDirectory(String server)
          Deprecated. 9.0.0.0

 

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, 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
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

 

Field Detail

TYPE_EAR

static final String TYPE_EAR
Deprecated. 
Application is an archived EAR
See Also:
Constant Field Values

TYPE_EXPLODED_EAR

static final String TYPE_EXPLODED_EAR
Deprecated. 
Application is an unarchived EAR
See Also:
Constant Field Values

TYPE_COMPONENT

static final String TYPE_COMPONENT
Deprecated. 
Application is an archived component/module
See Also:
Constant Field Values

TYPE_EXPLODED_COMPONENT

static final String TYPE_EXPLODED_COMPONENT
Deprecated. 
Application is an unarchived component/module
See Also:
Constant Field Values

TYPE_UNKNOWN

static final String TYPE_UNKNOWN
Deprecated. 
Application is of unknown type - default
See Also:
Constant Field Values

TWOPHASE_DEFAULT

static final boolean TWOPHASE_DEFAULT
Deprecated. 
Default value for TwoPhase attribute
See Also:
Constant Field Values

NO_STAGE

static final String NO_STAGE
Deprecated. 

Indicates that the application will not be staged.

See Also:
Constant Field Values

STAGE

static final String STAGE
Deprecated. 

Indicates that WebLogic Server will stage the application to the staging directory.

See Also:
Constant Field Values

EXTERNAL_STAGE

static final 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.

See Also:
Constant Field Values

DEFAULT_STAGE

static final 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. 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.


DEPLOYMENT_TIMEOUT

static final int DEPLOYMENT_TIMEOUT
Deprecated. 

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.

See Also:
Constant Field Values

Method Detail

getPath

String getPath()
Deprecated. 

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.

Returns:
The path value

setPath

void setPath(String path)
             throws ManagementException,
                    InvalidAttributeValueException
Deprecated. 

Sets the value of the Path attribute.

Parameters:
path - The new path value
Throws:
InvalidAttributeValueException
ManagementException - if path is invalid
See Also:
ApplicationMBean.getPath()

getComponents

ComponentMBean[] getComponents()
Deprecated. 

The Java EE modules (components) that make up this application.

Returns:
The components value

createWebAppComponent

WebAppComponentMBean createWebAppComponent(String name)
Deprecated. 
Factory to create WebAppComponent instance in the domain This method is here to force the binding code to generate correctly.
Parameters:
name -
Returns:
WebAppComponent object
Since:
9.0.0.0

getFullPath

String getFullPath()
Deprecated. 

The fully qualified source path of an application on an Administration Server.

Returns:
The fullPath value

setInternalApp

void setInternalApp(boolean internal)
Deprecated. 
Parameters:
internal - The new internalApp value

getStagingPath

String getStagingPath()
Deprecated. 

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).

Returns:
The stagingPath value
Since:
7.0.0.0

getStagedTargets

String[] getStagedTargets()
Deprecated. 

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.

Returns:
The stagedTargets value
Since:
7.0.0.0

getStagingMode

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. 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.

Returns:
The stagingMode value
Since:
7.0.0.0
See Also:
ServerMBean

setStagingMode

void setStagingMode(String mode)
                    throws ManagementException
Deprecated. 

Sets the value of the Staging Mode attribute.

Parameters:
mode - The new stagingMode value
Throws:
ManagementException
ManagementException - if staging has already been established for this application.
See Also:
ApplicationMBean.getStagingMode()

stagingEnabled

boolean stagingEnabled(String server)
Deprecated. 

Convenience method for determining whether this application is to be staged on a particular server.

Parameters:
server -
Returns:
returns true if enabled
Since:
7.0.0.0

staged

boolean staged(String server)
Deprecated. 

Convenience method for determining whether this application is currently staged on a particular server.

Parameters:
server -
Returns:
returns true if staged
Since:
7.0.0.0

useStagingDirectory

boolean useStagingDirectory(String server)
Deprecated. 9.0.0.0

Convenience method for determining where the file will be loaded from on the managed servers.

Parameters:
server -
Since:
7.0.0.0

isTwoPhase

boolean isTwoPhase()
Deprecated. Always returns true

Specifies whether this application is deployed using the two-phase deployment protocol.

Returns:
The twoPhase value
Since:
7.0.0.0
See Also:
DeployerRuntimeMBean

setTwoPhase

void setTwoPhase(boolean mode)
Deprecated. Has no effect
Parameters:
mode - The new twoPhase value
Since:
7.0.0.0

getLoadOrder

int getLoadOrder()
Deprecated. 

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.)

Returns:
The loadOrder value
Since:
7.0.0.0
See Also:
ApplicationMBean.isTwoPhase()

setLoadOrder

void setLoadOrder(int order)
Deprecated. 

Sets the value of the LoadOrder attribute.

Parameters:
order - The new loadOrder value
See Also:
ApplicationMBean.getLoadOrder()

getDeploymentType

String getDeploymentType()
Deprecated. 

Specifies the category of this application. This attribute will be derived if not specified in the configuration.

Returns:
The deploymentType value
Since:
7.0.0.0

setDeploymentType

void setDeploymentType(String deploymentType)
Deprecated. 

Sets the value of the DeploymentType attribute.

Parameters:
deploymentType - The new deploymentType value
See Also:
ApplicationMBean.getDeploymentType()

getDeploymentTimeout

int getDeploymentTimeout()
Deprecated. 9.0.0.0 Replaced by 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.

Returns:
The deploymentTimeout value
Since:
7.0.0.0

setDeploymentTimeout

void setDeploymentTimeout(int timeInMillis)
Deprecated. 9.0.0.0 Replaced by DeploymentOptions.setClusterDeploymentTimeout(int) ()}

Sets the value of the DeploymentTimeout attribute

Parameters:
timeInMillis - The new deploymentTimeout value
See Also:
ApplicationMBean.getDeploymentTimeout()

getAltDescriptorPath

String getAltDescriptorPath()
Deprecated. 

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);

Returns:
The applicationDescriptorPath value

setAltDescriptorPath

void setAltDescriptorPath(String value)
Deprecated. 

Sets the value of the StandardDescriptorPath attribute.

Parameters:
value - The new standardDescriptorPath value
See Also:
ApplicationMBean.getAltDescriptorPath()

getAltWLSDescriptorPath

String getAltWLSDescriptorPath()
Deprecated. 

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);

Returns:
The webLogicDescriptorPath value

setAltWLSDescriptorPath

void setAltWLSDescriptorPath(String value)
Deprecated. 

Sets the value of the WebLogicDescriptorPath attribute.

Parameters:
value - The new webLogicDescriptorPath value
See Also:
ApplicationMBean.getAltWLSDescriptorPath()

destroyEJBComponent

void destroyEJBComponent(EJBComponentMBean ejbComponent)
Deprecated. 

destroys EJBComponents

Since:
9.0.0.0

lookupEJBComponent

EJBComponentMBean lookupEJBComponent(String name)
Deprecated. 
Parameters:
name -
Returns:
EJBComponent object

getEJBComponents

EJBComponentMBean[] getEJBComponents()
Deprecated. 

Returns the EJB components that make up this application. Components represent the Java EE modules associated with this application.

Returns:
The components value

destroyConnectorComponent

void destroyConnectorComponent(ConnectorComponentMBean connectorComponent)
Deprecated. 

destroys ConnectorComponents

Since:
9.0.0.0

lookupConnectorComponent

ConnectorComponentMBean lookupConnectorComponent(String name)
Deprecated. 
Parameters:
name -
Returns:
ConnectorComponent object

getConnectorComponents

ConnectorComponentMBean[] getConnectorComponents()
Deprecated. 

Returns the Connector components that make up this application. Components represent the Java EE modules associated with this application.

Returns:
The components value

destroyWebServiceComponent

void destroyWebServiceComponent(WebServiceComponentMBean webserviceComponent)
Deprecated. 

destroys WebServiceComponents

Since:
9.0.0.0

lookupWebServiceComponent

WebServiceComponentMBean lookupWebServiceComponent(String name)
Deprecated. 
Parameters:
name -
Returns:
WebServiceComponent object

getWebServiceComponents

WebServiceComponentMBean[] getWebServiceComponents()
Deprecated. 

Returns the WebService components that make up this application. Components represent the Java EE modules associated with this application.

Returns:
The WebService components value

addHandler

void addHandler(Object handler)
Deprecated. 
To support binding to the NotificationTranslator.

Skip navigation links

Copyright 1996, 2015, 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
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09