ClientSessionImpl (HornetQ Parent 2.4.7.Final API)

java.lang.Object
- org.hornetq.core.client.impl.ClientSessionImpl

All Implemented Interfaces:

AutoCloseable, XAResource, ClientSession, ClientSessionInternal, CommandConfirmationHandler, FailureListener
```
public final class ClientSessionImpl
extends Object
implements ClientSessionInternal, FailureListener, CommandConfirmationHandler
```
Author:

Tim Fox, Ovidiu Feodorov, Clebert Suconic, Jeff Mesnil, Andy Taylor

Nested Class Summary
- Nested classes/interfaces inherited from interface org.hornetq.api.core.client.ClientSession
  ClientSession.BindingQuery, ClientSession.QueueQuery

Field Summary
- 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 Concrete Methods
Modifier and Type	Method and Description
`void`	`acknowledge(long consumerID, long messageID)` Acknowledges all messages received by the consumer so far.
`void`	`addConsumer(ClientConsumerInternal consumer)`
`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.
`void`	`addProducer(ClientProducerInternal producer)`
`void`	`addUniqueMetaData(String key, String data)` Attach any metadata to the session.
`ClientSession.BindingQuery`	`bindingQuery(SimpleString address)` Queries information on a binding.
`void`	`cleanUp(boolean failingOver)`
`Set<ClientConsumerInternal>`	`cloneConsumers()` Not part of the interface, used on tests only
`Set<ClientProducerInternal>`	`cloneProducers()` Not part of the interface, used on tests only
`void`	`close()` Closes the session.
`void`	`commandConfirmed(Packet packet)` called by channel after a confirmation has been received.
`void`	`commit()` Commits the current transaction.
`void`	`commit(Xid xid, boolean onePhase)`
`void`	`connectionFailed(HornetQException me, boolean failedOver)` Notifies that a connection has failed due to the specified exception.
`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 filterString)` Creates a ClientConsumer to consume messages matching the filter from the queue with the given name.
`ClientConsumer`	`createConsumer(SimpleString queueName, SimpleString filterString, 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 filterString, int windowSize, int maxRate, boolean browseOnly)` Note, we DO NOT currently support direct consumers (i.e.
`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 filterString)` Creates a ClientConsumer to consume messages matching the filter from the queue with the given name.
`ClientConsumer`	`createConsumer(String queueName, String filterString, 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 filterString, 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 maxRate)` Creates a producer which sends messages to the given address
`ClientProducer`	`createProducer(String address)` Creates a producer which sends messages to the given address
`ClientProducer`	`createProducer(String address, int rate)`
`void`	`createQueue(SimpleString address, SimpleString queueName)` Creates a non-temporary queue non-durable queue.
`void`	`createQueue(SimpleString address, SimpleString queueName, boolean durable)` Creates a non-temporary queue.
`void`	`createQueue(SimpleString address, SimpleString queueName, SimpleString filterString, boolean durable)` Creates a non-temporary queue.
`void`	`createQueue(String address, String queueName)` Creates a non-temporary queue non-durable queue.
`void`	`createQueue(String address, String queueName, boolean durable)` Creates a non-temporary queue.
`void`	`createQueue(String address, String queueName, String filterString, boolean durable)` Creates a non-temporaryqueue.
`void`	`createSharedQueue(SimpleString address, SimpleString queueName, boolean durable)` Creates a transient queue.
`void`	`createSharedQueue(SimpleString address, SimpleString queueName, SimpleString filterString, boolean durable)` Creates a transient queue.
`void`	`createTemporaryQueue(SimpleString address, SimpleString queueName)` Creates a temporary queue.
`void`	`createTemporaryQueue(SimpleString address, SimpleString queueName, SimpleString filter)` Creates a temporary queue with a filter.
`void`	`createTemporaryQueue(String address, String queueName)` Creates a temporary queue.
`void`	`createTemporaryQueue(String address, String queueName, String filter)` Creates a temporary queue with a filter.
`void`	`deleteQueue(SimpleString queueName)` Deletes the queue.
`void`	`deleteQueue(String queueName)` Deletes the queue.
`void`	`end(Xid xid, int flags)`
`void`	`endCall()`
`void`	`expire(long consumerID, long messageID)`
`void`	`forceDelivery(long consumerID, long sequence)`
`void`	`forget(Xid xid)`
`Channel`	`getChannel()`
`RemotingConnection`	`getConnection()`
`ClientProducerCredits`	`getCredits(SimpleString address, boolean anon)`
`int`	`getMinLargeMessageSize()`
`String`	`getName()`
`ClientProducerCreditManager`	`getProducerCreditManager()`
`ClientSessionFactoryInternal`	`getSessionFactory()`
`int`	`getTransactionTimeout()`
`int`	`getVersion()` Returns the server's incrementingVersion.
`XAResource`	`getXAResource()` Returns the XAResource associated to the session.
`void`	`handleConsumerDisconnect(long consumerID)`
`void`	`handleFailover(CoreRemotingConnection backupConnection, HornetQException cause)`
`void`	`handleReceiveContinuation(long consumerID, SessionReceiveContinuationMessage continuation)`
`void`	`handleReceiveLargeMessage(long consumerID, SessionReceiveLargeMessage message)`
`void`	`handleReceiveMessage(long consumerID, SessionReceiveMessage message)`
`void`	`handleReceiveProducerCredits(SimpleString address, int credits)`
`void`	`handleReceiveProducerFailCredits(SimpleString address, int credits)`
`void`	`individualAcknowledge(long consumerID, long messageID)`
`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`	`isCacheLargeMessageClient()`
`boolean`	`isClosed()` Returns whether the session is closed or not.
`boolean`	`isCompressLargeMessages()`
`boolean`	`isConfirmationWindowEnabled()`
`boolean`	`isRollbackOnly()` Returns `true` if the current transaction has been flagged to rollback, `false` else.
`boolean`	`isSameRM(XAResource xares)`
`boolean`	`isXA()` Return `true` if the session supports XA, `false` else.
`void`	`preHandleFailover(CoreRemotingConnection connection)`
`int`	`prepare(Xid xid)`
`ClientSession.QueueQuery`	`queueQuery(SimpleString queueName)` Queries information on a queue.
`Xid[]`	`recover(int flags)`
`void`	`removeConsumer(ClientConsumerInternal consumer)`
`boolean`	`removeFailoverListener(FailoverEventListener listener)` Removes a FailoverEventListener to the session.
`boolean`	`removeFailureListener(SessionFailureListener listener)` Removes a FailureListener to the session.
`void`	`removeProducer(ClientProducerInternal producer)`
`void`	`resetIfNeeded()`
`void`	`returnBlocking()`
`void`	`returnCredits(SimpleString address)`
`void`	`rollback()` Rolls back the current transaction.
`void`	`rollback(boolean isLastMessageAsDelivered)` Rolls back the current transaction.
`void`	`rollback(Xid xid)`
`void`	`scheduleConfirmation(SendAcknowledgementHandler handler, Message message)`
`void`	`sendProducerCreditsMessage(int credits, SimpleString address)`
`void`	`setAddress(Message message, SimpleString address)`
`void`	`setForceNotSameRM(boolean force)`
`void`	`setPacketSize(int packetSize)`
`void`	`setSendAcknowledgementHandler(SendAcknowledgementHandler handler)` Sets a `SendAcknowledgementHandler` for this session.
`void`	`setStopSignal()` Sets a stop signal to true.
`boolean`	`setTransactionTimeout(int seconds)`
`void`	`start()` Starts the session.
`void`	`start(Xid xid, int flags)`
`void`	`startCall()` This is used internally to control and educate the user about using the thread boundaries properly.
`void`	`stop()` Stops the session.
`void`	`stop(boolean waitForOnMessage)`
`String`	`toString()`
`void`	`workDone()`

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

- Method Detail
  - getChannel
```
public Channel getChannel()
```
    Specified by:
    
    getChannel in interface ClientSessionInternal
  - createQueue
```
public void createQueue(SimpleString address,
                        SimpleString queueName)
                 throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a non-temporary queue non-durable queue.
    
    Specified by:
    
    createQueue in interface ClientSession
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    Throws:
    
    HornetQException - in an exception occurs while creating the queue
  - createQueue
```
public void createQueue(SimpleString address,
                        SimpleString queueName,
                        boolean durable)
                 throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a non-temporary queue.
    
    Specified by:
    
    createQueue in interface ClientSession
    
    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:
    
    HornetQException - in an exception occurs while creating the queue
  - createQueue
```
public void createQueue(String address,
                        String queueName,
                        boolean durable)
                 throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a non-temporary queue.
    
    Specified by:
    
    createQueue in interface ClientSession
    
    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:
    
    HornetQException - in an exception occurs while creating the queue
  - createSharedQueue
```
public void createSharedQueue(SimpleString address,
                              SimpleString queueName,
                              boolean durable)
                       throws HornetQException
```
    Description copied from interface: ClientSession
    
    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
    
    Specified by:
    
    createSharedQueue in interface ClientSession
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    durable - if the queue is durable
    
    Throws:
    
    HornetQException - in an exception occurs while creating the queue
  - createSharedQueue
```
public void createSharedQueue(SimpleString address,
                              SimpleString queueName,
                              SimpleString filterString,
                              boolean durable)
                       throws HornetQException
```
    Description copied from interface: ClientSession
    
    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
    
    Specified by:
    
    createSharedQueue in interface ClientSession
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    filterString - whether the queue is durable or not
    
    durable - if the queue is durable
    
    Throws:
    
    HornetQException - in an exception occurs while creating the queue
  - createQueue
```
public void createQueue(SimpleString address,
                        SimpleString queueName,
                        SimpleString filterString,
                        boolean durable)
                 throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a non-temporary queue.
    
    Specified by:
    
    createQueue in interface ClientSession
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    filterString - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    Throws:
    
    HornetQException - in an exception occurs while creating the queue
  - createQueue
```
public void createQueue(String address,
                        String queueName,
                        String filterString,
                        boolean durable)
                 throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a non-temporaryqueue.
    
    Specified by:
    
    createQueue in interface ClientSession
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    filterString - only messages which match this filter will be put in the queue
    
    durable - whether the queue is durable or not
    
    Throws:
    
    HornetQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
public void createTemporaryQueue(SimpleString address,
                                 SimpleString queueName)
                          throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a temporary queue.
    
    Specified by:
    
    createTemporaryQueue in interface ClientSession
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    Throws:
    
    HornetQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
public void createTemporaryQueue(String address,
                                 String queueName)
                          throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a temporary queue.
    
    Specified by:
    
    createTemporaryQueue in interface ClientSession
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    Throws:
    
    HornetQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
public void createTemporaryQueue(SimpleString address,
                                 SimpleString queueName,
                                 SimpleString filter)
                          throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a temporary queue with a filter.
    
    Specified by:
    
    createTemporaryQueue in interface ClientSession
    
    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:
    
    HornetQException - in an exception occurs while creating the queue
  - createTemporaryQueue
```
public void createTemporaryQueue(String address,
                                 String queueName,
                                 String filter)
                          throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a temporary queue with a filter.
    
    Specified by:
    
    createTemporaryQueue in interface ClientSession
    
    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:
    
    HornetQException - in an exception occurs while creating the queue
  - deleteQueue
```
public void deleteQueue(SimpleString queueName)
                 throws HornetQException
```
    Description copied from interface: ClientSession
    
    Deletes the queue.
    
    Specified by:
    
    deleteQueue in interface ClientSession
    
    Parameters:
    
    queueName - the name of the queue to delete
    
    Throws:
    
    HornetQException - if there is no queue for the given name or if the queue has consumers
  - deleteQueue
```
public void deleteQueue(String queueName)
                 throws HornetQException
```
    Description copied from interface: ClientSession
    
    Deletes the queue.
    
    Specified by:
    
    deleteQueue in interface ClientSession
    
    Parameters:
    
    queueName - the name of the queue to delete
    
    Throws:
    
    HornetQException - if there is no queue for the given name or if the queue has consumers
  - queueQuery
```
public ClientSession.QueueQuery queueQuery(SimpleString queueName)
                                    throws HornetQException
```
    Description copied from interface: ClientSession
    
    Queries information on a queue.
    
    Specified by:
    
    queueQuery in interface ClientSession
    
    Parameters:
    
    queueName - the name of the queue to query
    
    Returns:
    
    a QueueQuery containing information on the given queue
    
    Throws:
    
    HornetQException - if an exception occurs while querying the queue
  - bindingQuery
```
public ClientSession.BindingQuery bindingQuery(SimpleString address)
                                        throws HornetQException
```
    Description copied from interface: ClientSession
    
    Queries information on a binding.
    
    Specified by:
    
    bindingQuery in interface ClientSession
    
    Parameters:
    
    address - the address of the biding to query
    
    Returns:
    
    a BindingQuery containing information on the binding attached to the given address
    
    Throws:
    
    HornetQException - if an exception occurs while querying the binding
  - forceDelivery
```
public void forceDelivery(long consumerID,
                          long sequence)
                   throws HornetQException
```
    Specified by:
    
    forceDelivery in interface ClientSessionInternal
    
    Throws:
    
    HornetQException
  - createConsumer
```
public ClientConsumer createConsumer(SimpleString queueName)
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a ClientConsumer to consume message from the queue with the given name.
    
    Specified by:
    
    createConsumer in interface ClientSession
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    HornetQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
public ClientConsumer createConsumer(String queueName)
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a ClientConsumer to consume messages from the queue with the given name.
    
    Specified by:
    
    createConsumer in interface ClientSession
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    HornetQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
public ClientConsumer createConsumer(SimpleString queueName,
                                     SimpleString filterString)
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a ClientConsumer to consume messages matching the filter from the queue with the given name.
    
    Specified by:
    
    createConsumer in interface ClientSession
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filterString - only messages which match this filter will be consumed
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    HornetQException - if an exception occurs while creating the ClientConsumer
  - createQueue
```
public void createQueue(String address,
                        String queueName)
                 throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a non-temporary queue non-durable queue.
    
    Specified by:
    
    createQueue in interface ClientSession
    
    Parameters:
    
    address - the queue will be bound to this address
    
    queueName - the name of the queue
    
    Throws:
    
    HornetQException - in an exception occurs while creating the queue
  - createConsumer
```
public ClientConsumer createConsumer(String queueName,
                                     String filterString)
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a ClientConsumer to consume messages matching the filter from the queue with the given name.
    
    Specified by:
    
    createConsumer in interface ClientSession
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filterString - only messages which match this filter will be consumed
    
    Returns:
    
    a ClientConsumer
    
    Throws:
    
    HornetQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
public ClientConsumer createConsumer(SimpleString queueName,
                                     SimpleString filterString,
                                     boolean browseOnly)
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    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.
    
    Specified by:
    
    createConsumer in interface ClientSession
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filterString - 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:
    
    HornetQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
public ClientConsumer createConsumer(SimpleString queueName,
                                     boolean browseOnly)
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    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.
    
    Specified by:
    
    createConsumer in interface ClientSession
    
    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:
    
    HornetQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
public ClientConsumer createConsumer(String queueName,
                                     String filterString,
                                     boolean browseOnly)
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    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.
    
    Specified by:
    
    createConsumer in interface ClientSession
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filterString - 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:
    
    HornetQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
public ClientConsumer createConsumer(String queueName,
                                     boolean browseOnly)
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    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.
    
    Specified by:
    
    createConsumer in interface ClientSession
    
    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:
    
    HornetQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
public ClientConsumer createConsumer(SimpleString queueName,
                                     SimpleString filterString,
                                     int windowSize,
                                     int maxRate,
                                     boolean browseOnly)
                              throws HornetQException
```
    Note, we DO NOT currently support direct consumers (i.e. consumers where delivery occurs on the remoting thread).
    Direct consumers have issues with blocking and failover. E.g. if direct then inside MessageHandler call a blocking method like rollback or acknowledge (blocking) This can block until failover completes, which disallows the thread to be used to deliver any responses to the client during that period, so failover won't occur. If we want direct consumers we need to rethink how they work.
    
    Specified by:
    
    createConsumer in interface ClientSession
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filterString - 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:
    
    HornetQException - if an exception occurs while creating the ClientConsumer
  - createConsumer
```
public ClientConsumer createConsumer(String queueName,
                                     String filterString,
                                     int windowSize,
                                     int maxRate,
                                     boolean browseOnly)
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    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.
    
    Specified by:
    
    createConsumer in interface ClientSession
    
    Parameters:
    
    queueName - name of the queue to consume messages from
    
    filterString - 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:
    
    HornetQException - if an exception occurs while creating the ClientConsumer
  - createProducer
```
public ClientProducer createProducer()
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a producer with no default address. Address must be specified every time a message is sent
    
    Specified by:
    
    createProducer in interface ClientSession
    
    Returns:
    
    a ClientProducer
    
    Throws:
    
    HornetQException
    
    See Also:
    
    ClientProducer.send(SimpleString, org.hornetq.api.core.Message)
  - createProducer
```
public ClientProducer createProducer(SimpleString address)
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a producer which sends messages to the given address
    
    Specified by:
    
    createProducer in interface ClientSession
    
    Parameters:
    
    address - the address to send messages to
    
    Returns:
    
    a ClientProducer
    
    Throws:
    
    HornetQException - if an exception occurs while creating the ClientProducer
  - createProducer
```
public ClientProducer createProducer(String address)
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a producer which sends messages to the given address
    
    Specified by:
    
    createProducer in interface ClientSession
    
    Parameters:
    
    address - the address to send messages to
    
    Returns:
    
    a ClientProducer
    
    Throws:
    
    HornetQException - if an exception occurs while creating the ClientProducer
  - createProducer
```
public ClientProducer createProducer(SimpleString address,
                                     int maxRate)
                              throws HornetQException
```
    Description copied from interface: ClientSession
    
    Creates a producer which sends messages to the given address
    
    Specified by:
    
    createProducer in interface ClientSession
    
    Parameters:
    
    address - the address to send messages to
    
    maxRate - the producer rate
    
    Returns:
    
    a ClientProducer
    
    Throws:
    
    HornetQException - if an exception occurs while creating the ClientProducer
  - createProducer
```
public ClientProducer createProducer(String address,
                                     int rate)
                              throws HornetQException
```
    Throws:
    
    HornetQException
  - getXAResource
```
public XAResource getXAResource()
```
    Description copied from interface: ClientSession
    
    Returns the XAResource associated to the session.
    
    Specified by:
    
    getXAResource in interface ClientSession
    
    Returns:
    
    the XAResource associated to the session
  - commit
```
public void commit()
            throws HornetQException
```
    Description copied from interface: ClientSession
    
    Commits the current transaction.
    
    Specified by:
    
    commit in interface ClientSession
    
    Throws:
    
    HornetQException - if an exception occurs while committing the transaction
  - isRollbackOnly
```
public boolean isRollbackOnly()
```
    Description copied from interface: ClientSession
    
    Returns true if the current transaction has been flagged to rollback, false else.
    
    Specified by:
    
    isRollbackOnly in interface ClientSession
    
    Returns:
    
    true if the current transaction has been flagged to rollback, false else.
  - rollback
```
public void rollback()
              throws HornetQException
```
    Description copied from interface: ClientSession
    
    Rolls back the current transaction.
    
    Specified by:
    
    rollback in interface ClientSession
    
    Throws:
    
    HornetQException - if an exception occurs while rolling back the transaction
  - rollback
```
public void rollback(boolean isLastMessageAsDelivered)
              throws HornetQException
```
    Description copied from interface: ClientSession
    
    Rolls back the current transaction.
    
    Specified by:
    
    rollback in interface ClientSession
    
    Parameters:
    
    isLastMessageAsDelivered - the first message on deliveringMessage Buffer is considered as delivered
    
    Throws:
    
    HornetQException - if an exception occurs while rolling back the transaction
  - createMessage
```
public ClientMessage createMessage(byte type,
                                   boolean durable,
                                   long expiration,
                                   long timestamp,
                                   byte priority)
```
    Description copied from interface: ClientSession
    
    Creates a ClientMessage.
    
    Specified by:
    
    createMessage in interface ClientSession
    
    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
  - createMessage
```
public ClientMessage createMessage(byte type,
                                   boolean durable)
```
    Description copied from interface: ClientSession
    
    Creates a ClientMessage.
    
    Specified by:
    
    createMessage in interface ClientSession
    
    Parameters:
    
    type - type of the message
    
    durable - whether the created message is durable or not
    
    Returns:
    
    a ClientMessage
  - createMessage
```
public ClientMessage createMessage(boolean durable)
```
    Description copied from interface: ClientSession
    
    Creates a ClientMessage.
    
    Specified by:
    
    createMessage in interface ClientSession
    
    Parameters:
    
    durable - whether the created message is durable or not
    
    Returns:
    
    a ClientMessage
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: ClientSession
    
    Returns whether the session is closed or not.
    
    Specified by:
    
    isClosed in interface ClientSession
    
    Returns:
    
    true if the session is closed, false else
  - isAutoCommitSends
```
public boolean isAutoCommitSends()
```
    Description copied from interface: ClientSession
    
    Returns whether the session will automatically commit its transaction every time a message is sent by a ClientProducer created by this session, false else
    
    Specified by:
    
    isAutoCommitSends in interface ClientSession
    
    Returns:
    
    true if the session automatically commit its transaction every time a message is sent, false else
  - isAutoCommitAcks
```
public boolean isAutoCommitAcks()
```
    Description copied from interface: ClientSession
    
    Returns whether the session will automatically commit its transaction every time a message is acknowledged by a ClientConsumer created by this session, false else
    
    Specified by:
    
    isAutoCommitAcks in interface ClientSession
    
    Returns:
    
    true if the session automatically commit its transaction every time a message is acknowledged, false else
  - isBlockOnAcknowledge
```
public boolean isBlockOnAcknowledge()
```
    Description copied from interface: ClientSession
    
    Returns whether the ClientConsumer created by the session will block when they acknowledge a message.
    
    Specified by:
    
    isBlockOnAcknowledge in interface ClientSession
    
    Returns:
    
    true if the session's ClientConsumer block when they acknowledge a message, false else
  - isXA
```
public boolean isXA()
```
    Description copied from interface: ClientSession
    
    Return true if the session supports XA, false else.
    
    Specified by:
    
    isXA in interface ClientSession
    
    Returns:
    
    true if the session supports XA, false else.
  - resetIfNeeded
```
public void resetIfNeeded()
                   throws HornetQException
```
    Specified by:
    
    resetIfNeeded in interface ClientSessionInternal
    
    Throws:
    
    HornetQException
  - start
```
public void start()
           throws HornetQException
```
    Description copied from interface: ClientSession
    
    Starts the session. The session must be started before ClientConsumers created by the session can consume messages from the queue.
    
    Specified by:
    
    start in interface ClientSession
    
    Throws:
    
    HornetQException - if an exception occurs while starting the session
  - stop
```
public void stop()
          throws HornetQException
```
    Description copied from interface: ClientSession
    
    Stops the session. ClientConsumers created by the session can not consume messages when the session is stopped.
    
    Specified by:
    
    stop in interface ClientSession
    
    Throws:
    
    HornetQException - if an exception occurs while stopping the session
  - stop
```
public void stop(boolean waitForOnMessage)
          throws HornetQException
```
    Throws:
    
    HornetQException
  - addFailureListener
```
public void addFailureListener(SessionFailureListener listener)
```
    Description copied from interface: ClientSession
    
    Adds a FailureListener to the session which is notified if a failure occurs on the session.
    
    Specified by:
    
    addFailureListener in interface ClientSession
    
    Parameters:
    
    listener - the listener to add
  - removeFailureListener
```
public boolean removeFailureListener(SessionFailureListener listener)
```
    Description copied from interface: ClientSession
    
    Removes a FailureListener to the session.
    
    Specified by:
    
    removeFailureListener in interface ClientSession
    
    Parameters:
    
    listener - the listener to remove
    
    Returns:
    
    true if the listener was removed, false else
  - addFailoverListener
```
public void addFailoverListener(FailoverEventListener listener)
```
    Description copied from interface: ClientSession
    
    Adds a FailoverEventListener to the session which is notified if a failover event occurs on the session.
    
    Specified by:
    
    addFailoverListener in interface ClientSession
    
    Parameters:
    
    listener - the listener to add
  - removeFailoverListener
```
public boolean removeFailoverListener(FailoverEventListener listener)
```
    Description copied from interface: ClientSession
    
    Removes a FailoverEventListener to the session.
    
    Specified by:
    
    removeFailoverListener in interface ClientSession
    
    Parameters:
    
    listener - the listener to remove
    
    Returns:
    
    true if the listener was removed, false else
  - getVersion
```
public int getVersion()
```
    Description copied from interface: ClientSession
    
    Returns the server's incrementingVersion.
    
    Specified by:
    
    getVersion in interface ClientSession
    
    Returns:
    
    the server's incrementingVersion
  - getMinLargeMessageSize
```
public int getMinLargeMessageSize()
```
    Specified by:
    
    getMinLargeMessageSize in interface ClientSessionInternal
  - isCompressLargeMessages
```
public boolean isCompressLargeMessages()
```
    Specified by:
    
    isCompressLargeMessages in interface ClientSessionInternal
  - isCacheLargeMessageClient
```
public boolean isCacheLargeMessageClient()
```
    Specified by:
    
    isCacheLargeMessageClient in interface ClientSessionInternal
    
    Returns:
    
    the cacheLargeMessageClient
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface ClientSessionInternal
  - acknowledge
```
public void acknowledge(long consumerID,
                        long messageID)
                 throws HornetQException
```
    Acknowledges all messages received by the consumer so far.
    
    Specified by:
    
    acknowledge in interface ClientSessionInternal
    
    Throws:
    
    HornetQException
  - individualAcknowledge
```
public void individualAcknowledge(long consumerID,
                                  long messageID)
                           throws HornetQException
```
    Specified by:
    
    individualAcknowledge in interface ClientSessionInternal
    
    Throws:
    
    HornetQException
  - expire
```
public void expire(long consumerID,
                   long messageID)
            throws HornetQException
```
    Specified by:
    
    expire in interface ClientSessionInternal
    
    Throws:
    
    HornetQException
  - addConsumer
```
public void addConsumer(ClientConsumerInternal consumer)
```
    Specified by:
    
    addConsumer in interface ClientSessionInternal
  - addProducer
```
public void addProducer(ClientProducerInternal producer)
```
    Specified by:
    
    addProducer in interface ClientSessionInternal
  - removeConsumer
```
public void removeConsumer(ClientConsumerInternal consumer)
                    throws HornetQException
```
    Specified by:
    
    removeConsumer in interface ClientSessionInternal
    
    Throws:
    
    HornetQException
  - removeProducer
```
public void removeProducer(ClientProducerInternal producer)
```
    Specified by:
    
    removeProducer in interface ClientSessionInternal
  - handleReceiveMessage
```
public void handleReceiveMessage(long consumerID,
                                 SessionReceiveMessage message)
                          throws Exception
```
    Specified by:
    
    handleReceiveMessage in interface ClientSessionInternal
    
    Throws:
    
    Exception
  - handleReceiveLargeMessage
```
public void handleReceiveLargeMessage(long consumerID,
                                      SessionReceiveLargeMessage message)
                               throws Exception
```
    Specified by:
    
    handleReceiveLargeMessage in interface ClientSessionInternal
    
    Throws:
    
    Exception
  - handleReceiveContinuation
```
public void handleReceiveContinuation(long consumerID,
                                      SessionReceiveContinuationMessage continuation)
                               throws Exception
```
    Specified by:
    
    handleReceiveContinuation in interface ClientSessionInternal
    
    Throws:
    
    Exception
  - handleConsumerDisconnect
```
public void handleConsumerDisconnect(long consumerID)
                              throws HornetQException
```
    Specified by:
    
    handleConsumerDisconnect in interface ClientSessionInternal
    
    Throws:
    
    HornetQException
  - close
```
public void close()
           throws HornetQException
```
    Description copied from interface: ClientSession
    
    Closes the session.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface ClientSession
    
    Throws:
    
    HornetQException - if an exception occurs while closing the session
  - cleanUp
```
public void cleanUp(boolean failingOver)
             throws HornetQException
```
    Specified by:
    
    cleanUp in interface ClientSessionInternal
    
    Throws:
    
    HornetQException
  - setSendAcknowledgementHandler
```
public void setSendAcknowledgementHandler(SendAcknowledgementHandler handler)
```
    Description copied from interface: ClientSession
    
    Sets a SendAcknowledgementHandler for this session.
    
    Specified by:
    
    setSendAcknowledgementHandler in interface ClientSession
    
    Parameters:
    
    handler - a SendAcknowledgementHandler
  - preHandleFailover
```
public void preHandleFailover(CoreRemotingConnection connection)
```
    Specified by:
    
    preHandleFailover in interface ClientSessionInternal
  - handleFailover
```
public void handleFailover(CoreRemotingConnection backupConnection,
                           HornetQException cause)
```
    Specified by:
    
    handleFailover in interface ClientSessionInternal
  - addMetaData
```
public void addMetaData(String key,
                        String data)
                 throws HornetQException
```
    Description copied from interface: ClientSession
    
    Attach any metadata to the session.
    
    Specified by:
    
    addMetaData in interface ClientSession
    
    Throws:
    
    HornetQException
  - addUniqueMetaData
```
public void addUniqueMetaData(String key,
                              String data)
                       throws HornetQException
```
    Description copied from interface: ClientSession
    
    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.
    
    Specified by:
    
    addUniqueMetaData in interface ClientSession
    
    Throws:
    
    HornetQException
  - getSessionFactory
```
public ClientSessionFactoryInternal getSessionFactory()
```
    Specified by:
    
    getSessionFactory in interface ClientSessionInternal
  - setAddress
```
public void setAddress(Message message,
                       SimpleString address)
```
    Specified by:
    
    setAddress in interface ClientSessionInternal
  - setPacketSize
```
public void setPacketSize(int packetSize)
```
    Specified by:
    
    setPacketSize in interface ClientSessionInternal
  - workDone
```
public void workDone()
```
    Specified by:
    
    workDone in interface ClientSessionInternal
  - returnBlocking
```
public void returnBlocking()
```
    Specified by:
    
    returnBlocking in interface ClientSessionInternal
  - sendProducerCreditsMessage
```
public void sendProducerCreditsMessage(int credits,
                                       SimpleString address)
```
    Specified by:
    
    sendProducerCreditsMessage in interface ClientSessionInternal
  - getCredits
```
public ClientProducerCredits getCredits(SimpleString address,
                                        boolean anon)
```
    Specified by:
    
    getCredits in interface ClientSessionInternal
  - returnCredits
```
public void returnCredits(SimpleString address)
```
    Specified by:
    
    returnCredits in interface ClientSessionInternal
  - handleReceiveProducerCredits
```
public void handleReceiveProducerCredits(SimpleString address,
                                         int credits)
```
    Specified by:
    
    handleReceiveProducerCredits in interface ClientSessionInternal
  - handleReceiveProducerFailCredits
```
public void handleReceiveProducerFailCredits(SimpleString address,
                                             int credits)
```
    Specified by:
    
    handleReceiveProducerFailCredits in interface ClientSessionInternal
  - getProducerCreditManager
```
public ClientProducerCreditManager getProducerCreditManager()
```
    Specified by:
    
    getProducerCreditManager in interface ClientSessionInternal
  - startCall
```
public void startCall()
```
    Description copied from interface: ClientSessionInternal
    
    This is used internally to control and educate the user about using the thread boundaries properly. if more than one thread is using the session simultaneously this will generate a big warning on the docs. There are a limited number of places where we can call this such as acks and sends. otherwise we could get false warns
    
    Specified by:
    
    startCall in interface ClientSessionInternal
  - endCall
```
public void endCall()
```
    Specified by:
    
    endCall in interface ClientSessionInternal
    
    See Also:
    
    ClientSessionInternal.startCall()
  - commandConfirmed
```
public void commandConfirmed(Packet packet)
```
    Description copied from interface: CommandConfirmationHandler
    
    called by channel after a confirmation has been received.
    
    Specified by:
    
    commandConfirmed in interface CommandConfirmationHandler
    
    Parameters:
    
    packet - the packet confirmed
  - commit
```
public void commit(Xid xid,
                   boolean onePhase)
            throws XAException
```
    Specified by:
    
    commit in interface XAResource
    
    Throws:
    
    XAException
  - end
```
public void end(Xid xid,
                int flags)
         throws XAException
```
    Specified by:
    
    end in interface XAResource
    
    Throws:
    
    XAException
  - forget
```
public void forget(Xid xid)
            throws XAException
```
    Specified by:
    
    forget in interface XAResource
    
    Throws:
    
    XAException
  - getTransactionTimeout
```
public int getTransactionTimeout()
                          throws XAException
```
    Specified by:
    
    getTransactionTimeout in interface XAResource
    
    Throws:
    
    XAException
  - isSameRM
```
public boolean isSameRM(XAResource xares)
                 throws XAException
```
    Specified by:
    
    isSameRM in interface XAResource
    
    Throws:
    
    XAException
  - prepare
```
public int prepare(Xid xid)
            throws XAException
```
    Specified by:
    
    prepare in interface XAResource
    
    Throws:
    
    XAException
  - recover
```
public Xid[] recover(int flags)
              throws XAException
```
    Specified by:
    
    recover in interface XAResource
    
    Throws:
    
    XAException
  - rollback
```
public void rollback(Xid xid)
              throws XAException
```
    Specified by:
    
    rollback in interface XAResource
    
    Throws:
    
    XAException
  - setTransactionTimeout
```
public boolean setTransactionTimeout(int seconds)
                              throws XAException
```
    Specified by:
    
    setTransactionTimeout in interface XAResource
    
    Throws:
    
    XAException
  - start
```
public void start(Xid xid,
                  int flags)
           throws XAException
```
    Specified by:
    
    start in interface XAResource
    
    Throws:
    
    XAException
  - connectionFailed
```
public void connectionFailed(HornetQException me,
                             boolean failedOver)
```
    Description copied from interface: FailureListener
    
    Notifies that a connection has failed due to the specified exception.
    
    Specified by:
    
    connectionFailed in interface FailureListener
    
    Parameters:
    
    me - exception which has caused the connection to fail
  - setForceNotSameRM
```
public void setForceNotSameRM(boolean force)
```
    Specified by:
    
    setForceNotSameRM in interface ClientSessionInternal
  - getConnection
```
public RemotingConnection getConnection()
```
    Specified by:
    
    getConnection in interface ClientSessionInternal
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - cloneProducers
```
public Set<ClientProducerInternal> cloneProducers()
```
    Not part of the interface, used on tests only
    
    Returns:
  - cloneConsumers
```
public Set<ClientConsumerInternal> cloneConsumers()
```
    Not part of the interface, used on tests only
    
    Returns:
  - setStopSignal
```
public void setStopSignal()
```
    Description copied from interface: ClientSessionInternal
    
    Sets a stop signal to true. This will cancel
    
    Specified by:
    
    setStopSignal in interface ClientSessionInternal
  - isConfirmationWindowEnabled
```
public boolean isConfirmationWindowEnabled()
```
    Specified by:
    
    isConfirmationWindowEnabled in interface ClientSessionInternal
  - scheduleConfirmation
```
public void scheduleConfirmation(SendAcknowledgementHandler handler,
                                 Message message)
```
    Specified by:
    
    scheduleConfirmation in interface ClientSessionInternal

Class ClientSessionImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.hornetq.api.core.client.ClientSession

Field Summary

Fields inherited from interface javax.transaction.xa.XAResource

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getChannel

createQueue

createQueue

createQueue

createSharedQueue

createSharedQueue

createQueue

createQueue

createTemporaryQueue

createTemporaryQueue

createTemporaryQueue

createTemporaryQueue

deleteQueue

deleteQueue

queueQuery

bindingQuery

forceDelivery

createConsumer

createConsumer

createConsumer

createQueue

createConsumer

createConsumer

createConsumer

createConsumer

createConsumer

createConsumer

createConsumer

createProducer

createProducer

createProducer

createProducer

createProducer

getXAResource

commit

isRollbackOnly

rollback

rollback

createMessage

createMessage

createMessage

isClosed

isAutoCommitSends

isAutoCommitAcks

isBlockOnAcknowledge

isXA

resetIfNeeded

start

stop

stop

addFailureListener

removeFailureListener

addFailoverListener

removeFailoverListener

getVersion

getMinLargeMessageSize

isCompressLargeMessages

isCacheLargeMessageClient

getName

acknowledge

individualAcknowledge

expire

addConsumer

addProducer

removeConsumer

removeProducer

handleReceiveMessage

handleReceiveLargeMessage

handleReceiveContinuation

handleConsumerDisconnect

close

cleanUp