SubDeploymentMBean

Overview

This bean represents an individually targetable entity within a deployment package, which is deployable on WLS. This includes :

Modules in an EAR

JMS resources within a app scoped JMS module in an EAR

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

Factory Methods

• Factory methods in AppDeploymentMBean
• Factory methods in BasicDeploymentMBean
• Factory methods in JDBCSystemResourceMBean
• Factory methods in JMSInteropModuleMBean
• Factory methods in JMSSystemResourceMBean
• Factory methods in LibraryMBean
• Factory methods in SystemResourceMBean
• Factory methods in WLDFSystemResourceMBean

Additional Access Points

In addition to accessing this MBean by invoking a factory method, you can also access this MBean from the following MBean attributes:

Child MBeans

This section describes attributes that contain child MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

SubDeployments

The SubDeployment groups within this JMS module. SubDeployments enable you to deploy some JMS objects in the module to a JMS server and other JMS objects to a WebLogic Server instance or cluster.

This is relevant only if this is a module target for a JMS Module inside an EAR.

Targets

You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

Attributes

This section describes the following attributes:

CompatibilityName

This is only set for beans created as a result of conversion from an 8.1 application configured using ApplicationMBean and ComponentMBean.

Standalone modules in 8.1 have both an ApplicationMBean name and ComponentMBean name. This attribute stores the name of the latter, to be used when the server creates the transient ComponentMBean for backward compatibility.

ModuleType

The values match those defined by jsr88. This attribute may move to another MBean.

Name

Unique identifier for this bean instance. It is used by the application container to match the module in the application package to the targeting information in the configuration.

For modules within an EAR, the name should be the URI of the module as defined in the META-INF/application.xml deployment descriptor. There is an exception to this for web applications. See below.

For web modules in an EAR, the name should always equal the context root of that webapp, because the URI is not always unique

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

Parent

Return the immediate parent for this MBean

Type

Returns the type of the MBean.

Operations

This section describes the following operations:

addTarget

You can add a target to specify additional servers on which the deployment can be deployed. The targets must be either clusters or servers.

Exceptions

• javax.management.InvalidAttributeValueException
• weblogic.management.DistributedManagementException

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

Exceptions

• javax.management.AttributeNotFoundException
• javax.management.MBeanException

isSet

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

removeTarget

Removes the value of the Target attribute.

For more information, see:

• addTarget

Exceptions

• javax.management.InvalidAttributeValueException
• weblogic.management.DistributedManagementException

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

Exceptions

• javax.management.AttributeNotFoundException

unSet

Restore the given property to its default value.