# 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 Name | If 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 | Factory methods in DomainMBean
Access Points Inherited from DeploymentMBean | Because this MBean extends or implements DeploymentMBean, you can also access this MBean by retrieving DeploymentMBeans. The following attributes contain DeploymentMBeans and its subtypes:
DomainMBean.Deployments |

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

SourceDestination TargetDestination | Targets

### SourceDestination

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

Privileges | Read/Write
Type | BridgeDestinationCommonMBean
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
Type | BridgeDestinationCommonMBean
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
Type | TargetMBean[]
Relationship type: | Reference.

## Attributes

This section describes the following attributes:

AsyncEnabled BatchInterval BatchSize DeploymentOrder DurabilityEnabled IdleTimeMaximum Name Notes Parent PreserveMsgProperty | QOSDegradationAllowed QualityOfService ReconnectDelayIncrease ReconnectDelayMaximum ReconnectDelayMinimum Selector Started TransactionTimeout Type

### 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
Type | boolean
Default Value | true

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

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

- The default value of `-1` indicates that the bridge instance waits until the number of messages reaches the `Batch Size` before it completes a transaction.

Privileges | Read/Write
Type | long
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
Type | int
Default Value | 10
Minimum value | 0

### 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
Type | int
Default Value | 1000
Minimum value | 0
Maximum value | 2147483647

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

- When enabled and the source destination uses durable subscriptions, the source JMS implementation saves messages that are sent when a messaging bridge instance is not running. When the bridge instance is restarted, these messages are forwarded to the target destination. The administrator can choose not to be durable.

- When not enabled, messages that are sent to the source JMS implementation while the bridge instance is down cannot be forwarded to the target destination.

Privileges | Read/Write
Type | boolean
Default Value | true

### IdleTimeMaximum

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

- In asynchronous mode, this is the longest amount of time a messaging bridge instance stays idle before it checks the sanity of its connection to the source.

- In synchronous mode, this is the amount of time the messaging bridge can block on a receive call if no transaction is involved.

Privileges | Read/Write
Type | int
Default Value | 60
Minimum value | 0
Maximum value | 2147483647

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

### 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:

- `message ID`

- `message timestamp`

- `user ID`

- `delivery mode`

- `priority`

- `expiration time`

- `redelivery limit`

- `unit of order name`

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:

- `delivery mode`

- `priority`

- `expiration time`

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

Privileges | Read/Write
Type | boolean

### QOSDegradationAllowed

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

- When enabled, the messaging bridge instance degrades the QOS when the configured QOS is not available. If the QOS is degraded, a log message is delivered to the WebLogic startup window or log file.

- When not enabled, if messaging bridge instance cannot satisfy the quality of service requested, an error results and the messaging bridge instance does not start.

Privileges | Read/Write
Type | boolean

### QualityOfService

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

- `Exactly-once`: Each message in the source destination is transferred to the target exactly once. This is the highest QOS a messaging bridge instance can offer.

- `Atmost-once`: Each message in the source is transferred to the target only once with the possibility of being lost during the forwarding.

- `Duplicate-okay`: Messages in the source destination are transferred to the target (none are lost) but some may appear in the target more than once.

Privileges | Read/Write
Type | java.lang.String
Default Value | Exactly-once
Legal Values | Exactly-once Atmost-once Duplicate-okay
Secure value | Exactly-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.

- Use with `ReconnectDelayMinimum` and `ReconnectDelayMaximum`. After the first failure to connect to a destination, the bridge instance waits for the number of seconds defined by `ReconnectDelayMinimum`. Each time a reconnect attempt fails, the bridge instance increases its waiting time by the number of seconds defined by `ReconnectDelayIncrease`. The maximum delay time is defined by `ReconnectDelayMaximum`. Once the waiting time is increased to the maximum value, the bridge instance stops increase its waiting time. Once the bridge instance successfully connects to the destination, the bridge instance resets its waiting time to the initial value defined by `ReconnectDelayMinimum`.

Privileges | Read/Write
Type | int
Default Value | 5
Minimum value | 0
Maximum value | 2147483647

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

- Use with `ReconnectDelayMinimum` and `ReconnectDelayIncrease`. After the first failure to connect to a destination, a bridge instance waits for the number of seconds defined by `ReconnectDelayMinimum`. Each time a reconnect attempt fails, the bridge instance increases its waiting time by the number of seconds defined by `ReconnectDelayIncrease`. The maximum delay time is defined by `ReconnectDelayMaximum`. Once the waiting time is increased to the maximum value, the bridge instance stops increase its waiting time. Once the bridge instance successfully connects to the destination, the bridge instance resets its waiting time to the initial value defined by `ReconnectDelayMinimum`.

Privileges | Read/Write
Type | int
Default Value | 60
Minimum value | 0
Maximum value | 2147483647

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

- Use with `ReconnectDelayMaximum` and `ReconnectDelayIncrease`. After the first failure to connect to a destination, the bridge instance waits for the number of seconds defined by `ReconnectDelayMinimum`. Each time a reconnect attempt fails, the bridge instance increases its waiting time by the number of seconds defined by `ReconnectDelayIncrease`. The maximum delay time is defined by `ReconnectDelayMaximum`. Once the waiting time is increased to the maximum value, the bridge instance stops increase its waiting time. Once the bridge instance successfully connects to the destination, the bridge instance resets its waiting time to the initial value defined by `ReconnectDelayMinimum`.

Privileges | Read/Write
Type | int
Default Value | 15
Minimum value | 0
Maximum value | 2147483647

### 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:

- For queues, messages that do not match the selection criteria are left behind and accumulate in the queue.

- For topics, messages that do not match the connection criteria are dropped.

Privileges | Read/Write
Type | java.lang.String

### Started

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

- If enabled, the messaging bridge instance forwards messages (running).

- If not enabled, the messaging bridge instance does not forward messages (temporarily stopped).

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.

- Select the `Started` checkbox to start a messaging bridge instance that has been temporarily stopped.

- Clear the `Started` checkbox to temporarily stop a messaging bridge instance that was running.

- This value does not indicate the run-time state of a messaging bridge instance.

Privileges | Read/Write
Type | boolean
Default Value | true

### TransactionTimeout

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

- Transaction timeouts are used when the QOS (quality of service) for a messaging bridge instance requires transactions.

- If a bridge is configured with Exactly-once QOS, the receiving and sending is completed in one transaction.

Privileges | Read/Write
Type | int
Default Value | 30
Minimum value | 0
Maximum value | 2147483647

### 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 freezeCurrentValue isSet removeTarget | restoreDefaultValue unSet

### 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 | `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"`
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 addTarget attribute.

For more information, see:

- addTarget

Operation Name | `"removeTarget"`
Parameters | `Object [] { target }` where: `target` is an object of type `weblogic.management.configuration.TargetMBean` that specifies: target
Signature | `String [] { "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"`
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`