ConfigurationMBean, DeploymentMBean, DescriptorBean, DynamicDeploymentMBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, WebLogicMBeanpublic interface MessagingBridgeMBean extends DynamicDeploymentMBean
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.
| Modifier and Type | Field | Description |
|---|---|---|
static java.lang.String |
BRIDGE_POLICY_AUTO |
|
static java.lang.String |
BRIDGE_POLICY_MANUAL |
|
static java.lang.String |
BRIDGE_POLICY_SCHEDULED |
|
static java.lang.String |
BRIDGE_QOS_ATMOST_ONCE |
|
static java.lang.String |
BRIDGE_QOS_DUPLICATE_OKAY |
|
static java.lang.String |
BRIDGE_QOS_EXACTLY_ONCE |
DEFAULT_EMPTY_BYTE_ARRAYDEFAULT_ORDER, MAX_ORDER, MIN_ORDER| Modifier and Type | Method | Description |
|---|---|---|
long |
getBatchInterval() |
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. |
int |
getBatchSize() |
The number of messages that are processed within one
transaction.
|
int |
getIdleTimeMaximum() |
The maximum amount of time, in seconds, that a messaging bridge
instance remains idle.
|
java.lang.String |
getName() |
The user-specified name of this MBean instance.
|
boolean |
getPreserveMsgProperty() |
Specifies if message properties are preserved when messages are
forwarded by a bridge instance.
|
java.lang.String |
getQualityOfService() |
The QOS (quality of service) for this messaging bridge
instance.
|
int |
getReconnectDelayIncrease() |
The incremental delay time, in seconds, that a messaging bridge
instance increases its waiting time between one failed reconnection
attempt and the next retry.
|
int |
getReconnectDelayMaximum() |
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.
|
int |
getReconnectDelayMinimum() |
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.
|
java.lang.String |
getSelector() |
The filter for messages that are sent across the messaging
bridge instance.
|
BridgeDestinationCommonMBean |
getSourceDestination() |
The source destination from which this messaging bridge instance
reads messages.
|
BridgeDestinationCommonMBean |
getTargetDestination() |
The target destination where a messaging bridge instance sends
the messages it receives from the source destination.
|
int |
getTransactionTimeout() |
The amount of time, in seconds, that the transaction manager
waits for each transaction before timing it out.
|
boolean |
isAsyncEnabled() |
Specifies if a messaging bridge instance forwards in
asynchronous messaging mode.
|
boolean |
isDurabilityEnabled() |
Specifies whether or not the messaging bridge allows durable
messages.
|
boolean |
isQOSDegradationAllowed() |
Specifies if this messaging bridge instance allows the
degradation of its QOS (quality of service) when the configured QOS
is not available.
|
boolean |
isStarted() |
Specifies the initial operating state of a targeted messaging
bridge instance.
|
void |
setAsyncEnabled(boolean asyncEnabled) |
Sets the value of the
AsyncEnabled attribute. |
void |
setBatchInterval(long interval) |
Sets the value of the
BatchInterval attribute. |
void |
setBatchSize(int size) |
Sets the value of the
BatchSize attribute. |
void |
setDurabilityEnabled(boolean durable) |
Sets the value of the
DurabilityEnabled
attribute. |
void |
setIdleTimeMaximum(int time) |
Sets the value of the
IdleTimeMaximum
attribute. |
void |
setPreserveMsgProperty(boolean preserveMsgProperty) |
Sets the value of the
preserveMsgProperty
attribute. |
void |
setQOSDegradationAllowed(boolean degradationAllowed) |
Sets the value of the
QOSDegradationAllowed
attribute. |
void |
setQualityOfService(java.lang.String qos) |
Sets the value of the
QualityOfService
attribute. |
void |
setReconnectDelayIncrease(int time) |
Sets the value of the
ReconnectDelayIncrease
attribute. |
void |
setReconnectDelayMaximum(int time) |
Sets the value of the
ReconnectDelayMaximum
attribute. |
void |
setReconnectDelayMinimum(int time) |
Sets the value of the
ReconnectDelayMinimum
attribute. |
void |
setSelector(java.lang.String selector) |
Sets the value of the
Selector attribute. |
void |
setSourceDestination(BridgeDestinationCommonMBean sourceDestination) |
Sets the value of the
SourceDestination
attribute. |
void |
setStarted(boolean started) |
Sets the value of the
Started attribute. |
void |
setTargetDestination(BridgeDestinationCommonMBean targetDestination) |
Sets the value of the
TargetDestination
attribute. |
void |
setTransactionTimeout(int timeout) |
Sets the value of the
TransactionTimeout
attribute. |
freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSetaddTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargetsaddPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListenergetDistributionPolicy, getFailbackDelaySeconds, getFailOverLimit, getInitialBootDelaySeconds, getMigrationPolicy, getNumberOfRestartAttempts, getPartialClusterStabilityDelaySeconds, getRebalanceEnabled, getRestartInPlace, getSecondsBetweenRestarts, setDistributionPolicy, setFailbackDelaySeconds, setFailOverLimit, setInitialBootDelaySeconds, setMigrationPolicy, setNumberOfRestartAttempts, setPartialClusterStabilityDelaySeconds, setRebalanceEnabled, setRestartInPlace, setSecondsBetweenRestartsgetAttribute, getAttributes, invoke, setAttribute, setAttributespostDeregister, postRegister, preDeregister, preRegisteraddNotificationListener, getNotificationInfo, removeNotificationListenergetMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParentstatic final java.lang.String BRIDGE_POLICY_AUTO
static final java.lang.String BRIDGE_POLICY_MANUAL
static final java.lang.String BRIDGE_POLICY_SCHEDULED
static final java.lang.String BRIDGE_QOS_EXACTLY_ONCE
static final java.lang.String BRIDGE_QOS_ATMOST_ONCE
static final java.lang.String BRIDGE_QOS_DUPLICATE_OKAY
java.lang.String getName()
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
getName in interface ConfigurationMBeangetName in interface WebLogicMBeanBridgeDestinationCommonMBean getSourceDestination()
The source destination from which this messaging bridge instance reads messages.
void setSourceDestination(BridgeDestinationCommonMBean sourceDestination) throws javax.management.InvalidAttributeValueException
Sets the value of the SourceDestination
attribute.
sourceDestination - The new sourceDestination valuejavax.management.InvalidAttributeValueExceptiongetSourceDestination()BridgeDestinationCommonMBean getTargetDestination()
The target destination where a messaging bridge instance sends the messages it receives from the source destination.
void setTargetDestination(BridgeDestinationCommonMBean targetDestination) throws javax.management.InvalidAttributeValueException
Sets the value of the TargetDestination
attribute.
targetDestination - The new targetDestination valuejavax.management.InvalidAttributeValueExceptiongetTargetDestination()java.lang.String getSelector()
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.
void setSelector(java.lang.String selector)
throws javax.management.InvalidAttributeValueException
Sets the value of the Selector attribute.
selector - The new selector valuejavax.management.InvalidAttributeValueExceptiongetSelector()java.lang.String getQualityOfService()
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.
void setQualityOfService(java.lang.String qos)
throws javax.management.InvalidAttributeValueException
Sets the value of the QualityOfService
attribute.
qos - The new qualityOfService valuejavax.management.InvalidAttributeValueExceptiongetQualityOfService()boolean isQOSDegradationAllowed()
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.
void setQOSDegradationAllowed(boolean degradationAllowed)
throws javax.management.InvalidAttributeValueException
Sets the value of the QOSDegradationAllowed
attribute.
degradationAllowed - The new qOSDegradationAllowed valuejavax.management.InvalidAttributeValueExceptionisQOSDegradationAllowed()boolean isDurabilityEnabled()
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.
void setDurabilityEnabled(boolean durable)
throws javax.management.InvalidAttributeValueException
Sets the value of the DurabilityEnabled
attribute.
durable - The new durabilityEnabled valuejavax.management.InvalidAttributeValueExceptionisDurabilityEnabled()int getReconnectDelayMinimum()
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.
void setReconnectDelayMinimum(int time)
throws javax.management.InvalidAttributeValueException
Sets the value of the ReconnectDelayMinimum
attribute.
time - The new reconnectDelayMinimum valuejavax.management.InvalidAttributeValueExceptiongetReconnectDelayMinimum()int getReconnectDelayIncrease()
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.
void setReconnectDelayIncrease(int time)
throws javax.management.InvalidAttributeValueException
Sets the value of the ReconnectDelayIncrease
attribute.
time - The new reconnectDelayIncrease valuejavax.management.InvalidAttributeValueExceptiongetReconnectDelayIncrease()int getReconnectDelayMaximum()
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.
void setReconnectDelayMaximum(int time)
throws javax.management.InvalidAttributeValueException
Sets the value of the ReconnectDelayMaximum
attribute.
time - The new reconnectDelayMaximum valuejavax.management.InvalidAttributeValueExceptiongetReconnectDelayMaximum()int getIdleTimeMaximum()
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.
void setIdleTimeMaximum(int time)
throws javax.management.InvalidAttributeValueException
Sets the value of the IdleTimeMaximum
attribute.
time - The new idleTimeMaximum valuejavax.management.InvalidAttributeValueExceptiongetIdleTimeMaximum()int getTransactionTimeout()
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.
void setTransactionTimeout(int timeout)
throws javax.management.InvalidAttributeValueException
Sets the value of the TransactionTimeout
attribute.
timeout - The new transactionTimeout valuejavax.management.InvalidAttributeValueExceptiongetTransactionTimeout()boolean isAsyncEnabled()
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.
void setAsyncEnabled(boolean asyncEnabled)
throws javax.management.InvalidAttributeValueException
Sets the value of the AsyncEnabled attribute.
asyncEnabled - The new asyncEnabled valuejavax.management.InvalidAttributeValueExceptionisAsyncEnabled()boolean isStarted()
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.
void setStarted(boolean started)
throws javax.management.InvalidAttributeValueException
Sets the value of the Started attribute.
started - The new started valuejavax.management.InvalidAttributeValueExceptionisStarted()int getBatchSize()
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.
void setBatchSize(int size)
throws javax.management.InvalidAttributeValueException
Sets the value of the BatchSize attribute.
size - The new batchSize valuejavax.management.InvalidAttributeValueExceptiongetBatchSize()long getBatchInterval()
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.
void setBatchInterval(long interval)
throws javax.management.InvalidAttributeValueException
Sets the value of the BatchInterval attribute.
interval - The new batchInterval valuejavax.management.InvalidAttributeValueExceptiongetBatchInterval()boolean getPreserveMsgProperty()
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
void setPreserveMsgProperty(boolean preserveMsgProperty)
throws javax.management.InvalidAttributeValueException
Sets the value of the preserveMsgProperty
attribute.
preserveMsgProperty - Specifies if message properties are preserved when messages are forwarded by a bridge instancejavax.management.InvalidAttributeValueExceptiongetPreserveMsgProperty()