AtomikosConnectionFactoryBean (Transactions JMS 6.0.0 API)

java.lang.Object
- com.atomikos.jms.AtomikosConnectionFactoryBean

All Implemented Interfaces:: ConnectionPoolProperties, com.atomikos.icatch.OrderedLifecycleComponent, Serializable, javax.jms.ConnectionFactory, Referenceable

public class AtomikosConnectionFactoryBean
extends Object
implements javax.jms.ConnectionFactory, ConnectionPoolProperties, Referenceable, Serializable, com.atomikos.icatch.OrderedLifecycleComponent

This class represents the Atomikos JMS 2.0 connection factory for JTA-enabled JMS. Use an instance of this class to make JMS participate in JTA transactions without having to issue the low-level XA calls yourself. The following use cases are supported, depending on the value you set for the sessionCreationMode property:

SessionCreationMode.JMS_2_0 (the default as of release 6.0)

existing JTA transaction for thread	localTransactionMode	resulting session
true	ignored	XA session
false	false	XA session
false	true	non-XA session according to sessionTransacted/acknowledgeMode parameters

SessionCreationMode.PRE_6_0 (optional, for backward compatibility)

localTransactionMode	sessionTransactedFlag	resulting session
false	ignored	XA session
true	ignored	non-XA session according to sessionTransacted/acknowledgeMode parameters

SessionCreationMode.PRE_3_9 (optional, for backward compatibility and equivalent to ignoreSessionTransactedFlag = false)

localTransactionMode	sessionTransactedFlag	resulting session
false	true	XA session
other	other	non-XA session according to sessionTransacted/acknowledgeMode parameters

IMPORTANT: for XA sessions, commit/rollback coincide with the JTA transaction outcome and this is the safest way of working. For non-XA sessions, commit/rollback are to be managed by your code - at the risk of message loss or duplicate messages. For details see http://www.atomikos.com/Publications/ReliableJmsWithTransactions.

See Also:: Serialized Form

Field Summary
- Fields inherited from interface com.atomikos.datasource.pool.ConnectionPoolProperties
  DEFAULT_BORROW_CONNECTION_TIMEOUT, DEFAULT_ISOLATION_LEVEL_UNSET, DEFAULT_MAINTENANCE_INTERVAL, DEFAULT_MAX_IDLE_TIME, DEFAULT_MAX_LIFETIME, DEFAULT_POOL_SIZE

Constructor Summary

Constructors
Constructor and Description

AtomikosConnectionFactoryBean()

Constructors
Constructor and Description
`AtomikosConnectionFactoryBean()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the instance.
`javax.jms.Connection`	`createConnection()`
`javax.jms.Connection`	`createConnection(String user, String password)`
`javax.jms.JMSContext`	`createContext()`
`javax.jms.JMSContext`	`createContext(int sessionMode)`
`javax.jms.JMSContext`	`createContext(String userName, String password)`
`javax.jms.JMSContext`	`createContext(String userName, String password, int sessionMode)`
`int`	`getBorrowConnectionTimeout()` Gets the timeout for borrowing connections from the pool.
`boolean`	`getConcurrentConnectionValidation()`
`int`	`getDefaultIsolationLevel()`
`boolean`	`getIgnoreSessionTransactedFlag()`
`boolean`	`getLocalTransactionMode()` Gets the local transaction mode.
`int`	`getMaintenanceInterval()` Gets the pool maintenance interval.
`int`	`getMaxIdleTime()` Gets the max idle time for connections in the pool.
`int`	`getMaxLifetime()` Gets the maximum lifetime in seconds.
`int`	`getMaxPoolSize()` Gets the max size of the pool.
`int`	`getMinPoolSize()` Gets the min size of the pool.
`Reference`	`getReference()`
`int`	`getSessionCreationMode()`
`String`	`getTestQuery()` Gets a test query, currently defaults to null (not applicable to JMS).
`String`	`getUniqueResourceName()` Gets the unique name for this resource.
`javax.jms.XAConnectionFactory`	`getXaConnectionFactory()` Gets the configured XAConnectionFactory.
`String`	`getXaConnectionFactoryClassName()` Gets the name of the vendor-specific XAConnectionFactory class implementation.
`Properties`	`getXaProperties()` Gets the vendor-specific XA properties to set.
`void`	`init()` Initializes the instance.
`int`	`poolAvailableSize()`
`int`	`poolTotalSize()`
`void`	`refreshPool()`
`void`	`setBorrowConnectionTimeout(int timeout)` Sets the max timeout that connection requests should wait when no connection is available in the pool.
`void`	`setConcurrentConnectionValidation(boolean value)` Sets whether or not to use concurrent connection validation.
`void`	`setIgnoreSessionTransactedFlag(boolean value)` Deprecated. Kept for pre-3.9 configurations only. Otherwise, use the sessionCreationMode instead.
`void`	`setLocalTransactionMode(boolean mode)` Sets whether or not local transactions are desired.
`void`	`setMaintenanceInterval(int interval)` Sets the pool maintenance interval, i.e.
`void`	`setMaxIdleTime(int time)` Sets the max idle time after which connections are cleaned up from the pool.
`void`	`setMaxLifetime(int maxLifetime)` Sets the maximum amount of seconds that a connection is kept in the pool before it is destroyed automatically.
`void`	`setMaxPoolSize(int maxPoolSize)` Sets the max size that the pool can reach.
`void`	`setMinPoolSize(int minPoolSize)` Sets the min size of the pool.
`void`	`setPoolSize(int minAndMaxSize)` Sets both the min and max size of the pool.
`void`	`setSessionCreationMode(int mode)` Sets the creation mode for sessions.
`void`	`setUniqueResourceName(String resourceName)` Sets the unique resource name for this resource, needed for recovery of transactions after restart.
`void`	`setXaConnectionFactory(javax.jms.XAConnectionFactory xaConnectionFactory)` Sets the XAConnectionFactory directly, instead of calling setXaConnectionFactoryClassName and setXaProperties.
`void`	`setXaConnectionFactoryClassName(String xaConnectionFactoryClassName)` Sets the fully qualified name of a vendor-specific implementation of XAConnectionFatory.
`void`	`setXaProperties(Properties xaProperties)` Sets the vendor-specific XA properties.
`String`	`toString()`

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

Methods inherited from interface com.atomikos.datasource.pool.ConnectionPoolProperties
getIgnoreJtaTransactions

- Constructor Detail
  - AtomikosConnectionFactoryBean
```
public AtomikosConnectionFactoryBean()
```
- Method Detail
  - getMaxPoolSize
```
public int getMaxPoolSize()
```
    Gets the max size of the pool.
    
    Specified by:
    
    getMaxPoolSize in interface ConnectionPoolProperties
    
    Returns:
    
    int The max size of the pool.
  - setMaxPoolSize
```
public void setMaxPoolSize(int maxPoolSize)
```
    Sets the max size that the pool can reach. Optional, defaults to 1.
    
    Parameters:
    
    maxPoolSize -
  - getMinPoolSize
```
public int getMinPoolSize()
```
    Gets the min size of the pool.
    
    Specified by:
    
    getMinPoolSize in interface ConnectionPoolProperties
    
    Returns:
    
    The min size.
  - setMinPoolSize
```
public void setMinPoolSize(int minPoolSize)
```
    Sets the min size of the pool. Optional, defaults to 1.
    
    Parameters:
    
    minPoolSize -
  - setPoolSize
```
public void setPoolSize(int minAndMaxSize)
```
    Sets both the min and max size of the pool. Optional. Overrides any minPoolSize or maxPoolSize that you might have set before!
    
    Parameters:
    
    minAndMaxSize -
  - getUniqueResourceName
```
public String getUniqueResourceName()
```
    Gets the unique name for this resource.
    
    Specified by:
    
    getUniqueResourceName in interface ConnectionPoolProperties
    
    Returns:
    
    The name.
  - setUniqueResourceName
```
public void setUniqueResourceName(String resourceName)
```
    Sets the unique resource name for this resource, needed for recovery of transactions after restart. Required.
    
    Parameters:
    
    resourceName -
  - getXaConnectionFactoryClassName
```
public String getXaConnectionFactoryClassName()
```
    Gets the name of the vendor-specific XAConnectionFactory class implementation.
    
    Returns:
    
    The name of the vendor class.
  - setXaConnectionFactoryClassName
```
public void setXaConnectionFactoryClassName(String xaConnectionFactoryClassName)
```
    Sets the fully qualified name of a vendor-specific implementation of XAConnectionFatory. Required, unless you call setXaConnectionFactory.
    
    Parameters:
    
    xaConnectionFactoryClassName -
    
    See Also:
    
    XAConnectionFactory
  - getXaProperties
```
public Properties getXaProperties()
```
    Gets the vendor-specific XA properties to set.
    
    Returns:
    
    The properties as key,value pairs.
  - setXaProperties
```
public void setXaProperties(Properties xaProperties)
```
    Sets the vendor-specific XA properties. Required, unless you call setXaConnectionFactory.
    
    Parameters:
    
    xaProperties - The properties, to be set (during initialization) on the specified XAConnectionFactory implementation.
  - getXaConnectionFactory
```
public javax.jms.XAConnectionFactory getXaConnectionFactory()
```
    Gets the configured XAConnectionFactory.
    
    Returns:
    
    The factory, or null if not yet configured.
  - setXaConnectionFactory
```
public void setXaConnectionFactory(javax.jms.XAConnectionFactory xaConnectionFactory)
```
    Sets the XAConnectionFactory directly, instead of calling setXaConnectionFactoryClassName and setXaProperties.
    
    Parameters:
    
    xaConnectionFactory -
  - setMaxLifetime
```
public void setMaxLifetime(int maxLifetime)
```
    Sets the maximum amount of seconds that a connection is kept in the pool before it is destroyed automatically. Optional, defaults to 0 (no limit).
    
    Parameters:
    
    maxLifetime -
  - getMaxLifetime
```
public int getMaxLifetime()
```
    Gets the maximum lifetime in seconds.
    
    Specified by:
    
    getMaxLifetime in interface ConnectionPoolProperties
  - init
```
public void init()
          throws javax.jms.JMSException
```
    Initializes the instance. It is highly recommended that this method be called early after VM startup, to ensure that recovery can start as soon as possible.
    
    Specified by:
    
    init in interface com.atomikos.icatch.OrderedLifecycleComponent
    
    Throws:
    
    javax.jms.JMSException
  - getBorrowConnectionTimeout
```
public int getBorrowConnectionTimeout()
```
    Gets the timeout for borrowing connections from the pool.
    
    Specified by:
    
    getBorrowConnectionTimeout in interface ConnectionPoolProperties
    
    Returns:
    
    int The timeout in seconds, during which connection requests should wait when no connection is available.
  - getMaintenanceInterval
```
public int getMaintenanceInterval()
```
    Gets the pool maintenance interval.
    
    Specified by:
    
    getMaintenanceInterval in interface ConnectionPoolProperties
    
    Returns:
    
    int The interval in seconds.
  - getMaxIdleTime
```
public int getMaxIdleTime()
```
    Gets the max idle time for connections in the pool.
    
    Specified by:
    
    getMaxIdleTime in interface ConnectionPoolProperties
    
    Returns:
    
    int The max time in seconds.
  - getTestQuery
```
public String getTestQuery()
```
    Gets a test query, currently defaults to null (not applicable to JMS).
    
    Specified by:
    
    getTestQuery in interface ConnectionPoolProperties
  - setBorrowConnectionTimeout
```
public void setBorrowConnectionTimeout(int timeout)
```
    Sets the max timeout that connection requests should wait when no connection is available in the pool. Optional, defaults to 30 seconds.
    
    Parameters:
    
    timeout - The timeout in seconds.
  - setMaintenanceInterval
```
public void setMaintenanceInterval(int interval)
```
    Sets the pool maintenance interval, i.e. the time (in seconds) between consecutive runs of the maintenance thread. Optional, defaults to 60 seconds.
    
    Parameters:
    
    interval -
  - setMaxIdleTime
```
public void setMaxIdleTime(int time)
```
    Sets the max idle time after which connections are cleaned up from the pool. Optional, defaults to 60 seconds.
    
    Parameters:
    
    time -
  - getLocalTransactionMode
```
public boolean getLocalTransactionMode()
```
    Gets the local transaction mode.
    
    Specified by:
    
    getLocalTransactionMode in interface ConnectionPoolProperties
    
    Returns:
    
    boolean If true, then transactions are not done in XA mode but in local mode.
  - setLocalTransactionMode
```
public void setLocalTransactionMode(boolean mode)
```
    Sets whether or not local transactions are desired. With local transactions, no XA enlist will be done - rather, the application should perform session-level JMS commit or rollback, or use explicit acknowledgement modes. Note that this feature also requires support from your JMS vendor. Optional, defaults to false.
    
    Parameters:
    
    mode -
  - getDefaultIsolationLevel
```
public int getDefaultIsolationLevel()
```
    Specified by:
    
    getDefaultIsolationLevel in interface ConnectionPoolProperties
  - close
```
public void close()
```
    Closes the instance. This method should be called when you are done using the factory.
    
    Specified by:
    
    close in interface com.atomikos.icatch.OrderedLifecycleComponent
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - createConnection
```
public javax.jms.Connection createConnection()
                                      throws javax.jms.JMSException
```
    Specified by:
    
    createConnection in interface javax.jms.ConnectionFactory
    
    Throws:
    
    javax.jms.JMSException
    
    See Also:
    
    ConnectionFactory
  - createConnection
```
public javax.jms.Connection createConnection(String user,
                                             String password)
                                      throws javax.jms.JMSException
```
    Specified by:
    
    createConnection in interface javax.jms.ConnectionFactory
    
    Throws:
    
    javax.jms.JMSException
    
    See Also:
    
    ConnectionFactory
  - getReference
```
public Reference getReference()
                       throws NamingException
```
    Specified by:
    
    getReference in interface Referenceable
    
    Throws:
    
    NamingException
    
    See Also:
    
    Referenceable
  - poolAvailableSize
```
public int poolAvailableSize()
```
  - poolTotalSize
```
public int poolTotalSize()
```
  - refreshPool
```
public void refreshPool()
```
  - getIgnoreSessionTransactedFlag
```
public boolean getIgnoreSessionTransactedFlag()
```
  - setIgnoreSessionTransactedFlag
```
@Deprecated
public void setIgnoreSessionTransactedFlag(boolean value)
```
    Deprecated. Kept for pre-3.9 configurations only. Otherwise, use the sessionCreationMode instead.
    
    Sets whether or not to ignore the sessionTransacted flag when creating JMS Sessions. If false then you will only get XA-capable JMS Session objects if the sessionTransacted flag is set upon session creation. Set this to false to get the pre-3.9 behavior of Atomikos. This setting is ignored for localTransactionMode: in localTransactionMode you never get XA-capable Session objects.
    
    Parameters:
    
    value -
  - setConcurrentConnectionValidation
```
public void setConcurrentConnectionValidation(boolean value)
```
    Sets whether or not to use concurrent connection validation. Optional, defaults to true.
    
    Parameters:
    
    value -
  - getConcurrentConnectionValidation
```
public boolean getConcurrentConnectionValidation()
```
  - createContext
```
public javax.jms.JMSContext createContext()
```
    Specified by:
    
    createContext in interface javax.jms.ConnectionFactory
  - createContext
```
public javax.jms.JMSContext createContext(String userName,
                                          String password)
```
    Specified by:
    
    createContext in interface javax.jms.ConnectionFactory
  - createContext
```
public javax.jms.JMSContext createContext(String userName,
                                          String password,
                                          int sessionMode)
```
    Specified by:
    
    createContext in interface javax.jms.ConnectionFactory
  - createContext
```
public javax.jms.JMSContext createContext(int sessionMode)
```
    Specified by:
    
    createContext in interface javax.jms.ConnectionFactory
  - getSessionCreationMode
```
public int getSessionCreationMode()
```
    Returns:
    
    The SessionCreationMode
  - setSessionCreationMode
```
public void setSessionCreationMode(int mode)
```
    Sets the creation mode for sessions. Optional, defaults to SessionCreationMode.JMS_2_0.
    
    Parameters:
    
    mode -

Class AtomikosConnectionFactoryBean

Field Summary

Fields inherited from interface com.atomikos.datasource.pool.ConnectionPoolProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.atomikos.datasource.pool.ConnectionPoolProperties

Constructor Detail

AtomikosConnectionFactoryBean

Method Detail

getMaxPoolSize

setMaxPoolSize

getMinPoolSize

setMinPoolSize

setPoolSize

getUniqueResourceName

setUniqueResourceName

getXaConnectionFactoryClassName

setXaConnectionFactoryClassName

getXaProperties

setXaProperties

getXaConnectionFactory

setXaConnectionFactory

setMaxLifetime

getMaxLifetime

init

getBorrowConnectionTimeout

getMaintenanceInterval

getMaxIdleTime

getTestQuery

setBorrowConnectionTimeout

setMaintenanceInterval

setMaxIdleTime

getLocalTransactionMode

setLocalTransactionMode

getDefaultIsolationLevel

close

toString

createConnection

createConnection

getReference

poolAvailableSize

poolTotalSize

refreshPool

getIgnoreSessionTransactedFlag

setIgnoreSessionTransactedFlag

setConcurrentConnectionValidation

getConcurrentConnectionValidation

createContext

createContext

createContext

createContext

getSessionCreationMode

setSessionCreationMode