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.
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.MessagingBridgeMBean
|
||
Factory Methods | |||
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:
|
This section describes attributes that provide access to other MBeans.
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. |
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. |
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:
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 |
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 |
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 |
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. |
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 |
Specifies how the instances of a configured JMS artifact are named and distributed when deployed to a cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:
Distributed
creates an artifact instance on each cluster member in a cluster. Required for all SAF Agents and for cluster targeted or resource group scoped JMS Servers that host distributed destinations.
Singleton
creates one artifact instance on a single cluster member of a
cluster. Required for cluster targeted or resource group scoped JMS
Servers that host standalone (non-distributed) destinations and for
cluster targeted or resource group scoped Path Services. The
Migration Policy
must be On-Failure
or
Always
when using this option with a JMS Server,
On-Failure
when using this option with a Messaging
Bridge, and Always
when using this option with a Path
Service.
The DistributionPolicy
determines the instance name
suffix for cluster targeted JMS artifacts. The suffix for a cluster
targeted Singleton
is -01
and for a
cluster targeted Distributed
is
@ClusterMemberName
.
For more information, see:
Privileges | Read/Write |
Type | java.lang.String |
Default Value | Distributed |
Legal Values |
|
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 |
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. |
Specifies the amount of time, in seconds, to delay before failing a cluster targeted JMS artifact instance back to its preferred server after the preferred server failed and was restarted.
This delay allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.
A value > 0
specifies the time, in seconds, to
delay before failing a JMS artifact back to its user preferred
server.
A value of 0
indicates that the instance would
never failback.
A value of -1
indicates that there is no delay and
the instance would failback immediately.
This setting only applies when the JMS artifact is cluster
targeted and the Migration Policy is set to On-Failure
or Always>
.
Privileges | Read/Write |
Type | long |
Default Value | -1 |
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. |
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 |
Specifies the amount of time, in seconds, to delay before starting a cluster targeted JMS instance on a newly booted WebLogic server. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.
This allows time for the system to stabilize and dependent services to be restarted, preventing a system failure during a reboot.
A value > 0
is the time, in seconds, to delay
before before loading resources after a failure and restart.
A value of 0
specifies no delay.
This setting only applies when the JMS artifact is cluster
targeted and the Migration Policy is set to On-Failure
or Always>
.
For more information, see:
Privileges | Read/Write |
Type | long |
Default Value | 60 |
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. |
Controls migration and restart behavior of cluster targeted JMS service artifact instances. When this setting is configured on a Store it applies to all JMS artifacts that reference the store. Valid options:
Off
disables migration and restart support for cluster targeted JMS
service objects, including the ability to restart a failed
persistent store instance and its associated services. This policy
can not be combined with the Singleton
Migration
Policy.
On-Failure
enables automatic migration and restart of instances on the failure of a subsystem Service or WebLogic Server instance, including automatic fail-back and load balancing of instances.
Always
provides the same behavior as On-Failure
and
automatically migrates instances even in the event of a graceful
shutdown or a partial cluster start.
Cluster leasing must be configured for On-Failure
and Always
.
For more information, see:
Privileges | Read/Write |
Type | java.lang.String |
Default Value | Off |
Legal Values |
|
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 |
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 |
Specifies the number of restart attempts before migrating a failed JMS artifact instance to another server in the WebLogic cluster.
A value > 0
specifies the number of restart
attempts before migrating a failed service instance.
A value of 0
specifies the same behavior as setting RestartInPlace tofalse
.
A value of -1
specifies the service is never
migrated. Instead, it continues to attempt to restart until it
either starts or the server instance shuts down.
Privileges | Read/Write |
Type | int |
Default Value | 6 |
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 |
Specifies the amount of time, in seconds, to delay before a
partially started cluster starts all cluster targeted JMS artifact
instances that are configured with a Migration Policy of
Always
or On-Failure
.
Before this timeout expires or all servers are running, a cluster starts a subset of such instances based on the total number of servers running and the configured cluster size. Once the timeout expires or all servers have started, the system considers the cluster stable and starts any remaining services.
This delay ensures that services are balanced across a cluster even if the servers are started sequentially. It is ignored once a cluster is fully started (stable) or when individual servers are started.
A value > 0
specifies the time, in seconds, to
delay before a partially started cluster starts dynamically
configured services.
A value of 0
specifies no delay.
For more information, see:
Privileges | Read/Write |
Type | long |
Default Value | 240 |
Specifies if message properties are preserved when messages are forwarded by a bridge instance.
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 a foreign JMS server, the following message properties are preserved:
delivery mode
priority
expiration time
Privileges | Read/Write |
Type | boolean |
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 |
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 |
|
Secure value | Exactly-once |
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 |
The longest amount of 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 |
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 |
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. |
Enables periodic automatic restart of failed cluster targeted JMS artifact instance(s) running on healthy WebLogic Server instances. Restart attempts occur before attempts to migrate an instance to a different server in the cluster. When this setting is configured on a Store it applies to all JMS artifacts that reference the store.
Restarts occur when Restart In Place is set to
true
, the JMS artifact is cluster targeted, and the
Migration Policy is set to On-Failure
or
Always>
.
This attribute is not used by WebLogic Messaging Bridges which automatically restart internal connections as needed.
For more information, see:
Privileges | Read/Write |
Type | boolean |
Specifies the amount of time, in seconds, to wait in between attempts to restart a failed service instance.
Privileges | Read/Write |
Type | int |
Default Value | 30 |
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 |
Specifies the initial operating state of a targeted 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 |
Return all tags on this Configuration MBean
Available Since | Release 12.2.1.0.0 |
Privileges | Read/Write |
Type | class java.lang.String[] |
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 |
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. |
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 |
boolean
|
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 addTarget attribute.
For more information, see:
Operation Name | "removeTarget" |
Parameters | Object [] { target }
where:
|
Signature | String [] {
"weblogic.management.configuration.TargetMBean" } |
Returns |
boolean
|
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
|