## org.hornetq.api.jms.management
Interface ConnectionFactoryControl

    public interface ConnectionFactoryControl

A ConnectionFactoryControl is used to manage a JMS ConnectionFactory.
HornetQ JMS ConnectionFactory uses an underlying ClientSessionFactory to connect to HornetQ servers. Please refer to the ClientSessionFactory for a detailed description.

Author:
  Jeff Mesnil, Tim Fox
See Also:
  `ClientSessionFactory`

Method Summary
`void` `addJNDI(String jndi)` Add the JNDI binding to this destination
`long` `getCallTimeout()`
`long` `getClientFailureCheckPeriod()`
`String` `getClientID()` Returns the Client ID of this connection factory (or `null` if it is not set.
`int` `getConfirmationWindowSize()`
`String` `getConnectionLoadBalancingPolicyClassName()`
`long` `getConnectionTTL()`
`int` `getConsumerMaxRate()`
`int` `getConsumerWindowSize()`
`DiscoveryGroupConfiguration` `getDiscoveryGroupConfiguration()` get the discovery group configuration
`int` `getDupsOKBatchSize()` Returns the batch size (in bytes) between acknowledgements when using DUPS_OK_ACKNOWLEDGE mode.
`int` `getFactoryType()` return the type of factory
`String` `getGroupID()`
`int` `getInitialMessagePacketSize()`
`String[]` `getJNDIBindings()` Returns the JNDI bindings associated to this connection factory.
`long` `getMaxRetryInterval()`
`int` `getMinLargeMessageSize()`
`String` `getName()` Returns the configuration name of this connection factory.
`int` `getProducerMaxRate()`
`int` `getProducerWindowSize()`
`int` `getReconnectAttempts()`
`long` `getRetryInterval()`
`double` `getRetryIntervalMultiplier()`
`int` `getScheduledThreadPoolMaxSize()`
`TransportConfiguration[]` `getStaticConnectors()`
`int` `getThreadPoolMaxSize()`
`int` `getTransactionBatchSize()` Returns the batch size (in bytes) between acknowledgements when using a transacted session.
`boolean` `isAutoGroup()`
`boolean` `isBlockOnAcknowledge()`
`boolean` `isBlockOnDurableSend()`
`boolean` `isBlockOnNonDurableSend()`
`boolean` `isCacheLargeMessagesClient()`
`boolean` `isCompressLargeMessages()`
`boolean` `isFailoverOnInitialConnection()`
`boolean` `isHA()` does ths cf support HA
`boolean` `isPreAcknowledge()`
`boolean` `isUseGlobalPools()`
`void` `removeJNDI(String jndi)` Remove a JNDI binding
`void` `setAutoGroup(boolean autoGroup)`
`void` `setBlockOnAcknowledge(boolean blockOnAcknowledge)`
`void` `setBlockOnDurableSend(boolean blockOnDurableSend)`
`void` `setBlockOnNonDurableSend(boolean blockOnNonDurableSend)`
`void` `setCacheLargeMessagesClient(boolean cacheLargeMessagesClient)`
`void` `setCallTimeout(long callTimeout)`
`void` `setClientFailureCheckPeriod(long clientFailureCheckPeriod)`
`void` `setClientID(String clientID)` Sets the Client ID for this connection factory.
`void` `setCompressLargeMessages(boolean compress)`
`void` `setConfirmationWindowSize(int confirmationWindowSize)`
`void` `setConnectionLoadBalancingPolicyClassName(String connectionLoadBalancingPolicyClassName)`
`void` `setConnectionTTL(long connectionTTL)`
`void` `setConsumerMaxRate(int consumerMaxRate)`
`void` `setConsumerWindowSize(int consumerWindowSize)`
`void` `setDupsOKBatchSize(int dupsOKBatchSize)`
`void` `setFailoverOnInitialConnection(boolean failoverOnInitialConnection)`
`void` `setGroupID(String groupID)`
`void` `setMaxRetryInterval(long retryInterval)`
`void` `setMinLargeMessageSize(int minLargeMessageSize)`
`void` `setPreAcknowledge(boolean preAcknowledge)`
`void` `setProducerMaxRate(int producerMaxRate)`
`void` `setProducerWindowSize(int producerWindowSize)`
`void` `setReconnectAttempts(int reconnectAttempts)`
`void` `setRetryInterval(long retryInterval)`
`void` `setRetryIntervalMultiplier(double retryIntervalMultiplier)`
`void` `setScheduledThreadPoolMaxSize(int scheduledThreadPoolMaxSize)`
`void` `setThreadPoolMaxSize(int threadPoolMaxSize)`
`void` `setTransactionBatchSize(int transactionBatchSize)`
`void` `setUseGlobalPools(boolean useGlobalPools)`

Method Detail

### getName

    String getName()

  Returns the configuration name of this connection factory.

### getJNDIBindings

    String[] getJNDIBindings()

  Returns the JNDI bindings associated to this connection factory.

### isHA

    boolean isHA()

  does ths cf support HA

  Returns:
    true if it supports HA

### getFactoryType

    int getFactoryType()

  return the type of factory

  Returns:
    0 = jms cf, 1 = queue cf, 2 = topic cf, 3 = xa cf, 4 = xa queue cf, 5 = xa topic cf

### getClientID

    String getClientID()

  Returns the Client ID of this connection factory (or `null` if it is not set.

### setClientID

    void setClientID(String clientID)

  Sets the Client ID for this connection factory.

### isCompressLargeMessages

    boolean isCompressLargeMessages()

### setCompressLargeMessages

    void setCompressLargeMessages(boolean compress)

### getClientFailureCheckPeriod

    long getClientFailureCheckPeriod()

  See Also:
    `ClientSessionFactory#getClientFailureCheckPeriod()`

### setClientFailureCheckPeriod

    void setClientFailureCheckPeriod(long clientFailureCheckPeriod)

  See Also:
    `ClientSessionFactory#setClientFailureCheckPeriod`

### getCallTimeout

    long getCallTimeout()

  See Also:
    `ClientSessionFactory#getCallTimeout()`

### setCallTimeout

    void setCallTimeout(long callTimeout)

  See Also:
    `ClientSessionFactory#setCallTimeout(long)`

### getDupsOKBatchSize

    int getDupsOKBatchSize()

  Returns the batch size (in bytes) between acknowledgements when using DUPS_OK_ACKNOWLEDGE mode.

  See Also:
    `ClientSessionFactory#getAckBatchSize()`, `Session.DUPS_OK_ACKNOWLEDGE`

### setDupsOKBatchSize

    void setDupsOKBatchSize(int dupsOKBatchSize)

  See Also:
    `ClientSessionFactory#setAckBatchSize(int)`

### getConsumerMaxRate

    int getConsumerMaxRate()

  See Also:
    `ClientSessionFactory#getConsumerMaxRate()`

### setConsumerMaxRate

    void setConsumerMaxRate(int consumerMaxRate)

  See Also:
    `ClientSessionFactory#setConsumerMaxRate(int)`

### getConsumerWindowSize

    int getConsumerWindowSize()

  See Also:
    `ClientSessionFactory#getConsumerWindowSize()`

### setConsumerWindowSize

    void setConsumerWindowSize(int consumerWindowSize)

  See Also:
    `ClientSessionFactory#setConfirmationWindowSize(int)`

### getProducerMaxRate

    int getProducerMaxRate()

  See Also:
    `ClientSessionFactory#getProducerMaxRate()`

### setProducerMaxRate

    void setProducerMaxRate(int producerMaxRate)

  See Also:
    `ClientSessionFactory#setProducerMaxRate(int)`

### getConfirmationWindowSize

    int getConfirmationWindowSize()

  See Also:
    `ClientSessionFactory#getConfirmationWindowSize()`

### setConfirmationWindowSize

    void setConfirmationWindowSize(int confirmationWindowSize)

  See Also:
    `ClientSessionFactory#setConfirmationWindowSize(int)`

### isBlockOnAcknowledge

    boolean isBlockOnAcknowledge()

  See Also:
    `ClientSessionFactory#isBlockOnAcknowledge()`

### setBlockOnAcknowledge

    void setBlockOnAcknowledge(boolean blockOnAcknowledge)

  See Also:
    `ClientSessionFactory#setBlockOnAcknowledge(boolean)`

### isBlockOnDurableSend

    boolean isBlockOnDurableSend()

  See Also:
    `ClientSessionFactory#isBlockOnDurableSend()`

### setBlockOnDurableSend

    void setBlockOnDurableSend(boolean blockOnDurableSend)

  See Also:
    `ClientSessionFactory#setBlockOnDurableSend(boolean)`

### isBlockOnNonDurableSend

    boolean isBlockOnNonDurableSend()

  See Also:
    `ClientSessionFactory#isBlockOnNonDurableSend()`

### setBlockOnNonDurableSend

    void setBlockOnNonDurableSend(boolean blockOnNonDurableSend)

  See Also:
    `ClientSessionFactory#setBlockOnNonDurableSend(boolean)`

### isPreAcknowledge

    boolean isPreAcknowledge()

  See Also:
    `ClientSessionFactory#isPreAcknowledge()`

### setPreAcknowledge

    void setPreAcknowledge(boolean preAcknowledge)

  See Also:
    `ClientSessionFactory#setPreAcknowledge(boolean)`

### getConnectionTTL

    long getConnectionTTL()

  See Also:
    `ClientSessionFactory#getConnectionTTL()`

### setConnectionTTL

    void setConnectionTTL(long connectionTTL)

  See Also:
    `ClientSessionFactory#setConnectionTTL(long)`

### getTransactionBatchSize

    int getTransactionBatchSize()

  Returns the batch size (in bytes) between acknowledgements when using a transacted session.

  See Also:
    `ClientSessionFactory#getAckBatchSize()`

### setTransactionBatchSize

    void setTransactionBatchSize(int transactionBatchSize)

  See Also:
    `ClientSessionFactory#setAckBatchSize(int)`

### getMinLargeMessageSize

    int getMinLargeMessageSize()

  See Also:
    `ClientSessionFactory#getMinLargeMessageSize()`

### setMinLargeMessageSize

    void setMinLargeMessageSize(int minLargeMessageSize)

  See Also:
    `ClientSessionFactory#setMinLargeMessageSize(int)`

### isAutoGroup

    boolean isAutoGroup()

  See Also:
    `ClientSessionFactory#isAutoGroup()`

### setAutoGroup

    void setAutoGroup(boolean autoGroup)

  See Also:
    `ClientSessionFactory#setAutoGroup(boolean)`

### getRetryInterval

    long getRetryInterval()

  See Also:
    `ClientSessionFactory#getRetryInterval()`

### setRetryInterval

    void setRetryInterval(long retryInterval)

  See Also:
    `ClientSessionFactory#setRetryInterval(long)`

### getRetryIntervalMultiplier

    double getRetryIntervalMultiplier()

  See Also:
    `ClientSessionFactory#getRetryIntervalMultiplier()`

### setRetryIntervalMultiplier

    void setRetryIntervalMultiplier(double retryIntervalMultiplier)

  See Also:
    `ClientSessionFactory#setRetryIntervalMultiplier(double)`

### getReconnectAttempts

    int getReconnectAttempts()

  See Also:
    `ClientSessionFactory#getReconnectAttempts()`

### setReconnectAttempts

    void setReconnectAttempts(int reconnectAttempts)

  See Also:
    `ClientSessionFactory#setReconnectAttempts(int)`

### isFailoverOnInitialConnection

    boolean isFailoverOnInitialConnection()

  See Also:
    `ClientSessionFactory#isFailoverOnInitialConnection()`

### setFailoverOnInitialConnection

    void setFailoverOnInitialConnection(boolean failoverOnInitialConnection)

  See Also:
    `ClientSessionFactory#setFailoverOnInitialConnection(boolean)`

### getProducerWindowSize

    int getProducerWindowSize()

  See Also:
    `org.hornetq.api.core.client.ClientSessionFactory#getProducerWindowSize()`

### setProducerWindowSize

    void setProducerWindowSize(int producerWindowSize)

  See Also:
    `ClientSessionFactory#setProducerWindowSize(int)`

### isCacheLargeMessagesClient

    boolean isCacheLargeMessagesClient()

  See Also:
    `ClientSessionFactory#isCacheLargeMessagesClient()`

### setCacheLargeMessagesClient

    void setCacheLargeMessagesClient(boolean cacheLargeMessagesClient)

  See Also:
    `ClientSessionFactory#setCacheLargeMessagesClient(boolean)`

### getMaxRetryInterval

    long getMaxRetryInterval()

  See Also:
    `ClientSessionFactory#getMaxRetryInterval()`

### setMaxRetryInterval

    void setMaxRetryInterval(long retryInterval)

  See Also:
    `ClientSessionFactory#setMaxRetryInterval(long)`

### getScheduledThreadPoolMaxSize

    int getScheduledThreadPoolMaxSize()

  See Also:
    `ClientSessionFactory#getScheduledThreadPoolMaxSize()`

### setScheduledThreadPoolMaxSize

    void setScheduledThreadPoolMaxSize(int scheduledThreadPoolMaxSize)

  See Also:
    `ClientSessionFactory#setScheduledThreadPoolMaxSize(int)`

### getThreadPoolMaxSize

    int getThreadPoolMaxSize()

  See Also:
    `ClientSessionFactory#getThreadPoolMaxSize()`

### setThreadPoolMaxSize

    void setThreadPoolMaxSize(int threadPoolMaxSize)

  See Also:
    `ClientSessionFactory#setThreadPoolMaxSize(int)`

### getGroupID

    String getGroupID()

  See Also:
    `ClientSessionFactory#getGroupID()`

### setGroupID

    void setGroupID(String groupID)

  See Also:
    `ClientSessionFactory#setGroupID(String)`

### getInitialMessagePacketSize

    int getInitialMessagePacketSize()

  See Also:
    `ClientSessionFactory#getInitialMessagePacketSize()`

### isUseGlobalPools

    boolean isUseGlobalPools()

  See Also:
    `ClientSessionFactory#isUseGlobalPools()`

### setUseGlobalPools

    void setUseGlobalPools(boolean useGlobalPools)

  See Also:
    `ClientSessionFactory#setUseGlobalPools(boolean)`

### getConnectionLoadBalancingPolicyClassName

    String getConnectionLoadBalancingPolicyClassName()

  See Also:
    `ClientSessionFactory#getConnectionLoadBalancingPolicyClassName()`

### setConnectionLoadBalancingPolicyClassName

    void setConnectionLoadBalancingPolicyClassName(String connectionLoadBalancingPolicyClassName)

  See Also:
    `ClientSessionFactory#setConnectionLoadBalancingPolicyClassName(String)`

### getStaticConnectors

    TransportConfiguration[] getStaticConnectors()

  See Also:
    `ClientSessionFactory#getStaticConnectors()`

### getDiscoveryGroupConfiguration

    DiscoveryGroupConfiguration getDiscoveryGroupConfiguration()

  get the discovery group configuration

### addJNDI

    void addJNDI(String jndi)
                 throws Exception

  Add the JNDI binding to this destination

  Throws:
    `Exception`

### removeJNDI

    void removeJNDI(String jndi)
                    throws Exception

  Remove a JNDI binding

  Throws:
    `Exception`

Copyright © 2009 Red Hat Inc. All Rights Reserved.