Bridge (api 0.3.4 API)

java.lang.Object
- org.wildfly.swarm.config.messaging_activemq.server.Bridge

```
public class Bridge
extends Object
```
The function of a bridge is to consume messages from a source queue, and forward them to a target address, typically on a different ActiveMQ server.

Constructor Summary

Constructors
Constructor and Description

Bridge(String key)

Constructors
Constructor and Description
`Bridge(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`checkPeriod()` The period (in milliseconds) between client failure check.
`Bridge`	`checkPeriod(Long value)` The period (in milliseconds) between client failure check.
`Integer`	`confirmationWindowSize()` The confirmation-window-size to use for the connection used to forward messages to the target node.
`Bridge`	`confirmationWindowSize(Integer value)` The confirmation-window-size to use for the connection used to forward messages to the target node.
`Long`	`connectionTtl()` The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat).
`Bridge`	`connectionTtl(Long value)` The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat).
`String`	`discoveryGroup()` The name of the discovery group used by this bridge.
`Bridge`	`discoveryGroup(String value)` The name of the discovery group used by this bridge.
`String`	`filter()` An optional filter string.
`Bridge`	`filter(String value)` An optional filter string.
`String`	`forwardingAddress()` The address on the target server that the message will be forwarded to.
`Bridge`	`forwardingAddress(String value)` The address on the target server that the message will be forwarded to.
`String`	`getKey()`
`Boolean`	`ha()` Whether or not this bridge should support high availability.
`Bridge`	`ha(Boolean value)` Whether or not this bridge should support high availability.
`Integer`	`initialConnectAttempts()` The number of attempts to connect initially with this bridge.
`Bridge`	`initialConnectAttempts(Integer value)` The number of attempts to connect initially with this bridge.
`Long`	`maxRetryInterval()` The maximum interval of time used to retry connections
`Bridge`	`maxRetryInterval(Long value)` The maximum interval of time used to retry connections
`Integer`	`minLargeMessageSize()` The minimum size (in bytes) for a message before it is considered as a large message.
`Bridge`	`minLargeMessageSize(Integer value)` The minimum size (in bytes) for a message before it is considered as a large message.
`String`	`password()` The password to use when creating the bridge connection to the remote server.
`Bridge`	`password(String value)` The password to use when creating the bridge connection to the remote server.
`String`	`queueName()` The unique name of the local queue that the bridge consumes from.
`Bridge`	`queueName(String value)` The unique name of the local queue that the bridge consumes from.
`Integer`	`reconnectAttempts()` The total number of reconnect attempts the bridge will make before giving up and shutting down.
`Bridge`	`reconnectAttempts(Integer value)` The total number of reconnect attempts the bridge will make before giving up and shutting down.
`Integer`	`reconnectAttemptsOnSameNode()` The total number of reconnect attempts on the same node the bridge will make before giving up and shutting down.
`Bridge`	`reconnectAttemptsOnSameNode(Integer value)` The total number of reconnect attempts on the same node the bridge will make before giving up and shutting down.
`Long`	`retryInterval()` The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.
`Bridge`	`retryInterval(Long value)` The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.
`BigDecimal`	`retryIntervalMultiplier()` A multiplier to apply to the time since the last retry to compute the time to the next retry.
`Bridge`	`retryIntervalMultiplier(BigDecimal value)` A multiplier to apply to the time since the last retry to compute the time to the next retry.
`Boolean`	`started()` Whether the bridge is started.
`Bridge`	`started(Boolean value)` Whether the bridge is started.
`List<String>`	`staticConnectors()` A list of names of statically defined connectors used by this bridge.
`Bridge`	`staticConnectors(List<String> value)` A list of names of statically defined connectors used by this bridge.
`String`	`transformerClassName()` The name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface.
`Bridge`	`transformerClassName(String value)` The name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface.
`Boolean`	`useDuplicateDetection()` Whether the bridge will automatically insert a duplicate id property into each message that it forwards.
`Bridge`	`useDuplicateDetection(Boolean value)` Whether the bridge will automatically insert a duplicate id property into each message that it forwards.
`String`	`user()` The user name to use when creating the bridge connection to the remote server.
`Bridge`	`user(String value)` The user name to use when creating the bridge connection to the remote server.

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

- Constructor Detail
  - Bridge
```
public Bridge(String key)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - checkPeriod
```
public Long checkPeriod()
```
    The period (in milliseconds) between client failure check.
  - checkPeriod
```
public Bridge checkPeriod(Long value)
```
    The period (in milliseconds) between client failure check.
  - confirmationWindowSize
```
public Integer confirmationWindowSize()
```
    The confirmation-window-size to use for the connection used to forward messages to the target node.
  - confirmationWindowSize
```
public Bridge confirmationWindowSize(Integer value)
```
    The confirmation-window-size to use for the connection used to forward messages to the target node.
  - connectionTtl
```
public Long connectionTtl()
```
    The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat).
  - connectionTtl
```
public Bridge connectionTtl(Long value)
```
    The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat).
  - discoveryGroup
```
public String discoveryGroup()
```
    The name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined.
  - discoveryGroup
```
public Bridge discoveryGroup(String value)
```
    The name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined.
  - filter
```
public String filter()
```
    An optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the ActiveMQ filter expression syntax described in the ActiveMQ documentation.
  - filter
```
public Bridge filter(String value)
```
    An optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the ActiveMQ filter expression syntax described in the ActiveMQ documentation.
  - forwardingAddress
```
public String forwardingAddress()
```
    The address on the target server that the message will be forwarded to. If a forwarding address is not specified then the original destination of the message will be retained.
  - forwardingAddress
```
public Bridge forwardingAddress(String value)
```
    The address on the target server that the message will be forwarded to. If a forwarding address is not specified then the original destination of the message will be retained.
  - ha
```
public Boolean ha()
```
    Whether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover.
  - ha
```
public Bridge ha(Boolean value)
```
    Whether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover.
  - initialConnectAttempts
```
public Integer initialConnectAttempts()
```
    The number of attempts to connect initially with this bridge.
  - initialConnectAttempts
```
public Bridge initialConnectAttempts(Integer value)
```
    The number of attempts to connect initially with this bridge.
  - maxRetryInterval
```
public Long maxRetryInterval()
```
    The maximum interval of time used to retry connections
  - maxRetryInterval
```
public Bridge maxRetryInterval(Long value)
```
    The maximum interval of time used to retry connections
  - minLargeMessageSize
```
public Integer minLargeMessageSize()
```
    The minimum size (in bytes) for a message before it is considered as a large message.
  - minLargeMessageSize
```
public Bridge minLargeMessageSize(Integer value)
```
    The minimum size (in bytes) for a message before it is considered as a large message.
  - password
```
public String password()
```
    The password to use when creating the bridge connection to the remote server. If it is not specified the default cluster password specified by the cluster-password attribute in the root messaging subsystem resource will be used.
  - password
```
public Bridge password(String value)
```
    The password to use when creating the bridge connection to the remote server. If it is not specified the default cluster password specified by the cluster-password attribute in the root messaging subsystem resource will be used.
  - queueName
```
public String queueName()
```
    The unique name of the local queue that the bridge consumes from.
  - queueName
```
public Bridge queueName(String value)
```
    The unique name of the local queue that the bridge consumes from.
  - reconnectAttempts
```
public Integer reconnectAttempts()
```
    The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.
  - reconnectAttempts
```
public Bridge reconnectAttempts(Integer value)
```
    The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.
  - reconnectAttemptsOnSameNode
```
public Integer reconnectAttemptsOnSameNode()
```
    The total number of reconnect attempts on the same node the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.
  - reconnectAttemptsOnSameNode
```
public Bridge reconnectAttemptsOnSameNode(Integer value)
```
    The total number of reconnect attempts on the same node the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.
  - retryInterval
```
public Long retryInterval()
```
    The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.
  - retryInterval
```
public Bridge retryInterval(Long value)
```
    The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.
  - retryIntervalMultiplier
```
public BigDecimal retryIntervalMultiplier()
```
    A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts.
  - retryIntervalMultiplier
```
public Bridge retryIntervalMultiplier(BigDecimal value)
```
    A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts.
  - started
```
public Boolean started()
```
    Whether the bridge is started.
  - started
```
public Bridge started(Boolean value)
```
    Whether the bridge is started.
  - staticConnectors
```
public List<String> staticConnectors()
```
    A list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined.
  - staticConnectors
```
public Bridge staticConnectors(List<String> value)
```
    A list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined.
  - transformerClassName
```
public String transformerClassName()
```
    The name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface.
  - transformerClassName
```
public Bridge transformerClassName(String value)
```
    The name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface.
  - useDuplicateDetection
```
public Boolean useDuplicateDetection()
```
    Whether the bridge will automatically insert a duplicate id property into each message that it forwards.
  - useDuplicateDetection
```
public Bridge useDuplicateDetection(Boolean value)
```
    Whether the bridge will automatically insert a duplicate id property into each message that it forwards.
  - user
```
public String user()
```
    The user name to use when creating the bridge connection to the remote server. If it is not specified the default cluster user specified by the cluster-user attribute in the root messaging subsystem resource will be used.
  - user
```
public Bridge user(String value)
```
    The user name to use when creating the bridge connection to the remote server. If it is not specified the default cluster user specified by the cluster-user attribute in the root messaging subsystem resource will be used.

Class Bridge

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Bridge

Method Detail

getKey

checkPeriod

checkPeriod

confirmationWindowSize

confirmationWindowSize

connectionTtl

connectionTtl

discoveryGroup

discoveryGroup

filter

filter

forwardingAddress

forwardingAddress

ha

ha

initialConnectAttempts

initialConnectAttempts

maxRetryInterval

maxRetryInterval

minLargeMessageSize

minLargeMessageSize

password

password

queueName

queueName

reconnectAttempts

reconnectAttempts

reconnectAttemptsOnSameNode

reconnectAttemptsOnSameNode

retryInterval

retryInterval

retryIntervalMultiplier

retryIntervalMultiplier

started

started

staticConnectors

staticConnectors

transformerClassName

transformerClassName

useDuplicateDetection

useDuplicateDetection

user

user