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
| 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.SubDeploymentMBean
|
||
| Factory Methods |
| ||
| 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:
|
||
| Subtypes |
The following MBeans extend or implement this MBean type:
|
This section describes attributes that provide access to other MBeans.
|
|
The subdeployment groups within this JMS module. Subdeployments enable you to deploy some resources in a JMS module to a JMS server and other JMS resources to a server instance or cluster.
Standalone queues or topics can only be targeted to a single JMS server. Whereas, connection factories, uniform distributed destinations (UDDs), and foreign servers can be targeted to one or more JMS servers, one or more server instances, or to a cluster. Therefore, standalone queues or topics cannot be associated with a subdeployment if other members of the subdeployment are targeted to multiple JMS servers. However, UDDs can be associated with such subdeployments since the purpose of UDDs is to distribute its members to multiple JMS servers in a domain.
| Factory Methods | No explicit creator method. The child shares the lifecycle of its parent. |
| Lookup Operation | lookupSubDeployment(String name)
Returns a |
| Privileges | Read only |
| Type | SubDeploymentMBean[] |
| Relationship type: | Containment. |
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.
| Privileges | Read/Write |
| Type | TargetMBean[] |
| Relationship type: | Reference. |
This section describes the following attributes:
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. |
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.
| Privileges | Read/Write |
| Type | java.lang.String |
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. |
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. |
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 type of the module (ear, jar, war, or rar)
| Privileges | Read/Write |
| Type | java.lang.String |
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
| 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 |
| Security roles | Write access is granted only to the following roles:
|
| 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 |
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. |
Return all tags on this Configuration MBean
| Available Since | Release 12.2.1.0.0 |
| Privileges | Read/Write |
| Type | class java.lang.String[] |
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. |
Only relevant for deployments in resource group templates. Sub-deployments cannot have arbitrary targets if they are part of a deployment from resource group template. The sub-deployments, in such cases, may only be targeted to the virtual host of referring partition or stay untargeted. This flag, when specified with true, indicates that the sub-deployment must not be deployed in the referring partition
| Available Since | Release 12.2.1.0.0 |
| Privileges | Read/Write |
| Type | boolean |
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 |
|
You can add a target to specify additional servers on which the deployment can be deployed. The targets must be either clusters or servers.
| Operation Name | "addTarget" |
| Parameters | Object [] { target }
where:
|
| Signature | String [] {
"weblogic.management.configuration.TargetMBean" } |
| Returns |
void
|
| 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 |
|
Removes the value of the Target attribute.
For more information, see:
| Operation Name | "removeTarget" |
| Parameters | Object [] { target }
where:
|
| Signature | String [] {
"weblogic.management.configuration.TargetMBean" } |
| Returns |
void
|
| 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 |
|
Restore the given property to its default value.
| Operation Name | "unSet" |
| Parameters | Object [] { propertyName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|