JMSInteropModuleMBean

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This bean defines a system-level JMS resource. It links a separate descriptor that specifies the definition.

Security roles The following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:

  • Deployer
   
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.JMSInteropModuleMBean
   
Factory Methods No factory methods. Instances of this MBean are created automatically.

Related MBeans

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

 

JMSResource

Factory Methods No explicit creator method. The child shares the lifecycle of its parent.    
Privileges Read only    
Type JMSBean
Relationship type: Containment.

 

Resource

Return the Descriptor for the system resource. This should be overridden by the derived system resources.

   
Privileges Read only    
Type DescriptorBean
Relationship type: Reference.

 

SubDeployments

Targeting for subcomponents that differs from targeting for the component.

Factory Methods createSubDeployment (java.lang.String name)

destroySubDeployment (SubDeploymentMBean subDeployment)

Factory methods do not return objects.

See Using factory methods.    

Lookup Operation lookupSubDeployment(String name)

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

Privileges Read only    
Type SubDeploymentMBean[]
Relationship type: Containment.

 

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.

   
Privileges Read/Write    
Type TargetMBean[]
Relationship type: Reference.
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

Attributes

This section describes the following attributes:

 

CachingDisabled

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.

 

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.

   
Privileges Read/Write    
Type java.lang.String

 

DeploymentOrder

An integer value that indicates when this unit is deployed, relative to other deployable units on a server, during startup.

Units with lower values are deployed before those with higher values.

   
Privileges Read/Write    
Type int
Default Value 100

 

DeploymentPrincipalName

A string value that indicates what principal should be used when deploying the file or archive during startup and shutdown. This principal will be used to set the current subject when calling out into application code for interfaces such as ApplicationLifecycleListener. If no principal name is specifed, then the anonymous principal will be used.

   
Privileges Read/Write    
Type java.lang.String

 

DescriptorFileName

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

 

MBeanInfo

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.

 

ModuleType

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

   
Privileges Read/Write    
Type java.lang.String

 

Name of

Unique identifier for this bean instance.

   
Privileges Read/Write    
Type java.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    
Type java.lang.String

 

ObjectName

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.

 

Parent

Return the immediate parent for this MBean

   
Privileges Read/Write    
Type

 

Registered

Returns false if the 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.

 

SourcePath

   
Privileges Read/Write    
Type java.lang.String

 

Type

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.

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.

Operation Name "addTarget"    
Parameters Object [] {  target }

where:

  • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

    The feature to be added to the Target attribute

Signature String [] { "weblogic.management.configuration.TargetMBean" }
Returns void
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

Operation Name "freezeCurrentValue"    
Parameters Object [] {  attributeName }

where:

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

    attributeName

Signature String [] { "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"    
Parameters Object [] {  propertyName }

where:

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

    property to check

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

 

removeTarget

Removes the value of the Target attribute.

For more information, see:

Operation Name "removeTarget"    
Parameters Object [] {  target }

where:

  • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

    The target to remove

Signature String [] { "weblogic.management.configuration.TargetMBean" }
Returns void
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

Operation Name "restoreDefaultValue"    
Parameters Object [] {  attributeName }

where:

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

    attributeName

Signature String [] { "java.lang.String" }
Returns void
Exceptions

  • javax.management.AttributeNotFoundException

 

unSet

Restore the given property to its default value.

Operation Name "unSet"    
Parameters Object [] {  propertyName }

where:

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

    property to restore

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