MessagingBridgeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean represents a WebLogic messaging bridge. A messaging bridge instance interoperates between separate implementations of WebLogic JMS or between WebLogic JMS and another messaging product.

For WebLogic JMS and third-party JMS products, a messaging bridge communicates with a configured source and target destinations using the resource adapters provided with WebLogic Server.

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


Related MBeans

This section describes attributes that provide access to other MBeans.


SourceDestination

The source destination from which this messaging bridge instance reads messages.

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

TargetDestination

The target destination where a messaging bridge instance sends the messages it receives from the source destination.

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

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
TypeTargetMBean[]
Relationship type: Reference.


Attributes

This section describes the following attributes:


AsyncEnabled

Specifies if a messaging bridge instance forwards in asynchronous messaging mode.

AsyncEnabled only applies to messaging bridge instances whose source destination supports asynchronous receiving. Messaging bridges instances that forward in asynchronous mode are driven by the source destination. A messaging bridge instance listens for messages and forwards them as they arrive. When AsyncEnabled is not selected, a bridge instance is forced to work in synchronous mode, even if the source supports asynchronous receiving.

Note: For a messaging bridge instance with a QOS of Exactly-once to work in asynchronous mode, the source destination has to support the MDBTransaction interface. Otherwise, the bridge automatically switches to synchronous mode if it detects that MDBTransaction is not supported by the source destination.

       
Privileges Read/Write
Typeboolean
Default Valuetrue

BatchInterval

The maximum amount of time, in milliseconds, that a messaging bridge instance waits before sending a batch of messages in one transaction, regardless of whether the Batch Size has been reached or not.

       
Privileges Read/Write
Typelong
Default Value-1

BatchSize

The number of messages that are processed within one transaction.

Batch Size only applies to a messaging bridge instance forwarding messages in synchronous mode and has a QOS (quality of service) that requires two-phase transactions.

       
Privileges Read/Write
Typeint
Default Value10
Minimum value0

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.

DeploymentOrder

A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

       
Privileges Read/Write
Typeint
Default Value1000
Minimum value0
Maximum value2147483647

DurabilityEnabled

Specifies whether or not the messaging bridge allows durable messages.

When enabled and the source destination is a JMS topic, a messaging bridge instance uses a durable subscription to ensure that no messages are lost in the event of a failure. DurabilityEnabled ignored if the source destination is a JMS queue.

       
Privileges Read/Write
Typeboolean
Default Valuetrue

IdleTimeMaximum

The maximum amount of time, in seconds, that a messaging bridge instance remains idle.

       
Privileges Read/Write
Typeint
Default Value60
Minimum value0
Maximum value2147483647

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

PreserveMsgProperty

Specifies if message properties are preserved when messages are forwarded by a bridge instance.

If the target bridge destination is on wls 9.0 or higher, the following message properties are preserved:

If the target bridge destination is on wls between 6.0 and 8.1 or on a foreign JMS server, the following message properties are preserved:

If the target bridge destination is on wls 5.1 or older, no properties are preserved.

       
Privileges Read/Write
Typeboolean

QOSDegradationAllowed

Specifies if this messaging bridge instance allows the degradation of its QOS (quality of service) when the configured QOS is not available.

       
Privileges Read/Write
Typeboolean

QualityOfService

The QOS (quality of service) for this messaging bridge instance.

       
Privileges Read/Write
Typejava.lang.String
Default ValueExactly-once
Legal Values
  • Exactly-once
  • Atmost-once
  • Duplicate-okay
Secure valueExactly-once

ReconnectDelayIncrease

The incremental delay time, in seconds, that a messaging bridge instance increases its waiting time between one failed reconnection attempt and the next retry.

       
Privileges Read/Write
Typeint
Default Value5
Minimum value0
Maximum value2147483647

ReconnectDelayMaximum

The longest time, in seconds, that a messaging bridge instance waits between one failed attempt to connect to the source or target, and the next retry.

       
Privileges Read/Write
Typeint
Default Value60
Minimum value0
Maximum value2147483647

ReconnectDelayMinimum

The minimum amount of time, in seconds, that a messaging bridge instance waits before it tries to reconnect to the source or target destination after a failure.

       
Privileges Read/Write
Typeint
Default Value15
Minimum value0
Maximum value2147483647

Registered

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

Selector

The filter for messages that are sent across the messaging bridge instance.

Only messages that match the selection criteria are sent across the messaging bridge:

       
Privileges Read/Write
Typejava.lang.String

Started

Specifies the initial operating state of a targeted messaging bridge instance.

After a messaging bridge has started forwarding messages (running), use Started to temporarily suspend an active messaging bridge instance or restart an stopped messaging bridge instance.

       
Privileges Read/Write
Typeboolean
Default Valuetrue

TransactionTimeout

The amount of time, in seconds, that the transaction manager waits for each transaction before timing it out.

       
Privileges Read/Write
Typeint
Default Value30
Minimum value0
Maximum value2147483647

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:


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"
ParametersObject [] {  target }

where:

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

    The feature to be added to the Target attribute

SignatureString [] { "weblogic.management.configuration.TargetMBean" }
Returns boolean
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"
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

removeTarget

Removes the value of the addTarget attribute.

For more information, see:

   
Operation Name"removeTarget"
ParametersObject [] {  target }

where:

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

    target

SignatureString [] { "weblogic.management.configuration.TargetMBean" }
Returns boolean
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"
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

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