ClientSession (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

All Superinterfaces:

AutoCloseable, XAResource

All Known Subinterfaces:

ClientSessionInternal

All Known Implementing Classes:

ClientSessionImpl
```
public interface ClientSession
extends XAResource, AutoCloseable
```
A ClientSession is a single-thread object required for producing and consuming messages.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`ClientSession.AddressQuery` Information returned by a binding query
`static interface`	`ClientSession.QueueQuery` Information returned by a queue query

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JMS_SESSION_IDENTIFIER_PROPERTY` This is used to identify a ClientSession as used by the JMS Layer The JMS Layer will add this through Meta-data, so the server or management layers can identify session created over core API purely or through the JMS Layer

Fields inherited from interface javax.transaction.xa.XAResource
TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addFailoverListener(FailoverEventListener listener)` Adds a FailoverEventListener to the session which is notified if a failover event occurs on the session.
`void`	`addFailureListener(SessionFailureListener listener)` Adds a FailureListener to the session which is notified if a failure occurs on the session.
`void`	`addMetaData(String key, String data)` Attach any metadata to the session.
`ClientSession.AddressQuery`	`addressQuery(SimpleString address)` Queries information on a binding.
`void`	`addUniqueMetaData(String key, String data)` Attach any metadata to the session.
`void`	`close()` Closes the session.
`void`	`commit()` Commits the current transaction, blocking.
`void`	`commit(boolean block)` Commits the current transaction.
`void`	`createAddress(SimpleString address, EnumSet<RoutingType> routingTypes, boolean autoCreated)` Create Address with a single initial routing type
`void`	`createAddress(SimpleString address, RoutingType routingType, boolean autoCreated)` Create Address with a single initial routing type
`void`	`createAddress(SimpleString address, Set<RoutingType> routingTypes, boolean autoCreated)` Deprecated.
`ClientConsumer`	`createConsumer(SimpleString queueName)` Creates a ClientConsumer to consume message from the queue with the given name.
`ClientConsumer`	`createConsumer(SimpleString queueName, boolean browseOnly)` Creates a ClientConsumer to consume or browse messages from the queue with the given name.
`ClientConsumer`	`createConsumer(SimpleString queueName, SimpleString filter)` Creates a ClientConsumer to consume messages matching the filter from the queue with the given name.
`ClientConsumer`	`createConsumer(SimpleString queueName, SimpleString filter, boolean browseOnly)` Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
`ClientConsumer`	`createConsumer(SimpleString queueName, SimpleString filter, int priority, boolean browseOnly)` Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
`ClientConsumer`	`createConsumer(SimpleString queueName, SimpleString filter, int windowSize, int maxRate, boolean browseOnly)` Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
`ClientConsumer`	`createConsumer(SimpleString queueName, SimpleString filter, int priority, int windowSize, int maxRate, boolean browseOnly)` Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
`ClientConsumer`	`createConsumer(String queueName)` Creates a ClientConsumer to consume messages from the queue with the given name.
`ClientConsumer`	`createConsumer(String queueName, boolean browseOnly)` Creates a ClientConsumer to consume or browse messages from the queue with the given name.
`ClientConsumer`	`createConsumer(String queueName, String filter)` Creates a ClientConsumer to consume messages matching the filter from the queue with the given name.
`ClientConsumer`	`createConsumer(String queueName, String filter, boolean browseOnly)` Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
`ClientConsumer`	`createConsumer(String queueName, String filter, int windowSize, int maxRate, boolean browseOnly)` Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
`ClientMessage`	`createMessage(boolean durable)` Creates a ClientMessage.
`ClientMessage`	`createMessage(byte type, boolean durable)` Creates a ClientMessage.
`ClientMessage`	`createMessage(byte type, boolean durable, long expiration, long timestamp, byte priority)` Creates a ClientMessage.
`ClientProducer`	`createProducer()` Creates a producer with no default address.
`ClientProducer`	`createProducer(SimpleString address)` Creates a producer which sends messages to the given address
`ClientProducer`	`createProducer(SimpleString address, int rate)` Creates a producer which sends messages to the given address
`ClientProducer`	`createProducer(String address)` Creates a producer which sends messages to the given address
`void`	`createQueue(QueueConfiguration queueConfiguration)` This method creates a queue based on the `QueueConfiguration` input.
`void`	`createQueue(SimpleString address, RoutingType routingType, SimpleString queueName)` Deprecated.
`void`	`createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, boolean durable)` Deprecated.
`void`	`createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable)` Deprecated.
`void`	`createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable, boolean autoCreated)` Deprecated.
`void`	`createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable, boolean autoCreated, int maxConsumers, boolean purgeOnNoConsumers)` Deprecated.
`void`	`createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable, boolean autoCreated, int maxConsumers, boolean purgeOnNoConsumers, Boolean exclusive, Boolean lastValue)` Deprecated.
`void`	`createQueue(SimpleString address, SimpleString queueName)` Deprecated.
`void`	`createQueue(SimpleString address, SimpleString queueName, boolean durable)` Deprecated.
`void`	`createQueue(SimpleString address, SimpleString queueName, boolean autoCreated, QueueAttributes queueAttributes)` Deprecated.
`void`	`createQueue(SimpleString address, SimpleString queueName, SimpleString filter, boolean durable)` Deprecated.
`void`	`createQueue(SimpleString address, SimpleString queueName, SimpleString filter, boolean durable, boolean autoCreated)` Deprecated.
`void`	`createQueue(String address, RoutingType routingType, String queueName)` Deprecated.
`void`	`createQueue(String address, RoutingType routingType, String queueName, boolean durable)` Deprecated.
`void`	`createQueue(String address, RoutingType routingType, String queueName, String filter, boolean durable)` Deprecated.
`void`	`createQueue(String address, RoutingType routingType, String queueName, String filter, boolean durable, boolean autoCreated)` Deprecated.
`void`	`createQueue(String address, RoutingType routingType, String queueName, String filter, boolean durable, boolean autoCreated, int maxConsumers, boolean purgeOnNoConsumers)` Deprecated.
`void`	`createQueue(String address, RoutingType routingType, String queueName, String filter, boolean durable, boolean autoCreated, int maxConsumers, boolean purgeOnNoConsumers, Boolean exclusive, Boolean lastValue)` Deprecated.
`void`	`createQueue(String address, String queueName)` Deprecated.
`void`	`createQueue(String address, String queueName, boolean durable)` Deprecated.
`void`	`createQueue(String address, String queueName, String filter, boolean durable)` Deprecated.
`void`	`createQueue(String address, String queueName, String filter, boolean durable, boolean autoCreated)` Deprecated.
`void`	`createSharedQueue(QueueConfiguration queueConfiguration)` This method is essentially the same as `createQueue(QueueConfiguration)` with a few key exceptions.
`void`	`createSharedQueue(SimpleString address, RoutingType routingType, SimpleString queueName, boolean durable)` Deprecated.
`void`	`createSharedQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable)` Deprecated.
`void`	`createSharedQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, boolean durable, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean lastValue)` Deprecated.
`void`	`createSharedQueue(SimpleString address, SimpleString queueName, boolean durable)` Deprecated.
`void`	`createSharedQueue(SimpleString address, SimpleString queueName, QueueAttributes queueAttributes)` Deprecated.
`void`	`createSharedQueue(SimpleString address, SimpleString queueName, SimpleString filter, boolean durable)` Deprecated.
`void`	`createTemporaryQueue(SimpleString address, RoutingType routingType, SimpleString queueName)` Deprecated.
`void`	`createTemporaryQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter)` Deprecated.
`void`	`createTemporaryQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filter, int maxConsumers, boolean purgeOnNoConsumers, Boolean exclusive, Boolean lastValue)` Deprecated.
`void`	`createTemporaryQueue(SimpleString address, SimpleString queueName)` Deprecated.
`void`	`createTemporaryQueue(SimpleString address, SimpleString queueName, QueueAttributes queueAttributes)` Deprecated.
`void`	`createTemporaryQueue(SimpleString address, SimpleString queueName, SimpleString filter)` Deprecated.
`void`	`createTemporaryQueue(String address, RoutingType routingType, String queueName)` Deprecated.
`void`	`createTemporaryQueue(String address, RoutingType routingType, String queueName, String filter)` Deprecated.
`void`	`createTemporaryQueue(String address, String queueName)` Deprecated.
`void`	`createTemporaryQueue(String address, String queueName, String filter)` Deprecated.
`void`	`deleteQueue(SimpleString queueName)` Deletes the queue.
`void`	`deleteQueue(String queueName)` Deletes the queue.
`ClientSessionFactory`	`getSessionFactory()` Return the sessionFactory used to created this Session.
`int`	`getVersion()` Returns the server's incrementingVersion.
`XAResource`	`getXAResource()` Returns the XAResource associated to the session.
`boolean`	`isAutoCommitAcks()` Returns whether the session will automatically commit its transaction every time a message is acknowledged by a ClientConsumer created by this session, `false` else
`boolean`	`isAutoCommitSends()` Returns whether the session will automatically commit its transaction every time a message is sent by a ClientProducer created by this session, `false` else
`boolean`	`isBlockOnAcknowledge()` Returns whether the ClientConsumer created by the session will block when they acknowledge a message.
`boolean`	`isClosed()` Returns whether the session is closed or not.
`boolean`	`isRollbackOnly()` Returns `true` if the current transaction has been flagged to rollback, `false` else.
`boolean`	`isXA()` Return `true` if the session supports XA, `false` else.
`ClientSession.QueueQuery`	`queueQuery(SimpleString queueName)` Queries information on a queue.
`boolean`	`removeFailoverListener(FailoverEventListener listener)` Removes a FailoverEventListener to the session.
`boolean`	`removeFailureListener(SessionFailureListener listener)` Removes a FailureListener to the session.
`void`	`rollback()` Rolls back the current transaction.
`void`	`rollback(boolean considerLastMessageAsDelivered)` Rolls back the current transaction.
`ClientSession`	`setSendAcknowledgementHandler(SendAcknowledgementHandler handler)` Sets a `SendAcknowledgementHandler` for this session.
`ClientSession`	`start()` Starts the session.
`void`	`stop()` Stops the session.

Methods inherited from interface javax.transaction.xa.XAResource
commit, end, forget, getTransactionTimeout, isSameRM, prepare, recover, rollback, setTransactionTimeout, start

- Field Detail
  - JMS_SESSION_IDENTIFIER_PROPERTY
```
static final String JMS_SESSION_IDENTIFIER_PROPERTY
```
    This is used to identify a ClientSession as used by the JMS Layer The JMS Layer will add this through Meta-data, so the server or management layers can identify session created over core API purely or through the JMS Layer
    
    See Also:
    
    Constant Field Values
- Method Detail
  - start
```
ClientSession start()
             throws ActiveMQException
```
    Starts the session. The session must be started before ClientConsumers created by the session can consume messages from the queue.
    
    Throws:
    
    ActiveMQException - if an exception occurs while starting the session
  - stop
```
void stop()
   throws ActiveMQException
```
    Stops the session. ClientConsumers created by the session can not consume messages when the session is stopped.
    
    Throws:
    
    ActiveMQException - if an exception occurs while stopping the session
  - close
```
void close()
    throws ActiveMQException
```
    Closes the session.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    ActiveMQException - if an exception occurs while closing the session
  - isClosed
```
boolean isClosed()
```
    Returns whether the session is closed or not.
    
    Returns:
    
    true if the session is closed, false else
  - addFailureListener
```
void addFailureListener(SessionFailureListener listener)
```
    Adds a FailureListener to the session which is notified if a failure occurs on the session.
    
    Parameters:
    
    listener - the listener to add
  - removeFailureListener
```
boolean removeFailureListener(SessionFailureListener listener)
```
    Removes a FailureListener to the session.
    
    Parameters:
    
    listener - the listener to remove
    
    Returns:
    
    true if the listener was removed, false else
  - addFailoverListener
```
void addFailoverListener(FailoverEventListener listener)
```
    Adds a FailoverEventListener to the session which is notified if a failover event occurs on the session.
    
    Parameters:
    
    listener - the listener to add
  - removeFailoverListener
```
boolean removeFailoverListener(FailoverEventListener listener)
```
    Removes a FailoverEventListener to the session.
    
    Parameters:
    
    listener - the listener to remove
    
    Returns:
    
    true if the listener was removed, false else
  - getVersion
```
int getVersion()
```
    Returns the server's incrementingVersion.
    
    Returns:
    
    the server's incrementingVersion
  - createAddress
```
void createAddress(SimpleString address,
                   EnumSet<RoutingType> routingTypes,
                   boolean autoCreated)
            throws ActiveMQException
```
    Create Address with a single initial routing type
    
    Parameters:
    
    address -
    
    autoCreated -
    
    Throws:
    
    ActiveMQException
  - createAddress
```
@Deprecated
void createAddress(SimpleString address,
                               Set<RoutingType> routingTypes,
                               boolean autoCreated)
                        throws ActiveMQException
```
    Deprecated.
    
    Create Address with a single initial routing type
    
    Parameters:
    
    address -
    
    autoCreated -
    
    Throws:
    
    ActiveMQException
  - createAddress
```
void createAddress(SimpleString address,
                   RoutingType routingType,
                   boolean autoCreated)
            throws ActiveMQException
```
    Create Address with a single initial routing type
    
    Parameters:
    
    address -
    
    routingType -
    
    autoCreated -
    
    Throws:
    
    ActiveMQException
  - createQueue
```
void createQueue(QueueConfiguration queueConfiguration)
          throws ActiveMQException
```
    This method creates a queue based on the QueueConfiguration input. See QueueConfiguration for more details on configuration specifics.
    Some static defaults will be enforced for properties which are not set on the QueueConfiguration:
    - transient : false
    - temporary : false
    - durable : true
    - autoCreated : false
    - internal : false
    - configurationManaged : false
    - maxConsumers : ActiveMQDefaultConfiguration.getDefaultMaxQueueConsumers()
    - purgeOnNoConsumers : ActiveMQDefaultConfiguration.getDefaultPurgeOnNoConsumers()
    Some dynamic defaults will be enforced via address-settings for the corresponding unset properties:
    - exclusive
    - groupRebalance
    - groupBuckets
    - groupFirstKey
    - lastValue
    - lastValueKey
    - nonDestructive
    - consumersBeforeDispatch
    - delayBeforeDispatch
    - ringSize
    - routingType
    - autoCreateAddress
    - autoDelete (only set if queue was auto-created)
    - autoDeleteDelay
    - autoDeleteMessageCount
    Parameters:
    
    queueConfiguration - the configuration to use when creating the queue
    
    Throws:
    
    ActiveMQException
  - createSharedQueue
```
void createSharedQueue(QueueConfiguration queueConfiguration)
                throws ActiveMQException
```
    This method is essentially the same as createQueue(QueueConfiguration) with a few key exceptions.
    If durable is true then:
    - transient will be forced to false
    - temporary will be forced to false
    If durable is false then:
    - transient will be forced to true
    - temporary will be forced to true
    In all instances autoCreated will be forced to false and autoCreatedAddress will be forced to true.
    Throws:
    
    ActiveMQException
    
    See Also:
    
    createQueue(QueueConfiguration)
  - createQueue
```
@Deprecated
void createQueue(SimpleString address,
                             SimpleString queueName,
                             boolean durable)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    durable - whether the queue is durable or not
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createSharedQueue
```
@Deprecated
void createSharedQueue(SimpleString address,
                                   SimpleString queueName,
                                   boolean durable)
                            throws ActiveMQException
```
    Deprecated.
    
    Creates a transient queue. A queue that will exist as long as there are consumers. When the last consumer is closed the queue will be deleted
    Notice: you will get an exception if the address or the filter doesn't match to an already existent queue
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    durable - if the queue is durable
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createSharedQueue
```
@Deprecated
void createSharedQueue(SimpleString address,
                                   SimpleString queueName,
                                   SimpleString filter,
                                   boolean durable)
                            throws ActiveMQException
```
    Deprecated.
    
    Creates a transient queue. A queue that will exist as long as there are consumers. When the last consumer is closed the queue will be deleted
    Notice: you will get an exception if the address or the filter doesn't match to an already existent queue
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    filter - whether the queue is durable or not
    
    durable - if the queue is durable
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(String address,
                             String queueName,
                             boolean durable)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    durable - whether the queue is durable or not
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(String address,
                             String queueName)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue non-durable queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(SimpleString address,
                             SimpleString queueName)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue non-durable queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(SimpleString address,
                             SimpleString queueName,
                             SimpleString filter,
                             boolean durable)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(String address,
                             String queueName,
                             String filter,
                             boolean durable)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporaryqueue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    durable - whether the queue is durable or not
    
    filter - only messages which match this filter will be put in the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(SimpleString address,
                             SimpleString queueName,
                             SimpleString filter,
                             boolean durable,
                             boolean autoCreated)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    autoCreated - whether to mark this queue as autoCreated or not
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(String address,
                             String queueName,
                             String filter,
                             boolean durable,
                             boolean autoCreated)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporaryqueue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    autoCreated - whether to mark this queue as autoCreated or not
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
@Deprecated
void createTemporaryQueue(SimpleString address,
                                      SimpleString queueName)
                               throws ActiveMQException
```
    Deprecated.
    
    Creates a temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
@Deprecated
void createTemporaryQueue(String address,
                                      String queueName)
                               throws ActiveMQException
```
    Deprecated.
    
    Creates a temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
@Deprecated
void createTemporaryQueue(SimpleString address,
                                      SimpleString queueName,
                                      SimpleString filter)
                               throws ActiveMQException
```
    Deprecated.
    
    Creates a temporary queue with a filter.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
@Deprecated
void createTemporaryQueue(String address,
                                      String queueName,
                                      String filter)
                               throws ActiveMQException
```
    Deprecated.
    
    Creates a temporary queue with a filter.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(SimpleString address,
                             RoutingType routingType,
                             SimpleString queueName,
                             boolean durable)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    durable - whether the queue is durable or not
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createSharedQueue
```
@Deprecated
void createSharedQueue(SimpleString address,
                                   RoutingType routingType,
                                   SimpleString queueName,
                                   boolean durable)
                            throws ActiveMQException
```
    Deprecated.
    
    Creates a transient queue. A queue that will exist as long as there are consumers. When the last consumer is closed the queue will be deleted
    Notice: you will get an exception if the address or the filter doesn't match to an already existent queue
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    durable - if the queue is durable
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createSharedQueue
```
@Deprecated
void createSharedQueue(SimpleString address,
                                   RoutingType routingType,
                                   SimpleString queueName,
                                   SimpleString filter,
                                   boolean durable)
                            throws ActiveMQException
```
    Deprecated.
    
    Creates a transient queue. A queue that will exist as long as there are consumers. When the last consumer is closed the queue will be deleted
    Notice: you will get an exception if the address or the filter doesn't match to an already existent queue
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - whether the queue is durable or not
    
    durable - if the queue is durable
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createSharedQueue
```
@Deprecated
void createSharedQueue(SimpleString address,
                                   RoutingType routingType,
                                   SimpleString queueName,
                                   SimpleString filter,
                                   boolean durable,
                                   Integer maxConsumers,
                                   Boolean purgeOnNoConsumers,
                                   Boolean exclusive,
                                   Boolean lastValue)
                            throws ActiveMQException
```
    Deprecated.
    
    Creates Shared queue. A queue that will exist as long as there are consumers or is durable.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - whether the queue is durable or not
    
    durable - if the queue is durable
    
    maxConsumers - how many concurrent consumers will be allowed on this queue
    
    purgeOnNoConsumers - whether to delete the contents of the queue when the last consumer disconnects
    
    exclusive - if the queue is exclusive queue
    
    lastValue - if the queue is last value queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createSharedQueue
```
@Deprecated
void createSharedQueue(SimpleString address,
                                   SimpleString queueName,
                                   QueueAttributes queueAttributes)
                            throws ActiveMQException
```
    Deprecated.
    
    Creates Shared queue. A queue that will exist as long as there are consumers or is durable.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    queueAttributes - attributes for the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(String address,
                             RoutingType routingType,
                             String queueName,
                             boolean durable)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    durable - whether the queue is durable or not
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(String address,
                             RoutingType routingType,
                             String queueName)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue non-durable queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(SimpleString address,
                             RoutingType routingType,
                             SimpleString queueName)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue non-durable queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(SimpleString address,
                             RoutingType routingType,
                             SimpleString queueName,
                             SimpleString filter,
                             boolean durable)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(String address,
                             RoutingType routingType,
                             String queueName,
                             String filter,
                             boolean durable)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporaryqueue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(SimpleString address,
                             RoutingType routingType,
                             SimpleString queueName,
                             SimpleString filter,
                             boolean durable,
                             boolean autoCreated)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    autoCreated - whether to mark this queue as autoCreated or not
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(SimpleString address,
                             RoutingType routingType,
                             SimpleString queueName,
                             SimpleString filter,
                             boolean durable,
                             boolean autoCreated,
                             int maxConsumers,
                             boolean purgeOnNoConsumers)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    autoCreated - whether to mark this queue as autoCreated or not
    
    maxConsumers - how many concurrent consumers will be allowed on this queue
    
    purgeOnNoConsumers - whether to delete the contents of the queue when the last consumer disconnects
    
    Throws:
    
    ActiveMQException
  - createQueue
```
@Deprecated
void createQueue(SimpleString address,
                             RoutingType routingType,
                             SimpleString queueName,
                             SimpleString filter,
                             boolean durable,
                             boolean autoCreated,
                             int maxConsumers,
                             boolean purgeOnNoConsumers,
                             Boolean exclusive,
                             Boolean lastValue)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    autoCreated - whether to mark this queue as autoCreated or not
    
    maxConsumers - how many concurrent consumers will be allowed on this queue
    
    purgeOnNoConsumers - whether to delete the contents of the queue when the last consumer disconnects
    
    exclusive - whether the queue should be exclusive
    
    lastValue - whether the queue should be lastValue
    
    Throws:
    
    ActiveMQException
  - createQueue
```
@Deprecated
void createQueue(SimpleString address,
                             SimpleString queueName,
                             boolean autoCreated,
                             QueueAttributes queueAttributes)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    autoCreated - whether to mark this queue as autoCreated or not
    
    queueAttributes - attributes for the queue
    
    Throws:
    
    ActiveMQException
  - createQueue
```
@Deprecated
void createQueue(String address,
                             RoutingType routingType,
                             String queueName,
                             String filter,
                             boolean durable,
                             boolean autoCreated)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporaryqueue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    autoCreated - whether to mark this queue as autoCreated or not
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createQueue
```
@Deprecated
void createQueue(String address,
                             RoutingType routingType,
                             String queueName,
                             String filter,
                             boolean durable,
                             boolean autoCreated,
                             int maxConsumers,
                             boolean purgeOnNoConsumers)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporaryqueue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    autoCreated - whether to mark this queue as autoCreated or not
    
    maxConsumers - how many concurrent consumers will be allowed on this queue
    
    purgeOnNoConsumers - whether to delete the contents of the queue when the last consumer disconnects
    
    Throws:
    
    ActiveMQException
  - createQueue
```
@Deprecated
void createQueue(String address,
                             RoutingType routingType,
                             String queueName,
                             String filter,
                             boolean durable,
                             boolean autoCreated,
                             int maxConsumers,
                             boolean purgeOnNoConsumers,
                             Boolean exclusive,
                             Boolean lastValue)
                      throws ActiveMQException
```
    Deprecated.
    
    Creates a non-temporaryqueue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    autoCreated - whether to mark this queue as autoCreated or not
    
    maxConsumers - how many concurrent consumers will be allowed on this queue
    
    purgeOnNoConsumers - whether to delete the contents of the queue when the last consumer disconnects
    
    exclusive - whether the queue should be exclusive
    
    lastValue - whether the queue should be lastValue
    
    Throws:
    
    ActiveMQException
  - createTemporaryQueue
```
@Deprecated
void createTemporaryQueue(SimpleString address,
                                      RoutingType routingType,
                                      SimpleString queueName)
                               throws ActiveMQException
```
    Deprecated.
    
    Creates a temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
@Deprecated
void createTemporaryQueue(String address,
                                      RoutingType routingType,
                                      String queueName)
                               throws ActiveMQException
```
    Deprecated.
    
    Creates a temporary queue.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
@Deprecated
void createTemporaryQueue(SimpleString address,
                                      RoutingType routingType,
                                      SimpleString queueName,
                                      SimpleString filter,
                                      int maxConsumers,
                                      boolean purgeOnNoConsumers,
                                      Boolean exclusive,
                                      Boolean lastValue)
                               throws ActiveMQException
```
    Deprecated.
    
    Creates a temporary queue with a filter.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    maxConsumers - how many concurrent consumers will be allowed on this queue
    
    purgeOnNoConsumers - whether to delete the contents of the queue when the last consumer disconnects
    
    exclusive - if the queue is exclusive queue
    
    lastValue - if the queue is last value queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
@Deprecated
void createTemporaryQueue(SimpleString address,
                                      SimpleString queueName,
                                      QueueAttributes queueAttributes)
                               throws ActiveMQException
```
    Deprecated.
    
    Creates a temporary queue with a filter.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    queueAttributes - attributes for the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
@Deprecated
void createTemporaryQueue(SimpleString address,
                                      RoutingType routingType,
                                      SimpleString queueName,
                                      SimpleString filter)
                               throws ActiveMQException
```
    Deprecated.
    
    Creates a temporary queue with a filter.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
@Deprecated
void createTemporaryQueue(String address,
                                      RoutingType routingType,
                                      String queueName,
                                      String filter)
                               throws ActiveMQException
```
    Deprecated.
    
    Creates a temporary queue with a filter.
    
    Parameters:
    
    address - the queue will be bound to this address
    
    routingType - the routing type for this queue, MULTICAST or ANYCAST
    
    queueName - the name of the queue
    
    filter - only messages which match this filter will be put in the queue
    
    Throws:
    
    ActiveMQException - in an exception occurs while creating the queue
  - deleteQueue
```
void deleteQueue(SimpleString queueName)
          throws ActiveMQException
```
    Deletes the queue.
    
    Parameters:
    
    queueName - the name of the queue to delete
    
    Throws:
    
    ActiveMQException - if there is no queue for the given name or if the queue has consumers
  - deleteQueue
```
void deleteQueue(String queueName)
          throws ActiveMQException
```
    Deletes the queue.
    
    Parameters:
    
    queueName - the name of the queue to delete
    
    Throws:
    
    ActiveMQException - if there is no queue for the given name or if the queue has consumers
  - createConsumer
```
ClientConsumer createConsumer(SimpleString queueName)
                       throws ActiveMQException
```
    Creates a ClientConsumer to consume message from the queue with the given name.
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
ClientConsumer createConsumer(String queueName)
                       throws ActiveMQException
```
    Creates a ClientConsumer to consume messages from the queue with the given name.
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
ClientConsumer createConsumer(SimpleString queueName,
                              SimpleString filter)
                       throws ActiveMQException
```
    Creates a ClientConsumer to consume messages matching the filter from the queue with the given name.
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filter - only messages which match this filter will be consumed
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
ClientConsumer createConsumer(String queueName,
                              String filter)
                       throws ActiveMQException
```
    Creates a ClientConsumer to consume messages matching the filter from the queue with the given name.
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filter - only messages which match this filter will be consumed
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
ClientConsumer createConsumer(SimpleString queueName,
                              boolean browseOnly)
                       throws ActiveMQException
```
    Creates a ClientConsumer to consume or browse messages from the queue with the given name.
    If browseOnly is true, the ClientConsumer will receive the messages from the queue but they will not be consumed (the messages will remain in the queue). Note that paged messages will not be in the queue, and will therefore not be visible if browseOnly is true.
    If browseOnly is false, the ClientConsumer will behave like consume the messages from the queue and the messages will effectively be removed from the queue.
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    browseOnly - whether the ClientConsumer will only browse the queue or consume messages.
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
ClientConsumer createConsumer(String queueName,
                              boolean browseOnly)
                       throws ActiveMQException
```
    Creates a ClientConsumer to consume or browse messages from the queue with the given name.
    If browseOnly is true, the ClientConsumer will receive the messages from the queue but they will not be consumed (the messages will remain in the queue). Note that paged messages will not be in the queue, and will therefore not be visible if browseOnly is true.
    If browseOnly is false, the ClientConsumer will behave like consume the messages from the queue and the messages will effectively be removed from the queue.
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    browseOnly - whether the ClientConsumer will only browse the queue or consume messages.
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
ClientConsumer createConsumer(String queueName,
                              String filter,
                              boolean browseOnly)
                       throws ActiveMQException
```
    Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
    If browseOnly is true, the ClientConsumer will receive the messages from the queue but they will not be consumed (the messages will remain in the queue). Note that paged messages will not be in the queue, and will therefore not be visible if browseOnly is true.
    If browseOnly is false, the ClientConsumer will behave like consume the messages from the queue and the messages will effectively be removed from the queue.
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filter - only messages which match this filter will be consumed
    
    browseOnly - whether the ClientConsumer will only browse the queue or consume messages.
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
ClientConsumer createConsumer(SimpleString queueName,
                              SimpleString filter,
                              boolean browseOnly)
                       throws ActiveMQException
```
    Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
    If browseOnly is true, the ClientConsumer will receive the messages from the queue but they will not be consumed (the messages will remain in the queue). Note that paged messages will not be in the queue, and will therefore not be visible if browseOnly is true.
    If browseOnly is false, the ClientConsumer will behave like consume the messages from the queue and the messages will effectively be removed from the queue.
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filter - only messages which match this filter will be consumed
    
    browseOnly - whether the ClientConsumer will only browse the queue or consume messages.
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
ClientConsumer createConsumer(SimpleString queueName,
                              SimpleString filter,
                              int priority,
                              boolean browseOnly)
                       throws ActiveMQException
```
    Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
    If browseOnly is true, the ClientConsumer will receive the messages from the queue but they will not be consumed (the messages will remain in the queue). Note that paged messages will not be in the queue, and will therefore not be visible if browseOnly is true.
    If browseOnly is false, the ClientConsumer will behave like consume the messages from the queue and the messages will effectively be removed from the queue.
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filter - only messages which match this filter will be consumed
    
    priority - the consumer priority
    
    browseOnly - whether the ClientConsumer will only browse the queue or consume messages.
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
ClientConsumer createConsumer(SimpleString queueName,
                              SimpleString filter,
                              int windowSize,
                              int maxRate,
                              boolean browseOnly)
                       throws ActiveMQException
```
    Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
    If browseOnly is true, the ClientConsumer will receive the messages from the queue but they will not be consumed (the messages will remain in the queue). Note that paged messages will not be in the queue, and will therefore not be visible if browseOnly is true.
    If browseOnly is false, the ClientConsumer will behave like consume the messages from the queue and the messages will effectively be removed from the queue.
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filter - only messages which match this filter will be consumed
    
    windowSize - the consumer window size
    
    maxRate - the maximum rate to consume messages
    
    browseOnly - whether the ClientConsumer will only browse the queue or consume messages.
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
ClientConsumer createConsumer(SimpleString queueName,
                              SimpleString filter,
                              int priority,
                              int windowSize,
                              int maxRate,
                              boolean browseOnly)
                       throws ActiveMQException
```
    Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
    If browseOnly is true, the ClientConsumer will receive the messages from the queue but they will not be consumed (the messages will remain in the queue). Note that paged messages will not be in the queue, and will therefore not be visible if browseOnly is true.
    If browseOnly is false, the ClientConsumer will behave like consume the messages from the queue and the messages will effectively be removed from the queue.
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filter - only messages which match this filter will be consumed
    
    priority - the consumer priority
    
    windowSize - the consumer window size
    
    maxRate - the maximum rate to consume messages
    
    browseOnly - whether the ClientConsumer will only browse the queue or consume messages.
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
ClientConsumer createConsumer(String queueName,
                              String filter,
                              int windowSize,
                              int maxRate,
                              boolean browseOnly)
                       throws ActiveMQException
```
    Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
    If browseOnly is true, the ClientConsumer will receive the messages from the queue but they will not be consumed (the messages will remain in the queue). Note that paged messages will not be in the queue, and will therefore not be visible if browseOnly is true.
    If browseOnly is false, the ClientConsumer will behave like consume the messages from the queue and the messages will effectively be removed from the queue.
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filter - only messages which match this filter will be consumed
    
    windowSize - the consumer window size
    
    maxRate - the maximum rate to consume messages
    
    browseOnly - whether the ClientConsumer will only browse the queue or consume messages.
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientConsumer
  - createProducer
```
ClientProducer createProducer()
                       throws ActiveMQException
```
    Creates a producer with no default address. Address must be specified every time a message is sent
    
    Returns:
    
    a ClientProducer
    
    Throws:
    
    ActiveMQException
    
    See Also:
    
    ClientProducer.send(SimpleString, org.apache.activemq.artemis.api.core.Message)
  - createProducer
```
ClientProducer createProducer(SimpleString address)
                       throws ActiveMQException
```
    Creates a producer which sends messages to the given address
    
    Parameters:
    
    address - the address to send messages to
    
    Returns:
    
    a ClientProducer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientProducer
  - createProducer
```
ClientProducer createProducer(String address)
                       throws ActiveMQException
```
    Creates a producer which sends messages to the given address
    
    Parameters:
    
    address - the address to send messages to
    
    Returns:
    
    a ClientProducer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientProducer
  - createProducer
```
ClientProducer createProducer(SimpleString address,
                              int rate)
                       throws ActiveMQException
```
    Creates a producer which sends messages to the given address
    
    Parameters:
    
    address - the address to send messages to
    
    rate - the producer rate
    
    Returns:
    
    a ClientProducer
    
    Throws:
    
    ActiveMQException - if an exception occurs while creating the ClientProducer
  - createMessage
```
ClientMessage createMessage(boolean durable)
```
    Creates a ClientMessage.
    
    Parameters:
    
    durable - whether the created message is durable or not
    
    Returns:
    
    a ClientMessage
  - createMessage
```
ClientMessage createMessage(byte type,
                            boolean durable)
```
    Creates a ClientMessage.
    
    Parameters:
    
    type - type of the message
    
    durable - whether the created message is durable or not
    
    Returns:
    
    a ClientMessage
  - createMessage
```
ClientMessage createMessage(byte type,
                            boolean durable,
                            long expiration,
                            long timestamp,
                            byte priority)
```
    Creates a ClientMessage.
    
    Parameters:
    
    type - type of the message
    
    durable - whether the created message is durable or not
    
    expiration - the message expiration
    
    timestamp - the message timestamp
    
    priority - the message priority (between 0 and 9 inclusive)
    
    Returns:
    
    a ClientMessage
  - queueQuery
```
ClientSession.QueueQuery queueQuery(SimpleString queueName)
                             throws ActiveMQException
```
    Queries information on a queue.
    
    Parameters:
    
    queueName - the name of the queue to query
    
    Returns:
    
    a QueueQuery containing information on the given queue
    
    Throws:
    
    ActiveMQException - if an exception occurs while querying the queue
  - addressQuery
```
ClientSession.AddressQuery addressQuery(SimpleString address)
                                 throws ActiveMQException
```
    Queries information on a binding.
    
    Parameters:
    
    address - the address of the biding to query
    
    Returns:
    
    an AddressQuery containing information on the binding attached to the given address
    
    Throws:
    
    ActiveMQException - if an exception occurs while querying the binding
  - getXAResource
```
XAResource getXAResource()
```
    Returns the XAResource associated to the session.
    
    Returns:
    
    the XAResource associated to the session
  - isXA
```
boolean isXA()
```
    Return true if the session supports XA, false else.
    
    Returns:
    
    true if the session supports XA, false else.
  - commit
```
void commit()
     throws ActiveMQException
```
    Commits the current transaction, blocking.
    
    Throws:
    
    ActiveMQException - if an exception occurs while committing the transaction
  - commit
```
void commit(boolean block)
     throws ActiveMQException
```
    Commits the current transaction.
    
    Parameters:
    
    block - if the commit will be blocking or not.
    
    Throws:
    
    ActiveMQException - if an exception occurs while committing the transaction
  - rollback
```
void rollback()
       throws ActiveMQException
```
    Rolls back the current transaction.
    
    Throws:
    
    ActiveMQException - if an exception occurs while rolling back the transaction
  - rollback
```
void rollback(boolean considerLastMessageAsDelivered)
       throws ActiveMQException
```
    Rolls back the current transaction.
    
    Parameters:
    
    considerLastMessageAsDelivered - the first message on deliveringMessage Buffer is considered as delivered
    
    Throws:
    
    ActiveMQException - if an exception occurs while rolling back the transaction
  - isRollbackOnly
```
boolean isRollbackOnly()
```
    Returns true if the current transaction has been flagged to rollback, false else.
    
    Returns:
    
    true if the current transaction has been flagged to rollback, false else.
  - isAutoCommitSends
```
boolean isAutoCommitSends()
```
    Returns whether the session will automatically commit its transaction every time a message is sent by a ClientProducer created by this session, false else
    
    Returns:
    
    true if the session automatically commit its transaction every time a message is sent, false else
  - isAutoCommitAcks
```
boolean isAutoCommitAcks()
```
    Returns whether the session will automatically commit its transaction every time a message is acknowledged by a ClientConsumer created by this session, false else
    
    Returns:
    
    true if the session automatically commit its transaction every time a message is acknowledged, false else
  - isBlockOnAcknowledge
```
boolean isBlockOnAcknowledge()
```
    Returns whether the ClientConsumer created by the session will block when they acknowledge a message.
    
    Returns:
    
    true if the session's ClientConsumer block when they acknowledge a message, false else
  - setSendAcknowledgementHandler
```
ClientSession setSendAcknowledgementHandler(SendAcknowledgementHandler handler)
```
    Sets a SendAcknowledgementHandler for this session.
    
    Parameters:
    
    handler - a SendAcknowledgementHandler
    
    Returns:
    
    this ClientSession
  - addMetaData
```
void addMetaData(String key,
                 String data)
          throws ActiveMQException
```
    Attach any metadata to the session.
    
    Throws:
    
    ActiveMQException
  - addUniqueMetaData
```
void addUniqueMetaData(String key,
                       String data)
                throws ActiveMQException
```
    Attach any metadata to the session. Throws an exception if there's already a metadata available. You can use this metadata to ensure that there is no other session with the same meta-data you are passing as an argument. This is useful to simulate unique client-ids, where you may want to avoid multiple instances of your client application connected.
    
    Throws:
    
    ActiveMQException
  - getSessionFactory
```
ClientSessionFactory getSessionFactory()
```
    Return the sessionFactory used to created this Session.
    
    Returns:

Interface ClientSession

Nested Class Summary

Field Summary

Fields inherited from interface javax.transaction.xa.XAResource

Method Summary

Methods inherited from interface javax.transaction.xa.XAResource

Field Detail

JMS_SESSION_IDENTIFIER_PROPERTY

Method Detail

start

stop

close

isClosed

addFailureListener

removeFailureListener

addFailoverListener

removeFailoverListener

getVersion

createAddress

createAddress

createAddress

createQueue

createSharedQueue

createQueue

createSharedQueue

createSharedQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createTemporaryQueue

createTemporaryQueue

createTemporaryQueue

createTemporaryQueue

createQueue

createSharedQueue

createSharedQueue

createSharedQueue

createSharedQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createQueue

createTemporaryQueue

createTemporaryQueue

createTemporaryQueue

createTemporaryQueue

createTemporaryQueue

createTemporaryQueue

deleteQueue

deleteQueue

createConsumer

createConsumer

createConsumer

createConsumer

createConsumer

createConsumer

createConsumer

createConsumer

createConsumer

createConsumer

createConsumer

createConsumer

createProducer

createProducer

createProducer

createProducer

createMessage

createMessage