JmsBridge (api 0.3.4 API)

java.lang.Object
- org.wildfly.swarm.config.messaging_activemq.JmsBridge

```
public class JmsBridge
extends Object
```
A JMS bridge instance.

Constructor Summary

Constructors
Constructor and Description

JmsBridge(String key)

Constructors
Constructor and Description
`JmsBridge(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`addMessageidInHeader()` If true, then the original message's message ID will be appended in the message sent to the destination in the header AMQ_BRIDGE_MSG_ID_LIST.
`JmsBridge`	`addMessageidInHeader(Boolean value)` If true, then the original message's message ID will be appended in the message sent to the destination in the header AMQ_BRIDGE_MSG_ID_LIST.
`String`	`clientId()` The JMS client ID to use when creating/looking up the subscription if it is durable and the source destination is a topic.
`JmsBridge`	`clientId(String value)` The JMS client ID to use when creating/looking up the subscription if it is durable and the source destination is a topic.
`Long`	`failureRetryInterval()` The amount of time in milliseconds to wait between trying to recreate connections to the source or target servers when the bridge has detected they have failed.
`JmsBridge`	`failureRetryInterval(Long value)` The amount of time in milliseconds to wait between trying to recreate connections to the source or target servers when the bridge has detected they have failed.
`String`	`getKey()`
`Integer`	`maxBatchSize()` The maximum number of messages to consume from the source destination before sending them in a batch to the target destination.
`JmsBridge`	`maxBatchSize(Integer value)` The maximum number of messages to consume from the source destination before sending them in a batch to the target destination.
`Long`	`maxBatchTime()` The maximum number of milliseconds to wait before sending a batch to target, even if the number of messages consumed has not reached max-batch-size.
`JmsBridge`	`maxBatchTime(Long value)` The maximum number of milliseconds to wait before sending a batch to target, even if the number of messages consumed has not reached max-batch-size.
`Integer`	`maxRetries()` The number of times to attempt to recreate connections to the source or target servers when the bridge has detected they have failed.
`JmsBridge`	`maxRetries(Integer value)` The number of times to attempt to recreate connections to the source or target servers when the bridge has detected they have failed.
`String`	`module()` The name of AS7 module containing the resources required to lookup source and target JMS resources.
`JmsBridge`	`module(String value)` The name of AS7 module containing the resources required to lookup source and target JMS resources.
`Boolean`	`paused()` Whether the JMS bridge is paused.
`JmsBridge`	`paused(Boolean value)` Whether the JMS bridge is paused.
`String`	`qualityOfService()` The desired quality of service mode (AT_MOST_ONCE, DUPLICATES_OK or ONCE_AND_ONLY_ONCE).
`JmsBridge`	`qualityOfService(String value)` The desired quality of service mode (AT_MOST_ONCE, DUPLICATES_OK or ONCE_AND_ONLY_ONCE).
`String`	`selector()` A JMS selector expression used for consuming messages from the source destination.
`JmsBridge`	`selector(String value)` A JMS selector expression used for consuming messages from the source destination.
`String`	`sourceConnectionFactory()` The name of the source connection factory to lookup on the source messaging server.
`JmsBridge`	`sourceConnectionFactory(String value)` The name of the source connection factory to lookup on the source messaging server.
`Map`	`sourceContext()` The properties used to configure the source JNDI initial context.
`JmsBridge`	`sourceContext(Map value)` The properties used to configure the source JNDI initial context.
`String`	`sourceDestination()` The name of the source destination to lookup on the source messaging server.
`JmsBridge`	`sourceDestination(String value)` The name of the source destination to lookup on the source messaging server.
`String`	`sourcePassword()` The password for creating the source connection.
`JmsBridge`	`sourcePassword(String value)` The password for creating the source connection.
`String`	`sourceUser()` The name of the user for creating the source connection.
`JmsBridge`	`sourceUser(String value)` The name of the user for creating the source connection.
`Boolean`	`started()` Whether the JMS bridge is started.
`JmsBridge`	`started(Boolean value)` Whether the JMS bridge is started.
`String`	`subscriptionName()` The name of the subscription if it is durable and the source destination is a topic.
`JmsBridge`	`subscriptionName(String value)` The name of the subscription if it is durable and the source destination is a topic.
`String`	`targetConnectionFactory()` The name of the target connection factory to lookup on the target messaging server.
`JmsBridge`	`targetConnectionFactory(String value)` The name of the target connection factory to lookup on the target messaging server.
`Map`	`targetContext()` The properties used to configure the target JNDI initial context.
`JmsBridge`	`targetContext(Map value)` The properties used to configure the target JNDI initial context.
`String`	`targetDestination()` The name of the target destination to lookup on the target messaging server.
`JmsBridge`	`targetDestination(String value)` The name of the target destination to lookup on the target messaging server.
`String`	`targetPassword()` The password for creating the target connection.
`JmsBridge`	`targetPassword(String value)` The password for creating the target connection.
`String`	`targetUser()` The name of the user for creating the target connection.
`JmsBridge`	`targetUser(String value)` The name of the user for creating the target connection.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JmsBridge
```
public JmsBridge(String key)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - addMessageidInHeader
```
public Boolean addMessageidInHeader()
```
    If true, then the original message's message ID will be appended in the message sent to the destination in the header AMQ_BRIDGE_MSG_ID_LIST. If the message is bridged more than once, each message ID will be appended.
  - addMessageidInHeader
```
public JmsBridge addMessageidInHeader(Boolean value)
```
    If true, then the original message's message ID will be appended in the message sent to the destination in the header AMQ_BRIDGE_MSG_ID_LIST. If the message is bridged more than once, each message ID will be appended.
  - clientId
```
public String clientId()
```
    The JMS client ID to use when creating/looking up the subscription if it is durable and the source destination is a topic.
  - clientId
```
public JmsBridge clientId(String value)
```
    The JMS client ID to use when creating/looking up the subscription if it is durable and the source destination is a topic.
  - failureRetryInterval
```
public Long failureRetryInterval()
```
    The amount of time in milliseconds to wait between trying to recreate connections to the source or target servers when the bridge has detected they have failed.
  - failureRetryInterval
```
public JmsBridge failureRetryInterval(Long value)
```
    The amount of time in milliseconds to wait between trying to recreate connections to the source or target servers when the bridge has detected they have failed.
  - maxBatchSize
```
public Integer maxBatchSize()
```
    The maximum number of messages to consume from the source destination before sending them in a batch to the target destination. Its value must >= 1.
  - maxBatchSize
```
public JmsBridge maxBatchSize(Integer value)
```
    The maximum number of messages to consume from the source destination before sending them in a batch to the target destination. Its value must >= 1.
  - maxBatchTime
```
public Long maxBatchTime()
```
    The maximum number of milliseconds to wait before sending a batch to target, even if the number of messages consumed has not reached max-batch-size. Its value must be -1 to represent 'wait forever', or >= 1 to specify an actual time.
  - maxBatchTime
```
public JmsBridge maxBatchTime(Long value)
```
    The maximum number of milliseconds to wait before sending a batch to target, even if the number of messages consumed has not reached max-batch-size. Its value must be -1 to represent 'wait forever', or >= 1 to specify an actual time.
  - maxRetries
```
public Integer maxRetries()
```
    The number of times to attempt to recreate connections to the source or target servers when the bridge has detected they have failed. The bridge will give up after trying this number of times. -1 represents 'try forever'.
  - maxRetries
```
public JmsBridge maxRetries(Integer value)
```
    The number of times to attempt to recreate connections to the source or target servers when the bridge has detected they have failed. The bridge will give up after trying this number of times. -1 represents 'try forever'.
  - module
```
public String module()
```
    The name of AS7 module containing the resources required to lookup source and target JMS resources.
  - module
```
public JmsBridge module(String value)
```
    The name of AS7 module containing the resources required to lookup source and target JMS resources.
  - paused
```
public Boolean paused()
```
    Whether the JMS bridge is paused.
  - paused
```
public JmsBridge paused(Boolean value)
```
    Whether the JMS bridge is paused.
  - qualityOfService
```
public String qualityOfService()
```
    The desired quality of service mode (AT_MOST_ONCE, DUPLICATES_OK or ONCE_AND_ONLY_ONCE).
  - qualityOfService
```
public JmsBridge qualityOfService(String value)
```
    The desired quality of service mode (AT_MOST_ONCE, DUPLICATES_OK or ONCE_AND_ONLY_ONCE).
  - selector
```
public String selector()
```
    A JMS selector expression used for consuming messages from the source destination. Only messages that match the selector expression will be bridged from the source to the target destination.
  - selector
```
public JmsBridge selector(String value)
```
    A JMS selector expression used for consuming messages from the source destination. Only messages that match the selector expression will be bridged from the source to the target destination.
  - started
```
public Boolean started()
```
    Whether the JMS bridge is started.
  - started
```
public JmsBridge started(Boolean value)
```
    Whether the JMS bridge is started.
  - subscriptionName
```
public String subscriptionName()
```
    The name of the subscription if it is durable and the source destination is a topic.
  - subscriptionName
```
public JmsBridge subscriptionName(String value)
```
    The name of the subscription if it is durable and the source destination is a topic.
  - sourceConnectionFactory
```
public String sourceConnectionFactory()
```
    The name of the source connection factory to lookup on the source messaging server.
  - sourceConnectionFactory
```
public JmsBridge sourceConnectionFactory(String value)
```
    The name of the source connection factory to lookup on the source messaging server.
  - sourceContext
```
public Map sourceContext()
```
    The properties used to configure the source JNDI initial context.
  - sourceContext
```
public JmsBridge sourceContext(Map value)
```
    The properties used to configure the source JNDI initial context.
  - sourceDestination
```
public String sourceDestination()
```
    The name of the source destination to lookup on the source messaging server.
  - sourceDestination
```
public JmsBridge sourceDestination(String value)
```
    The name of the source destination to lookup on the source messaging server.
  - sourcePassword
```
public String sourcePassword()
```
    The password for creating the source connection.
  - sourcePassword
```
public JmsBridge sourcePassword(String value)
```
    The password for creating the source connection.
  - sourceUser
```
public String sourceUser()
```
    The name of the user for creating the source connection.
  - sourceUser
```
public JmsBridge sourceUser(String value)
```
    The name of the user for creating the source connection.
  - targetConnectionFactory
```
public String targetConnectionFactory()
```
    The name of the target connection factory to lookup on the target messaging server.
  - targetConnectionFactory
```
public JmsBridge targetConnectionFactory(String value)
```
    The name of the target connection factory to lookup on the target messaging server.
  - targetContext
```
public Map targetContext()
```
    The properties used to configure the target JNDI initial context.
  - targetContext
```
public JmsBridge targetContext(Map value)
```
    The properties used to configure the target JNDI initial context.
  - targetDestination
```
public String targetDestination()
```
    The name of the target destination to lookup on the target messaging server.
  - targetDestination
```
public JmsBridge targetDestination(String value)
```
    The name of the target destination to lookup on the target messaging server.
  - targetPassword
```
public String targetPassword()
```
    The password for creating the target connection.
  - targetPassword
```
public JmsBridge targetPassword(String value)
```
    The password for creating the target connection.
  - targetUser
```
public String targetUser()
```
    The name of the user for creating the target connection.
  - targetUser
```
public JmsBridge targetUser(String value)
```
    The name of the user for creating the target connection.

Class JmsBridge

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JmsBridge

Method Detail

getKey

addMessageidInHeader

addMessageidInHeader

clientId

clientId

failureRetryInterval

failureRetryInterval

maxBatchSize

maxBatchSize

maxBatchTime

maxBatchTime

maxRetries

maxRetries

module

module

paused

paused

qualityOfService

qualityOfService

selector

selector

started

started

subscriptionName

subscriptionName

sourceConnectionFactory

sourceConnectionFactory

sourceContext

sourceContext

sourceDestination

sourceDestination

sourcePassword

sourcePassword

sourceUser

sourceUser

targetConnectionFactory

targetConnectionFactory

targetContext

targetContext

targetDestination

targetDestination

targetPassword

targetPassword

targetUser

targetUser