ApplicationMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

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.

Deprecated. 9.0.0.0 Replaced by AppDeploymentMBean

           
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • Deployer
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.ApplicationMBean

For more information, see:

Factory Methods
Deprecated Factory Methods and Access Points


Related MBeans

This section describes attributes that provide access to other MBeans.


Components

The J2EE modules (components) that make up this application.

       
Privileges Read only
TypeComponentMBean[]
Relationship type: Reference.

ConnectorComponents

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

           
Factory MethodscreateConnectorComponent (java.lang.String name)

destroyConnectorComponent (ConnectorComponentMBean )

Factory methods do not return objects.

See Using factory methods.

Lookup OperationlookupConnectorComponent(String name)

Returns a javax.management.ObjectName for the instance of ConnectorComponentMBean named name.

Privileges Read only
TypeConnectorComponentMBean[]
Relationship type: Containment.

EJBComponents

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

           
Factory MethodscreateEJBComponent (java.lang.String name)

destroyEJBComponent (EJBComponentMBean )

Factory methods do not return objects.

See Using factory methods.

Lookup OperationlookupEJBComponent(String name)

Returns a javax.management.ObjectName for the instance of EJBComponentMBean named name.

Privileges Read only
TypeEJBComponentMBean[]
Relationship type: Containment.

WebServiceComponents

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

           
Factory MethodscreateWebServiceComponent (java.lang.String name)

destroyWebServiceComponent (WebServiceComponentMBean )

Factory methods do not return objects.

See Using factory methods.

Lookup OperationlookupWebServiceComponent(String name)

Returns a javax.management.ObjectName for the instance of WebServiceComponentMBean named name.

Privileges Read only
TypeWebServiceComponentMBean[]
Relationship type: Containment.


Attributes

This section describes the following attributes:


AltDescriptorPath

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

       
Privileges Read/Write
Typejava.lang.String

AltWLSDescriptorPath

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

       
Privileges Read/Write
Typejava.lang.String

CachingDisabled

Private property that disables caching in proxies.

       
Privileges Read only
Typeboolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

DeploymentTimeout

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.

Deprecated. 9.0.0.0 Replaced by DeploymentOptions#getClusterDeploymentTimeout()

       
Available Since Release 7.0.0.0
Privileges Read/Write
Typeint
Default Value3600000

DeploymentType

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

       
Available Since Release 7.0.0.0
Privileges Read/Write
Typejava.lang.String
Default ValueUNKNOWN
Legal Values
  • EAR
  • EXPLODED EAR
  • COMPONENT
  • EXPLODED COMPONENT
  • UNKNOWN

FullPath

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

       
Privileges Read only
Typejava.lang.String

InternalApp

Indicates whether this application is an internal application. Such applications are not displayed in the console. For OAM internal use only.

       
Privileges Read only
Typeboolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

LoadOrder

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

For more information, see:

       
Available Since Release 7.0.0.0
Privileges Read/Write
Typeint
Default Value100

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

       
Privileges Read only
Typejavax.management.MBeanInfo
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:
Name=user-specified-name

       
Privileges Read/Write
Typejava.lang.String

Notes

Optional information that you can include to describe this configuration.

WebLogic Sever saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

       
Privileges Read/Write
Typejava.lang.String

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

Deprecated.

       
Privileges Read only
Typeweblogic.management.WebLogicObjectName
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

Parent

Return the immediate parent for this MBean

       
Privileges Read/Write
Type

Path

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.

       
Privileges Read/Write
Typejava.lang.String

Registered

Returns false if the the MBean represented by this object has been unregistered.

Deprecated.

       
Privileges Read only
Typeboolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

StagedTargets

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.

       
Available Since Release 7.0.0.0
Privileges Read only
Typeclass java.lang.String[]
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

StagingMode

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.

For more information, see:

       
Available Since Release 7.0.0.0
Privileges Read/Write
Typejava.lang.String
Legal Values
  • callback-polling
  • nostage
  • stage
  • external_stage

StagingPath

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

       
Available Since Release 7.0.0.0
Privileges Read only
Typejava.lang.String
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

TwoPhase

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

Deprecated. Always returns true

For more information, see:

       
Available Since Release 7.0.0.0
Privileges Read/Write
Typeboolean
Default Valuetrue

Type

Returns the type of the MBean.

       
Privileges Read only
Typejava.lang.String
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


Operations

This section describes the following operations:


freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note:

To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

   
Operation Name"freezeCurrentValue"
ParametersObject [] {  attributeName }

where:

  • attributeName is an object of type java.lang.String that specifies:

    attributeName

SignatureString [] { "java.lang.String" }
Returns void
Exceptions
  • javax.management.AttributeNotFoundException
  • javax.management.MBeanException

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

   
Operation Name"isSet"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to check

SignatureString [] { "java.lang.String" }
Returns boolean

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

   
Operation Name"restoreDefaultValue"
ParametersObject [] {  attributeName }

where:

  • attributeName is an object of type java.lang.String that specifies:

    attributeName

SignatureString [] { "java.lang.String" }
Returns void
Exceptions
  • javax.management.AttributeNotFoundException

staged

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

   
Operation Name"staged"
ParametersObject [] {  server }

where:

  • server is an object of type java.lang.String that specifies:

    server

SignatureString [] { "java.lang.String" }
Returns boolean

stagingEnabled

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

   
Operation Name"stagingEnabled"
ParametersObject [] {  server }

where:

  • server is an object of type java.lang.String that specifies:

    server

SignatureString [] { "java.lang.String" }
Returns boolean

unSet

Restore the given property to its default value.

   
Operation Name"unSet"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to restore

SignatureString [] { "java.lang.String" }
Returns void

useStagingDirectory

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

Deprecated. 9.0.0.0

   
Operation Name"useStagingDirectory"
ParametersObject [] {  server }

where:

  • server is an object of type java.lang.String that specifies:

    server

SignatureString [] { "java.lang.String" }
Returns boolean