JmsConnector (ActiveMQ 5.15.9 API)

java.lang.Object
- org.apache.activemq.network.jms.JmsConnector

All Implemented Interfaces:

Service

Direct Known Subclasses:

SimpleJmsQueueConnector, SimpleJmsTopicConnector
```
public abstract class JmsConnector
extends Object
implements Service
```
This bridge joins the gap between foreign JMS providers and ActiveMQ As some JMS providers are still only in compliance with JMS v1.0.1 , this bridge itself aimed to be in compliance with the JMS 1.0.2 specification.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ThreadPoolExecutor`	`connectionService`
`protected ActiveMQConnectionFactory`	`embeddedConnectionFactory`
`protected AtomicBoolean`	`failed`
`protected AtomicReference<javax.jms.Connection>`	`foreignConnection`
`protected AtomicBoolean`	`foreignSideInitialized`
`protected JmsMesageConvertor`	`inboundMessageConvertor`
`protected AtomicBoolean`	`initialized`
`protected JndiLookupFactory`	`jndiLocalTemplate`
`protected JndiLookupFactory`	`jndiOutboundTemplate`
`protected String`	`localClientId`
`protected AtomicReference<javax.jms.Connection>`	`localConnection`
`protected String`	`localPassword`
`protected AtomicBoolean`	`localSideInitialized`
`protected String`	`localUsername`
`protected String`	`outboundClientId`
`protected JmsMesageConvertor`	`outboundMessageConvertor`
`protected String`	`outboundPassword`
`protected String`	`outboundUsername`
`protected boolean`	`preferJndiDestinationLookup`
`protected LRUCache<javax.jms.Destination,DestinationBridge>`	`replyToBridges`
`protected int`	`replyToDestinationCacheSize`
`protected AtomicBoolean`	`started`

Constructor Summary

Constructors
Constructor and Description

JmsConnector()

Constructors
Constructor and Description
`JmsConnector()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addInboundBridge(DestinationBridge bridge)`
`protected void`	`addOutboundBridge(DestinationBridge bridge)`
`void`	`clearBridges()`
`protected abstract javax.jms.Destination`	`createReplyToBridge(javax.jms.Destination destination, javax.jms.Connection consumerConnection, javax.jms.Connection producerConnection)`
`protected boolean`	`doConnectorInit()`
`javax.jms.Connection`	`getForeignConnection()`
`JmsMesageConvertor`	`getInboundMessageConvertor()`
`JndiLookupFactory`	`getJndiLocalTemplate()`
`JndiLookupFactory`	`getJndiOutboundTemplate()`
`String`	`getLocalClientId()`
`javax.jms.Connection`	`getLocalConnection()`
`String`	`getLocalPassword()`
`String`	`getLocalUsername()`
`String`	`getName()`
`String`	`getOutboundClientId()`
`JmsMesageConvertor`	`getOutboundMessageConvertor()`
`String`	`getOutboundPassword()`
`String`	`getOutboundUsername()`
`ReconnectionPolicy`	`getReconnectionPolicy()`
`int`	`getReplyToDestinationCacheSize()`
`boolean`	`init()`
`protected abstract void`	`initializeForeignConnection()` Performs the work of connection to the foreign side of the Connection.
`protected abstract void`	`initializeLocalConnection()` Performs the work of connection to the local side of the Connection.
`boolean`	`isConnected()`
`boolean`	`isFailed()`
`boolean`	`isPreferJndiDestinationLookup()`
`protected void`	`removeInboundBridge(DestinationBridge bridge)`
`protected void`	`removeOutboundBridge(DestinationBridge bridge)`
`void`	`setBrokerService(BrokerService service)` One way to configure the local connection - this is called by The BrokerService when the Connector is embedded
`void`	`setInboundMessageConvertor(JmsMesageConvertor jmsMessageConvertor)`
`void`	`setJndiLocalTemplate(JndiLookupFactory jndiTemplate)`
`void`	`setJndiOutboundTemplate(JndiLookupFactory jndiOutboundTemplate)`
`void`	`setLocalClientId(String localClientId)`
`void`	`setLocalPassword(String localPassword)`
`void`	`setLocalUsername(String localUsername)`
`void`	`setName(String name)`
`void`	`setOutboundClientId(String outboundClientId)`
`void`	`setOutboundMessageConvertor(JmsMesageConvertor outboundMessageConvertor)`
`void`	`setOutboundPassword(String outboundPassword)`
`void`	`setOutboundUsername(String outboundUsername)`
`void`	`setPreferJndiDestinationLookup(boolean preferJndiDestinationLookup)` Sets whether the connector should prefer to first try to find a destination in JNDI before using JMS semantics to create a Destination.
`void`	`setReconnectionPolicy(ReconnectionPolicy policy)`
`void`	`setReplyToDestinationCacheSize(int replyToDestinationCacheSize)`
`void`	`start()`
`void`	`stop()`

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

Field Detail

preferJndiDestinationLookup

protected boolean preferJndiDestinationLookup

jndiLocalTemplate

protected JndiLookupFactory jndiLocalTemplate

jndiOutboundTemplate

protected JndiLookupFactory jndiOutboundTemplate

inboundMessageConvertor

protected JmsMesageConvertor inboundMessageConvertor

outboundMessageConvertor

protected JmsMesageConvertor outboundMessageConvertor

initialized
```
protected AtomicBoolean initialized
```

localSideInitialized

protected AtomicBoolean localSideInitialized

foreignSideInitialized

protected AtomicBoolean foreignSideInitialized

started
```
protected AtomicBoolean started
```

failed
```
protected AtomicBoolean failed
```

foreignConnection

protected AtomicReference<javax.jms.Connection> foreignConnection

localConnection

protected AtomicReference<javax.jms.Connection> localConnection

embeddedConnectionFactory

protected ActiveMQConnectionFactory embeddedConnectionFactory

replyToDestinationCacheSize

protected int replyToDestinationCacheSize

outboundUsername
```
protected String outboundUsername
```

outboundPassword
```
protected String outboundPassword
```

localUsername
```
protected String localUsername
```

localPassword
```
protected String localPassword
```

outboundClientId
```
protected String outboundClientId
```

localClientId
```
protected String localClientId
```

replyToBridges

protected LRUCache<javax.jms.Destination,DestinationBridge> replyToBridges

connectionService

protected ThreadPoolExecutor connectionService

Constructor Detail
- JmsConnector
```
public JmsConnector()
```

Method Detail
- init
```
public boolean init()
```
- doConnectorInit
```
protected boolean doConnectorInit()
```
- start
```
public void start()
           throws Exception
```
  Specified by:
  
  start in interface Service
  
  Throws:
  
  Exception
- stop
```
public void stop()
          throws Exception
```
  Specified by:
  
  stop in interface Service
  
  Throws:
  
  Exception
- clearBridges
```
public void clearBridges()
```
- createReplyToBridge
```
protected abstract javax.jms.Destination createReplyToBridge(javax.jms.Destination destination,
                                                             javax.jms.Connection consumerConnection,
                                                             javax.jms.Connection producerConnection)
```
- setBrokerService
```
public void setBrokerService(BrokerService service)
```
  One way to configure the local connection - this is called by The BrokerService when the Connector is embedded
  
  Parameters:
  
  service -
- getLocalConnection
```
public javax.jms.Connection getLocalConnection()
```
- getForeignConnection
```
public javax.jms.Connection getForeignConnection()
```
- getJndiLocalTemplate
```
public JndiLookupFactory getJndiLocalTemplate()
```
  Returns:
  
  Returns the jndiTemplate.
- setJndiLocalTemplate
```
public void setJndiLocalTemplate(JndiLookupFactory jndiTemplate)
```
  Parameters:
  
  jndiTemplate - The jndiTemplate to set.
- getJndiOutboundTemplate
```
public JndiLookupFactory getJndiOutboundTemplate()
```
  Returns:
  
  Returns the jndiOutboundTemplate.
- setJndiOutboundTemplate
```
public void setJndiOutboundTemplate(JndiLookupFactory jndiOutboundTemplate)
```
  Parameters:
  
  jndiOutboundTemplate - The jndiOutboundTemplate to set.
- getInboundMessageConvertor
```
public JmsMesageConvertor getInboundMessageConvertor()
```
  Returns:
  
  Returns the inboundMessageConvertor.
- setInboundMessageConvertor
```
public void setInboundMessageConvertor(JmsMesageConvertor jmsMessageConvertor)
```
  Parameters:
  
  jmsMessageConvertor - The jmsMessageConvertor to set.
- getOutboundMessageConvertor
```
public JmsMesageConvertor getOutboundMessageConvertor()
```
  Returns:
  
  Returns the outboundMessageConvertor.
- setOutboundMessageConvertor
```
public void setOutboundMessageConvertor(JmsMesageConvertor outboundMessageConvertor)
```
  Parameters:
  
  outboundMessageConvertor - The outboundMessageConvertor to set.
- getReplyToDestinationCacheSize
```
public int getReplyToDestinationCacheSize()
```
  Returns:
  
  Returns the replyToDestinationCacheSize.
- setReplyToDestinationCacheSize
```
public void setReplyToDestinationCacheSize(int replyToDestinationCacheSize)
```
  Parameters:
  
  replyToDestinationCacheSize - The replyToDestinationCacheSize to set.
- getLocalPassword
```
public String getLocalPassword()
```
  Returns:
  
  Returns the localPassword.
- setLocalPassword
```
public void setLocalPassword(String localPassword)
```
  Parameters:
  
  localPassword - The localPassword to set.
- getLocalUsername
```
public String getLocalUsername()
```
  Returns:
  
  Returns the localUsername.
- setLocalUsername
```
public void setLocalUsername(String localUsername)
```
  Parameters:
  
  localUsername - The localUsername to set.
- getOutboundPassword
```
public String getOutboundPassword()
```
  Returns:
  
  Returns the outboundPassword.
- setOutboundPassword
```
public void setOutboundPassword(String outboundPassword)
```
  Parameters:
  
  outboundPassword - The outboundPassword to set.
- getOutboundUsername
```
public String getOutboundUsername()
```
  Returns:
  
  Returns the outboundUsername.
- setOutboundUsername
```
public void setOutboundUsername(String outboundUsername)
```
  Parameters:
  
  outboundUsername - The outboundUsername to set.
- getOutboundClientId
```
public String getOutboundClientId()
```
  Returns:
  
  the outboundClientId
- setOutboundClientId
```
public void setOutboundClientId(String outboundClientId)
```
  Parameters:
  
  outboundClientId - the outboundClientId to set
- getLocalClientId
```
public String getLocalClientId()
```
  Returns:
  
  the localClientId
- setLocalClientId
```
public void setLocalClientId(String localClientId)
```
  Parameters:
  
  localClientId - the localClientId to set
- getReconnectionPolicy
```
public ReconnectionPolicy getReconnectionPolicy()
```
  Returns:
  
  the currently configured reconnection policy.
- setReconnectionPolicy
```
public void setReconnectionPolicy(ReconnectionPolicy policy)
```
  Parameters:
  
  policy - The new reconnection policy this JmsConnector should use.
- isPreferJndiDestinationLookup
```
public boolean isPreferJndiDestinationLookup()
```
  Returns:
  
  the preferJndiDestinationLookup
- setPreferJndiDestinationLookup
```
public void setPreferJndiDestinationLookup(boolean preferJndiDestinationLookup)
```
  Sets whether the connector should prefer to first try to find a destination in JNDI before using JMS semantics to create a Destination. By default the connector will first use JMS semantics and then fall-back to JNDI lookup, setting this value to true will reverse that ordering.
  
  Parameters:
  
  preferJndiDestinationLookup - the preferJndiDestinationLookup to set
- isConnected
```
public boolean isConnected()
```
  Returns:
  
  returns true if the JmsConnector is connected to both brokers.
- addInboundBridge
```
protected void addInboundBridge(DestinationBridge bridge)
```
- addOutboundBridge
```
protected void addOutboundBridge(DestinationBridge bridge)
```
- removeInboundBridge
```
protected void removeInboundBridge(DestinationBridge bridge)
```
- removeOutboundBridge
```
protected void removeOutboundBridge(DestinationBridge bridge)
```
- getName
```
public String getName()
```
- setName
```
public void setName(String name)
```
- isFailed
```
public boolean isFailed()
```
- initializeLocalConnection
```
protected abstract void initializeLocalConnection()
                                           throws Exception
```
  Performs the work of connection to the local side of the Connection.
  This creates the initial connection to the local end of the JmsConnector and then sets up all the destination bridges with the information needed to bridge on the local side of the connection.
  
  Throws:
  
  Exception - if the connection cannot be established for any reason.
- initializeForeignConnection
```
protected abstract void initializeForeignConnection()
                                             throws Exception
```
  Performs the work of connection to the foreign side of the Connection.
  This creates the initial connection to the foreign end of the JmsConnector and then sets up all the destination bridges with the information needed to bridge on the foreign side of the connection.
  
  Throws:
  
  Exception - if the connection cannot be established for any reason.

Class JmsConnector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

preferJndiDestinationLookup

jndiLocalTemplate

jndiOutboundTemplate

inboundMessageConvertor

outboundMessageConvertor

initialized

localSideInitialized

foreignSideInitialized

started

failed

foreignConnection

localConnection

embeddedConnectionFactory

replyToDestinationCacheSize

outboundUsername

outboundPassword

localUsername

localPassword

outboundClientId

localClientId

replyToBridges

connectionService

Constructor Detail

JmsConnector

Method Detail

init

doConnectorInit

start

stop

clearBridges

createReplyToBridge

setBrokerService

getLocalConnection

getForeignConnection

getJndiLocalTemplate

setJndiLocalTemplate

getJndiOutboundTemplate

setJndiOutboundTemplate

getInboundMessageConvertor

setInboundMessageConvertor

getOutboundMessageConvertor

setOutboundMessageConvertor

getReplyToDestinationCacheSize

setReplyToDestinationCacheSize

getLocalPassword

setLocalPassword

getLocalUsername

setLocalUsername

getOutboundPassword

setOutboundPassword

getOutboundUsername

setOutboundUsername

getOutboundClientId

setOutboundClientId

getLocalClientId

setLocalClientId

getReconnectionPolicy

setReconnectionPolicy

isPreferJndiDestinationLookup

setPreferJndiDestinationLookup

isConnected

addInboundBridge

addOutboundBridge

removeInboundBridge

removeOutboundBridge

getName

setName

isFailed

initializeLocalConnection

initializeForeignConnection