AbstractConnectionFactory (Spring AMQP 1.6.0.RELEASE API)

java.lang.Object
- org.springframework.amqp.rabbit.connection.AbstractConnectionFactory

All Implemented Interfaces:

ConnectionFactory, Aware, BeanNameAware, DisposableBean

Direct Known Subclasses:

CachingConnectionFactory
```
public abstract class AbstractConnectionFactory
extends Object
implements ConnectionFactory, DisposableBean, BeanNameAware
```
Author:

Dave Syer, Gary Russell, Steve Powell

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_CLOSE_TIMEOUT

protected org.apache.commons.logging.Log logger

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_CLOSE_TIMEOUT`
`protected org.apache.commons.logging.Log`	`logger`

Constructor Summary

Constructors
Constructor and Description
`AbstractConnectionFactory(com.rabbitmq.client.ConnectionFactory rabbitConnectionFactory)` Create a new AbstractConnectionFactory for the given target ConnectionFactory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChannelListener(ChannelListener listener)`
`void`	`addConnectionListener(ConnectionListener listener)`
`void`	`clearConnectionListeners()`
`protected Connection`	`createBareConnection()`
`void`	`destroy()`
`protected ChannelListener`	`getChannelListener()` A composite channel listener to be used by subclasses when creating and closing channels.
`int`	`getCloseTimeout()`
`protected ConnectionListener`	`getConnectionListener()` A composite connection listener to be used by subclasses when creating and closing connections.
`protected String`	`getDefaultHostName()`
`protected ExecutorService`	`getExecutorService()`
`String`	`getHost()`
`int`	`getPort()`
`com.rabbitmq.client.ConnectionFactory`	`getRabbitConnectionFactory()` Return a reference to the underlying Rabbit Connection factory.
`String`	`getUsername()` Return the user name from the unerlying rabbit connection factory.
`String`	`getVirtualHost()`
`boolean`	`removeConnectionListener(ConnectionListener listener)`
`void`	`setAddresses(String addresses)` Set addresses for clustering.
`void`	`setBeanName(String name)`
`void`	`setChannelListeners(List<? extends ChannelListener> listeners)`
`void`	`setCloseTimeout(int closeTimeout)` How long to wait (milliseconds) for a response to a connection close operation from the broker; default 30000 (30 seconds).
`void`	`setConnectionListeners(List<? extends ConnectionListener> listeners)`
`void`	`setConnectionThreadFactory(ThreadFactory threadFactory)` Set the `ThreadFactory` on the underlying rabbit connection factory.
`void`	`setConnectionTimeout(int connectionTimeout)`
`void`	`setExecutor(Executor executor)` Provide an Executor for use by the Rabbit ConnectionFactory when creating connections.
`void`	`setHost(String host)`
`void`	`setPassword(String password)`
`void`	`setPort(int port)`
`void`	`setRequestedHeartBeat(int requestedHeartBeat)`
`void`	`setUri(String uri)`
`void`	`setUri(URI uri)`
`void`	`setUsername(String username)`
`void`	`setVirtualHost(String virtualHost)`
`String`	`toString()`

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

Methods inherited from interface org.springframework.amqp.rabbit.connection.ConnectionFactory
createConnection

- Field Detail
  - logger
```
protected final org.apache.commons.logging.Log logger
```
  - DEFAULT_CLOSE_TIMEOUT
```
public static final int DEFAULT_CLOSE_TIMEOUT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractConnectionFactory
```
public AbstractConnectionFactory(com.rabbitmq.client.ConnectionFactory rabbitConnectionFactory)
```
    Create a new AbstractConnectionFactory for the given target ConnectionFactory.
    
    Parameters:
    
    rabbitConnectionFactory - the target ConnectionFactory
- Method Detail
  - getRabbitConnectionFactory
```
public com.rabbitmq.client.ConnectionFactory getRabbitConnectionFactory()
```
    Return a reference to the underlying Rabbit Connection factory.
    
    Returns:
    
    the connection factory.
    
    Since:
    
    1.5.6
  - getUsername
```
public String getUsername()
```
    Return the user name from the unerlying rabbit connection factory.
    
    Specified by:
    
    getUsername in interface ConnectionFactory
    
    Returns:
    
    the user name.
    
    Since:
    
    1.6
  - setUsername
```
public void setUsername(String username)
```
  - setPassword
```
public void setPassword(String password)
```
  - setHost
```
public void setHost(String host)
```
  - setConnectionThreadFactory
```
public void setConnectionThreadFactory(ThreadFactory threadFactory)
```
    Set the ThreadFactory on the underlying rabbit connection factory. Not exposed using XML configuration; define a bean for the Rabbit CF and provide it to the Spring CF using the connection-factory attribute. TODO: remove this comment when AMQP-554 is resolved.
    
    Parameters:
    
    threadFactory - the thread factory.
    
    Since:
    
    1.5.3
  - setUri
```
public void setUri(URI uri)
```
    Parameters:
    
    uri - the URI
    
    Since:
    
    1.5
    
    See Also:
    
    ConnectionFactory.setUri(URI)
  - setUri
```
public void setUri(String uri)
```
    Parameters:
    
    uri - the URI
    
    Since:
    
    1.5
    
    See Also:
    
    ConnectionFactory.setUri(String)
  - getHost
```
public String getHost()
```
    Specified by:
    
    getHost in interface ConnectionFactory
  - setVirtualHost
```
public void setVirtualHost(String virtualHost)
```
  - getVirtualHost
```
public String getVirtualHost()
```
    Specified by:
    
    getVirtualHost in interface ConnectionFactory
  - setPort
```
public void setPort(int port)
```
  - setRequestedHeartBeat
```
public void setRequestedHeartBeat(int requestedHeartBeat)
```
  - setConnectionTimeout
```
public void setConnectionTimeout(int connectionTimeout)
```
  - getPort
```
public int getPort()
```
    Specified by:
    
    getPort in interface ConnectionFactory
  - setAddresses
```
public void setAddresses(String addresses)
```
    Set addresses for clustering. This property overrides the host+port properties if not empty.
    
    Parameters:
    
    addresses - list of addresses with form "host[:port],..."
  - getConnectionListener
```
protected ConnectionListener getConnectionListener()
```
    A composite connection listener to be used by subclasses when creating and closing connections.
    
    Returns:
    
    the connection listener
  - getChannelListener
```
protected ChannelListener getChannelListener()
```
    A composite channel listener to be used by subclasses when creating and closing channels.
    
    Returns:
    
    the channel listener
  - setConnectionListeners
```
public void setConnectionListeners(List<? extends ConnectionListener> listeners)
```
  - addConnectionListener
```
public void addConnectionListener(ConnectionListener listener)
```
    Specified by:
    
    addConnectionListener in interface ConnectionFactory
  - removeConnectionListener
```
public boolean removeConnectionListener(ConnectionListener listener)
```
    Specified by:
    
    removeConnectionListener in interface ConnectionFactory
  - clearConnectionListeners
```
public void clearConnectionListeners()
```
    Specified by:
    
    clearConnectionListeners in interface ConnectionFactory
  - setChannelListeners
```
public void setChannelListeners(List<? extends ChannelListener> listeners)
```
  - addChannelListener
```
public void addChannelListener(ChannelListener listener)
```
  - setExecutor
```
public void setExecutor(Executor executor)
```
    Provide an Executor for use by the Rabbit ConnectionFactory when creating connections. Can either be an ExecutorService or a Spring ThreadPoolTaskExecutor, as defined by a <task:executor/> element.
    
    Parameters:
    
    executor - The executor.
  - getExecutorService
```
protected ExecutorService getExecutorService()
```
  - setCloseTimeout
```
public void setCloseTimeout(int closeTimeout)
```
    How long to wait (milliseconds) for a response to a connection close operation from the broker; default 30000 (30 seconds).
    
    Parameters:
    
    closeTimeout - the closeTimeout to set.
  - getCloseTimeout
```
public int getCloseTimeout()
```
  - setBeanName
```
public void setBeanName(String name)
```
    Specified by:
    
    setBeanName in interface BeanNameAware
  - createBareConnection
```
protected final Connection createBareConnection()
```
  - getDefaultHostName
```
protected final String getDefaultHostName()
```
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface DisposableBean
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractConnectionFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.amqp.rabbit.connection.ConnectionFactory

Field Detail

logger

DEFAULT_CLOSE_TIMEOUT

Constructor Detail

AbstractConnectionFactory

Method Detail

getRabbitConnectionFactory

getUsername

setUsername

setPassword

setHost

setConnectionThreadFactory

setUri

setUri

getHost

setVirtualHost

getVirtualHost

setPort

setRequestedHeartBeat

setConnectionTimeout

getPort

setAddresses

getConnectionListener

getChannelListener

setConnectionListeners

addConnectionListener

removeConnectionListener

clearConnectionListeners

setChannelListeners

addChannelListener

setExecutor

getExecutorService

setCloseTimeout

getCloseTimeout

setBeanName

createBareConnection

getDefaultHostName

destroy

toString