|
BEA Systems, Inc. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class represents a WebLogic messaging bridge, which enables you to configure a forwarding mechanism between any two messaging products--thereby, providing interoperability 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. For non-JMS messaging products, you need to obtain a custom adapter from a third-party OEM vendor or contact BEA Professional Services to access non-JMS source or target destinations.
Field Summary | |
static java.lang.String |
BRIDGE_POLICY_AUTO
Description of the Field. |
static java.lang.String |
BRIDGE_POLICY_MANUAL
Description of the Field. |
static java.lang.String |
BRIDGE_POLICY_SCHEDULED
Description of the Field. |
static java.lang.String |
BRIDGE_QOS_ATMOST_ONCE
Description of the Field. |
static java.lang.String |
BRIDGE_QOS_DUPLICATE_OKAY
Description of the Field. |
static java.lang.String |
BRIDGE_QOS_EXACTLY_ONCE
Description of the Field. |
static long |
CACHING_STUB_SVUID
Description of the Field. |
Fields inherited from class weblogic.management.configuration.DeploymentMBean |
CACHING_STUB_SVUID,
DEFAULT_ORDER,
MAX_ORDER,
MIN_ORDER |
Fields inherited from class weblogic.management.configuration.ConfigurationMBean |
CACHING_STUB_SVUID |
Method Summary | |
long |
getBatchInterval()
The maximum time, in milliseconds, that the bridge will wait before sending a batch of messages in one transaction, regardless of whether the Batch Size amount has been reached or not. |
int |
getBatchSize()
The number of messages that are processed within one transaction. |
int |
getIdleTimeMaximum()
The maximum amount of idle time, in seconds, for the messaging bridge. |
java.lang.String |
getQualityOfService()
The QOS (quality of service) values for the messaging bridge: |
int |
getReconnectDelayIncrease()
The incremental delay time, in milliseconds, that the messaging bridge will wait longer between one failed reconnection attempt and the next retry. |
int |
getReconnectDelayMaximum()
The longest time, in seconds, that the messaging bridge will wait between one failed attempt to reconnect to the source or target and the next retry. |
int |
getReconnectDelayMinimum()
The minimum amount of time, in seconds, that the messaging bridge will wait before it tries to reconnect to the source or target destination after a failure. |
java.lang.String |
getSelector()
The message selector for the messaging bridge. |
BridgeDestinationCommonMBean |
getSourceDestination()
The source bridge destination for the messaging bridge. |
BridgeDestinationCommonMBean |
getTargetDestination()
The target bridge destination for the messaging bridge. |
int |
getTransactionTimeout()
The amount of time, in seconds, that the transaction manager will wait for each transaction before timing it out. |
boolean |
isAsyncEnabled()
Specifies whether the messaging bridge will work in asynchronous messaging mode. |
boolean |
isDurabilityEnabled()
Specifies whether the messaging bridge allows durable messages. |
boolean |
isQOSDegradationAllowed()
Specifies whether the messaging bridge allows the degradation of its QOS when the configured QOS is not available. |
boolean |
isStarted()
The initial state of the messaging bridge (that is, the state when the bridge boots). |
void |
setAsyncEnabled(boolean asyncEnabled)
Specifies whether the messaging bridge will work in asynchronous messaging mode. |
void |
setBatchInterval(long interval)
The maximum time, in milliseconds, that the bridge will wait before sending a batch of messages in one transaction, regardless of whether the Batch Size amount has been reached or not. |
void |
setBatchSize(int size)
The number of messages that are processed within one transaction. |
void |
setDurabilityEnabled(boolean durable)
Specifies whether the messaging bridge allows durable messages. |
void |
setIdleTimeMaximum(int time)
The maximum amount of idle time, in seconds, for the messaging bridge. |
void |
setQOSDegradationAllowed(boolean degradationAllowed)
Specfies whether the messaging bridge allows the degradation of its QOS when the configured QOS is not available. |
void |
setQualityOfService(java.lang.String qos)
The QOS (quality of service) values for the messaging bridge: |
void |
setReconnectDelayIncrease(int time)
The incremental delay time, in milliseconds, that the messaging bridge will wait longer between one failed reconnection attempt and the next retry. |
void |
setReconnectDelayMaximum(int time)
The longest time, in seconds, that the messaging bridge will wait between one failed attempt to reconnect to the source or target and the next retry. |
void |
setReconnectDelayMinimum(int time)
The minimum amount of time, in seconds, that the messaging bridge will wait before it tries to reconnect to the source or target destination after a failure. |
void |
setSelector(java.lang.String selector)
The message selector for the messaging bridge. |
void |
setSourceDestination(BridgeDestinationCommonMBean sourceDestination)
The source bridge destination for the messaging bridge. |
void |
setStarted(boolean started)
The initial state of the messaging bridge (that is, the state when the bridge boots). |
void |
setTargetDestination(BridgeDestinationCommonMBean targetDestination)
The target bridge destination for the messaging bridge. |
void |
setTransactionTimeout(int timeout)
The amount of time, in seconds, that the transaction manager will wait for each transaction before timing it out. |
Methods inherited from interface weblogic.management.configuration.DeploymentMBean |
addTarget,
getDeploymentOrder,
getTargets,
removeTarget,
setDeploymentOrder,
setTargets |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
freezeCurrentValue,
getNotes,
restoreDefaultValue,
setComments,
setDefaultedMBean,
setNotes,
setPersistenceEnabled |
Methods inherited from interface weblogic.management.WebLogicMBean |
getMBeanInfo,
getName,
getObjectName,
getParent,
getType,
isCachingDisabled,
isRegistered,
setName,
setParent |
Methods inherited from interface javax.management.DynamicMBean |
getAttribute,
getAttributes,
invoke,
setAttribute,
setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
postDeregister,
postRegister,
preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
addNotificationListener,
getNotificationInfo,
removeNotificationListener |
Field Detail |
public static final long CACHING_STUB_SVUID
public static final java.lang.String BRIDGE_POLICY_AUTO
public static final java.lang.String BRIDGE_POLICY_MANUAL
public static final java.lang.String BRIDGE_POLICY_SCHEDULED
public static final java.lang.String BRIDGE_QOS_EXACTLY_ONCE
public static final java.lang.String BRIDGE_QOS_ATMOST_ONCE
public static final java.lang.String BRIDGE_QOS_DUPLICATE_OKAY
Method Detail |
public BridgeDestinationCommonMBean getSourceDestination()
This must be an instance of either the JMS Bridge Destination (JMSBridgeDestinationMBean) or the General Bridge Destination (BridgeDestinationMBean), which are used to define the source destination that the messaging bridge will read messages from.
public void setSourceDestination(BridgeDestinationCommonMBean sourceDestination) throws javax.management.InvalidAttributeValueException
This must be an instance of either the JMS Bridge Destination (JMSBridgeDestinationMBean) or the General Bridge Destination (BridgeDestinationMBean), which are used to define the source destination that the messaging bridge will read messages from.
sourceDestination
- The new sourceDestination valuepublic BridgeDestinationCommonMBean getTargetDestination()
This must be an instance of either the JMS Bridge Destination (JMSBridgeDestinationMBean) or the General Bridge Destination (BridgeDestinationMBean), which are used to define the target destination that the messaging bridge will send the messages it receives from the source destination.
public void setTargetDestination(BridgeDestinationCommonMBean targetDestination) throws javax.management.InvalidAttributeValueException
This must be an instance of either the JMS Bridge Destination (JMSBridgeDestinationMBean) or the General Bridge Destination (BridgeDestinationMBean), which are used to define the target destination that the messaging bridge will send the messages it receives from the source destination.
targetDestination
- The new targetDestination valuepublic java.lang.String getSelector()
The message selector allows you to filter the messages that are sent across the messaging bridge. 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.
public void setSelector(java.lang.String selector) throws javax.management.InvalidAttributeValueException
The selector allows you to filter the messages that are sent across the messaging bridge. 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.
selector
- The new selector valuepublic java.lang.String getQualityOfService()
public void setQualityOfService(java.lang.String qos) throws javax.management.InvalidAttributeValueException
qos
- The new qualityOfService valuepublic boolean isQOSDegradationAllowed()
public void setQOSDegradationAllowed(boolean degradationAllowed) throws javax.management.InvalidAttributeValueException
If set to true, the bridge will degrade the QOS when the configured QOS is not available. If this occurs, a message is delivered to the WebLogic startup window (or log file).
If set to false, and the messaging bridge cannot satisfy the quality of service requested, it will result in an error and the messaging bridge will not start.
degradationAllowed
- The new qOSDegradationAllowed valuepublic boolean isDurabilityEnabled()
This only applies to a source destination that uses durable subscriptions, which allows the source JMS implementation to save messages that are sent to it while the bridge is not running. The bridge will forward these messages to the target destination when it is restarted. The administrator can choose not to be durable.
public void setDurabilityEnabled(boolean durable) throws javax.management.InvalidAttributeValueException
A messaging bridge that has this attribute set to true creates a durable subscription for its source destination--if the source destination type is a topic. This allows the source JMS implementation to save messages that are sent to it while the bridge is not running. The bridge will forward these messages to the target destination when it is restarted. If the value is set to false, messages that are sent to the source JMS topic while the bridge is down cannot be forwarded to the target destination.
durable
- The new durabilityEnabled valuepublic int getReconnectDelayMinimum()
This attribute works with the ReconnectDelayMaximum and ReconnectDelayIncrease attributes. After the first failure to connect to a destination, the bridge will wait for the number of seconds defined by ReconnectDelayMinimum.
If the second trial also fails, it will increase 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 will not increase its waiting time anymore.
Once the bridge successfully connects to the destination, its waiting time will be reset to the initial value defined by ReconnectDelayMinimum.
public void setReconnectDelayMinimum(int time) throws javax.management.InvalidAttributeValueException
This attribute works with the ReconnectDelayMaximum and ReconnectDelayIncrease attributes. After the first failure to connect to a destination, the bridge will wait for the number of seconds defined by ReconnectDelayMinimum. If the second trial also fails, it will increase 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 will not increase its waiting time anymore.
Once the bridge successfully connects to the destination, its waiting time will be reset to the initial value defined by ReconnectDelayMinimum.
time
- The new reconnectDelayMinimum valuepublic int getReconnectDelayIncrease()
This attribute works with the ReconnectDelayMinimum and ReconnectDelayMaximum attributes. After the first failure to connect to a destination, the bridge will wait for the number of seconds defined by ReconnectDelayMinimum.
Each time a reconnect attempt fails, the bridge will increase 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 will not increase its waiting time anymore.
Once the bridge successfully connects to the destination, its waiting time will be reset to the minimum value defined by ReconnectDelayMinimum.
public void setReconnectDelayIncrease(int time) throws javax.management.InvalidAttributeValueException
This attribute works with the ReconnectDelayMinimum and ReconnectDelayMaximum attributes. After the first failure to connect to a destination, the bridge will wait for the number of seconds defined by ReconnectDelayMinimum. Each time a reconnect attempt fails, the bridge will increase 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 will not increase its waiting time anymore.
Once the bridge successfully connects to the destination, its waiting time will be reset to the minimum value defined by ReconnectDelayMinimum.
time
- The new reconnectDelayIncrease valuepublic int getReconnectDelayMaximum()
This attribute works with the ReconnectDelayMinimum and ReconnectionDelayIncrement attributes. After the first failure to connect to a destination, the bridge will wait for the number of seconds defined by ReconnectDelayMinimum.
Each time a reconnect attempt fails, the bridge will increase its waiting time by the number of milliseconds defined by ReconnectDelayIncrease. The maximum delay time is defined by ReconnectDelayMaximum. Once the waiting time is increased to the maximum value, the bridge will not increase its waiting time anymore.
Once the bridge successfully connects to the destination, its waiting time will be reset to the initial value defined by ReconnectDelayMinimum.
public void setReconnectDelayMaximum(int time) throws javax.management.InvalidAttributeValueException
This attribute works with the ReconnectDelayMinimum and ReconnectionDelayIncrement attributes. After the first failure to connect to a destination, the bridge will wait for the number of seconds defined by ReconnectDelayMinimum. Each time a reconnect attempt fails, the bridge will increase its waiting time by the number of milliseconds defined by ReconnectDelayIncrease. The maximum delay time is defined by ReconnectDelayMaximum. Once the waiting time is increased to the maximum value, the bridge will not increase its waiting time anymore.
Once the bridge successfully connects to the destination, its waiting time will be reset to the initial value defined by ReconnectDelayMinimum.
time
- The new reconnectDelayMaximum valuepublic int getIdleTimeMaximum()
If the bridge works in asynchronous mode, the maximum idle time defines the longest time the bridge will stay idle before it checks the sanity of its connection to the source.
If the bridge works in synchronous mode, the maximum idle time defines the amount of time the bridge can block on a receive call if no transaction is involved.
public void setIdleTimeMaximum(int time) throws javax.management.InvalidAttributeValueException
If the bridge works in asynchronous mode, the maximum idle time defines the longest time the bridge will stay idle before it checks the sanity of its connection to the source.
If the bridge works in synchronous mode, the maximum idle time defines the amount of time the bridge can block on a receive call if no transaction is involved.
time
- The new idleTimeMaximum valuepublic int getTransactionTimeout()
Transaction timeouts are used when the QOS for a bridge requires transactions. If a bridge is configured with Exactly-once QOS, the receiving and sending is completed in one transaction.
public void setTransactionTimeout(int timeout) throws javax.management.InvalidAttributeValueException
Transaction timeouts are used when the QOS for a bridge requires transactions. If a bridge is configured with Exactly-once QOS, the receiving and sending is completed in one transaction.
timeout
- The new transactionTimeout valuepublic boolean isAsyncEnabled()
Note: This attribute only applies to messaging bridges whose source destination supports asynchronous receiving.
Messaging bridges that work in asynchronous mode (true) are driven by the source destination. The messaging bridge listens for messages and forwards them as they arrive. When the value is set to false, the bridge is forced to work in synchronous mode, even if the source supports asynchronous receiving.
Note: For a messaging bridge with a QOS of Exactly-once to work in asynchronous mode, the source destination has to support the MDBTransaction interface. Otherwise, the bridge will automatically switch to synchronous mode if it detects that MDBTransaction is not supported by the source destination.
public void setAsyncEnabled(boolean asyncEnabled) throws javax.management.InvalidAttributeValueException
Note: This attribute only applies to messaging bridges whose source destination supports asynchronous receiving.
Messaging bridges that work in asynchronous mode (true) are driven by the source destination. The messaging bridge listens for messages and forwards them as they arrive. When the value is set to false, the bridge is forced to work in synchronous mode, even if the source supports asynchronous receiving.
Note: For a messaging bridge with a QOS of Exactly-once to work in asynchronous mode, the source destination has to support the MDBTransaction interface. Otherwise, the bridge will automatically switch to synchronous mode if it detects that MDBTransaction is not supported by the source destination.
asyncEnabled
- The new asyncEnabled valuepublic boolean isStarted()
If the value is true, the bridge is in working condition. If the value is false, the bridge is temporarily stopped.
Note: This does not indicate the run-time state of the bridge.
public void setStarted(boolean started) throws javax.management.InvalidAttributeValueException
Setting the value to true starts the bridge--if it has not already been started. Setting the value to false temporarily stops the bridge.
Note: This does not indicate the run-time state of the bridge.
started
- The new started valuepublic int getBatchSize()
Note: This attribute only applies to bridges that work in synchronous mode and whose QOS require two-phase transactions.
public void setBatchSize(int size) throws javax.management.InvalidAttributeValueException
Note: This attribute only applies to bridges that work in synchronous mode and whose QOS require two-phase transactions.
size
- The new batchSize valuepublic long getBatchInterval()
The default value of -1 indicates that the bridge will wait until the number of messages reaches the Batch Size before it completes a transaction.
Note: This attribute only applies to bridges that work in synchronous mode and whose QOS require two-phase transactions.
public void setBatchInterval(long interval) throws javax.management.InvalidAttributeValueException
The default value of -1 indicates that the bridge will wait until the number of messages reaches the Batch Size before it completes a transaction.
Note: This attribute only applies to bridges that work in synchronous mode and whose QOS require two-phase transactions.
interval
- The new batchInterval value
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs81b |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |