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.
Deprecated.
Security roles | The following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
|
||
Fully Qualified Interface Name | If 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 |
|
This section describes attributes that provide access to other MBeans.
The Java EE modules (components) that make up this application.
Privileges | Read only |
Type | ComponentMBean[] |
Relationship type: | Reference. |
Returns the Connector components that make up this application. Components represent the Java EE modules associated with this application.
Factory Methods | createConnectorComponent
(java.lang.String name)
Factory methods do not return objects. |
Lookup Operation | lookupConnectorComponent(String name)
Returns a |
Privileges | Read only |
Type | ConnectorComponentMBean[] |
Relationship type: | Containment. |
Returns the EJB components that make up this application. Components represent the Java EE modules associated with this application.
Factory Methods | createEJBComponent
(java.lang.String name)
Factory methods do not return objects. |
Lookup Operation | lookupEJBComponent(String name)
Returns a |
Privileges | Read only |
Type | EJBComponentMBean[] |
Relationship type: | Containment. |
Returns the WebService components that make up this application. Components represent the Java EE modules associated with this application.
Factory Methods | createWebServiceComponent
(java.lang.String name)
Factory methods do not return objects. |
Lookup Operation | lookupWebServiceComponent(String name)
Returns a |
Privileges | Read only |
Type | WebServiceComponentMBean[] |
Relationship type: | Containment. |
This section describes the following attributes:
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 |
Type | java.lang.String |
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 |
Type | java.lang.String |
Private property that disables caching in proxies.
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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.
Available Since | Release 7.0.0.0 |
Privileges | Read/Write |
Type | int |
Default Value | 3600000 |
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 |
Type | java.lang.String |
Default Value | UNKNOWN |
Legal Values |
|
Return whether the MBean was created dynamically or is persisted to config.xml
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The fully qualified source path of an application on an Administration Server.
Privileges | Read only |
Type | java.lang.String |
Return the unique id of this MBean instance
Privileges | Read only |
Type | long |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Indicates whether this application is an internal application. Such applications are not displayed in the console. For OAM internal use only.
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
Type | int |
Default Value | 100 |
Returns the MBean info for this MBean.
Deprecated.
Privileges | Read only |
Type | javax.management.MBeanInfo |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
Type | java.lang.String |
Optional information that you can include to describe this configuration.
WebLogic Server saves this note in the domain's configuration
file (config.xml
) as XML PCDATA. All left angle
brackets (<) are converted to the XML entity
<
. 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 |
Type | java.lang.String |
Returns the ObjectName under which this MBean is registered in the MBean server.
Deprecated.
Privileges | Read only |
Type | weblogic.management.WebLogicObjectName |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return the immediate parent for this MBean
Privileges | Read/Write |
Type |
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 |
Type | java.lang.String |
Returns false if the MBean represented by this object has been unregistered.
Deprecated.
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
Type | class java.lang.String[] |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
Type | java.lang.String |
Legal Values |
|
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 |
Type | java.lang.String |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return all tags on this Configuration MBean
Available Since | Release 12.2.1.0 |
Privileges | Read/Write |
Type | class java.lang.String[] |
Specifies whether this application is deployed using the two-phase deployment protocol.
Deprecated.
For more information, see:
Available Since | Release 7.0.0.0 |
Privileges | Read/Write |
Type | boolean |
Default Value | true |
Returns the type of the MBean.
Privileges | Read only |
Type | java.lang.String |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
This section describes the following operations:
Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.
Operation Name | "addTag" |
Parameters | Object [] { tag }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Exceptions |
|
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.
Operation Name | "freezeCurrentValue" |
Parameters | Object [] { attributeName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.
Operation Name | "getInheritedProperties" |
Parameters | Object [] { propertyNames }
where:
|
Signature | String [] {
"[Ljava.lang.String;" } |
Returns |
class |
Check if the value of a property is inherited from template mbean or not.
Operation Name | "isInherited" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Returns true if the specified attribute has been set explicitly in this MBean instance.
Operation Name | "isSet" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Remove a tag from this Configuration MBean
Operation Name | "removeTag" |
Parameters | Object [] { tag }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Exceptions |
|
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.
Operation Name | "restoreDefaultValue" |
Parameters | Object [] { attributeName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
Convenience method for determining whether this application is currently staged on a particular server.
Operation Name | "staged" |
Parameters | Object [] { server }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Convenience method for determining whether this application is to be staged on a particular server.
Operation Name | "stagingEnabled" |
Parameters | Object [] { server }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Restore the given property to its default value.
Operation Name | "unSet" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|
Convenience method for determining where the file will be loaded from on the managed servers.
Deprecated.
Operation Name | "useStagingDirectory" |
Parameters | Object [] { server }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|