org.hornetq.api.core.client

Interface ClientSession

All Superinterfaces:

AutoCloseable, XAResource

public interface ClientSession
extends XAResource, AutoCloseable

A ClientSession is a single-thread object required for producing and consuming messages.

Author:

Tim Fox, Clebert Suconic, Andy Taylor, Jeff Mesnil

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ClientSession.BindingQuery Information returned by a binding query
static interface	ClientSession.QueueQuery Information returned by a queue query

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

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.
void	addUniqueMetaData(String key, String data) Attach any metadata to the session.
ClientSession.BindingQuery	bindingQuery(org.hornetq.api.core.SimpleString address) Queries information on a binding.
void	close() Closes the session.
void	commit() Commits the current transaction.
ClientConsumer	createConsumer(org.hornetq.api.core.SimpleString queueName) Creates a ClientConsumer to consume message from the queue with the given name.
ClientConsumer	createConsumer(org.hornetq.api.core.SimpleString queueName, boolean browseOnly) Creates a ClientConsumer to consume or browse messages from the queue with the given name.
ClientConsumer	createConsumer(org.hornetq.api.core.SimpleString queueName, org.hornetq.api.core.SimpleString filter) Creates a ClientConsumer to consume messages matching the filter from the queue with the given name.
ClientConsumer	createConsumer(org.hornetq.api.core.SimpleString queueName, org.hornetq.api.core.SimpleString filter, boolean browseOnly) Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name.
ClientConsumer	createConsumer(org.hornetq.api.core.SimpleString queueName, org.hornetq.api.core.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(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(org.hornetq.api.core.SimpleString address) Creates a producer which sends messages to the given address
ClientProducer	createProducer(org.hornetq.api.core.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(org.hornetq.api.core.SimpleString address, org.hornetq.api.core.SimpleString queueName) Creates a non-temporary queue non-durable queue.
void	createQueue(org.hornetq.api.core.SimpleString address, org.hornetq.api.core.SimpleString queueName, boolean durable) Creates a non-temporary queue.
void	createQueue(org.hornetq.api.core.SimpleString address, org.hornetq.api.core.SimpleString queueName, org.hornetq.api.core.SimpleString filter, 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 filter, boolean durable) Creates a non-temporaryqueue.
void	createSharedQueue(org.hornetq.api.core.SimpleString address, org.hornetq.api.core.SimpleString queueName, boolean durable) Creates a transient queue.
void	createSharedQueue(org.hornetq.api.core.SimpleString address, org.hornetq.api.core.SimpleString queueName, org.hornetq.api.core.SimpleString filter, boolean durable) Creates a transient queue.
void	createTemporaryQueue(org.hornetq.api.core.SimpleString address, org.hornetq.api.core.SimpleString queueName) Creates a temporary queue.
void	createTemporaryQueue(org.hornetq.api.core.SimpleString address, org.hornetq.api.core.SimpleString queueName, org.hornetq.api.core.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(org.hornetq.api.core.SimpleString queueName) Deletes the queue.
void	deleteQueue(String queueName) Deletes the queue.
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(org.hornetq.api.core.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.
void	setSendAcknowledgementHandler(SendAcknowledgementHandler handler) Sets a SendAcknowledgementHandler for this session.
void	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

Method Detail

start

void start()
           throws org.hornetq.api.core.HornetQException

Starts the session. The session must be started before ClientConsumers created by the session can consume messages from the queue.

Throws:

org.hornetq.api.core.HornetQException - if an exception occurs while starting the session

stop

void stop()
          throws org.hornetq.api.core.HornetQException

Stops the session. ClientConsumers created by the session can not consume messages when the session is stopped.

Throws:

org.hornetq.api.core.HornetQException - if an exception occurs while stopping the session

close

void close()
           throws org.hornetq.api.core.HornetQException

Closes the session.

Specified by:

close in interface AutoCloseable

Throws:

org.hornetq.api.core.HornetQException - 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

createQueue

void createQueue(org.hornetq.api.core.SimpleString address,
               org.hornetq.api.core.SimpleString queueName,
               boolean durable)
                 throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - in an exception occurs while creating the queue

createSharedQueue

void createSharedQueue(org.hornetq.api.core.SimpleString address,
                     org.hornetq.api.core.SimpleString queueName,
                     boolean durable)
                       throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - in an exception occurs while creating the queue

createSharedQueue

void createSharedQueue(org.hornetq.api.core.SimpleString address,
                     org.hornetq.api.core.SimpleString queueName,
                     org.hornetq.api.core.SimpleString filter,
                     boolean durable)
                       throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - in an exception occurs while creating the queue

createQueue

void createQueue(String address,
               String queueName,
               boolean durable)
                 throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - in an exception occurs while creating the queue

createQueue

void createQueue(String address,
               String queueName)
                 throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - in an exception occurs while creating the queue

createQueue

void createQueue(org.hornetq.api.core.SimpleString address,
               org.hornetq.api.core.SimpleString queueName)
                 throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - in an exception occurs while creating the queue

createQueue

void createQueue(org.hornetq.api.core.SimpleString address,
               org.hornetq.api.core.SimpleString queueName,
               org.hornetq.api.core.SimpleString filter,
               boolean durable)
                 throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - in an exception occurs while creating the queue

createQueue

void createQueue(String address,
               String queueName,
               String filter,
               boolean durable)
                 throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - in an exception occurs while creating the queue

createTemporaryQueue

void createTemporaryQueue(org.hornetq.api.core.SimpleString address,
                        org.hornetq.api.core.SimpleString queueName)
                          throws org.hornetq.api.core.HornetQException

Creates a temporary queue.

Parameters:

address - the queue will be bound to this address

queueName - the name of the queue

Throws:

org.hornetq.api.core.HornetQException - in an exception occurs while creating the queue

createTemporaryQueue

void createTemporaryQueue(String address,
                        String queueName)
                          throws org.hornetq.api.core.HornetQException

Creates a temporary queue.

Parameters:

address - the queue will be bound to this address

queueName - the name of the queue

Throws:

org.hornetq.api.core.HornetQException - in an exception occurs while creating the queue

createTemporaryQueue

void createTemporaryQueue(org.hornetq.api.core.SimpleString address,
                        org.hornetq.api.core.SimpleString queueName,
                        org.hornetq.api.core.SimpleString filter)
                          throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - in an exception occurs while creating the queue

createTemporaryQueue

void createTemporaryQueue(String address,
                        String queueName,
                        String filter)
                          throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - in an exception occurs while creating the queue

deleteQueue

void deleteQueue(org.hornetq.api.core.SimpleString queueName)
                 throws org.hornetq.api.core.HornetQException

Deletes the queue.

Parameters:

queueName - the name of the queue to delete

Throws:

org.hornetq.api.core.HornetQException - if there is no queue for the given name or if the queue has consumers

deleteQueue

void deleteQueue(String queueName)
                 throws org.hornetq.api.core.HornetQException

Deletes the queue.

Parameters:

queueName - the name of the queue to delete

Throws:

org.hornetq.api.core.HornetQException - if there is no queue for the given name or if the queue has consumers

createConsumer

ClientConsumer createConsumer(org.hornetq.api.core.SimpleString queueName)
                              throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - if an exception occurs while creating the ClientConsumer

createConsumer

ClientConsumer createConsumer(String queueName)
                              throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - if an exception occurs while creating the ClientConsumer

createConsumer

ClientConsumer createConsumer(org.hornetq.api.core.SimpleString queueName,
                            org.hornetq.api.core.SimpleString filter)
                              throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - if an exception occurs while creating the ClientConsumer

createConsumer

ClientConsumer createConsumer(String queueName,
                            String filter)
                              throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - if an exception occurs while creating the ClientConsumer

createConsumer

ClientConsumer createConsumer(org.hornetq.api.core.SimpleString queueName,
                            boolean browseOnly)
                              throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - if an exception occurs while creating the ClientConsumer

createConsumer

ClientConsumer createConsumer(String queueName,
                            boolean browseOnly)
                              throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - if an exception occurs while creating the ClientConsumer

createConsumer

ClientConsumer createConsumer(String queueName,
                            String filter,
                            boolean browseOnly)
                              throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - if an exception occurs while creating the ClientConsumer

createConsumer

ClientConsumer createConsumer(org.hornetq.api.core.SimpleString queueName,
                            org.hornetq.api.core.SimpleString filter,
                            boolean browseOnly)
                              throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - if an exception occurs while creating the ClientConsumer

createConsumer

ClientConsumer createConsumer(org.hornetq.api.core.SimpleString queueName,
                            org.hornetq.api.core.SimpleString filter,
                            int windowSize,
                            int maxRate,
                            boolean browseOnly)
                              throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - if an exception occurs while creating the ClientConsumer

createConsumer

ClientConsumer createConsumer(String queueName,
                            String filter,
                            int windowSize,
                            int maxRate,
                            boolean browseOnly)
                              throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - if an exception occurs while creating the ClientConsumer

createProducer

ClientProducer createProducer()
                              throws org.hornetq.api.core.HornetQException

Creates a producer with no default address. Address must be specified every time a message is sent

Returns:

a ClientProducer

Throws:

org.hornetq.api.core.HornetQException

See Also:

ClientProducer.send(SimpleString, org.hornetq.api.core.Message)

createProducer

ClientProducer createProducer(org.hornetq.api.core.SimpleString address)
                              throws org.hornetq.api.core.HornetQException

Creates a producer which sends messages to the given address

Parameters:

address - the address to send messages to

Returns:

a ClientProducer

Throws:

org.hornetq.api.core.HornetQException - if an exception occurs while creating the ClientProducer

createProducer

ClientProducer createProducer(String address)
                              throws org.hornetq.api.core.HornetQException

Creates a producer which sends messages to the given address

Parameters:

address - the address to send messages to

Returns:

a ClientProducer

Throws:

org.hornetq.api.core.HornetQException - if an exception occurs while creating the ClientProducer

createProducer

ClientProducer createProducer(org.hornetq.api.core.SimpleString address,
                            int rate)
                              throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException - 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(org.hornetq.api.core.SimpleString queueName)
                                    throws org.hornetq.api.core.HornetQException

Queries information on a queue.

Parameters:

queueName - the name of the queue to query

Returns:

a QueueQuery containing information on the given queue

Throws:

org.hornetq.api.core.HornetQException - if an exception occurs while querying the queue

bindingQuery

ClientSession.BindingQuery bindingQuery(org.hornetq.api.core.SimpleString address)
                                        throws org.hornetq.api.core.HornetQException

Queries information on a binding.

Parameters:

address - the address of the biding to query

Returns:

a BindingQuery containing information on the binding attached to the given address

Throws:

org.hornetq.api.core.HornetQException - 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 org.hornetq.api.core.HornetQException

Commits the current transaction.

Throws:

org.hornetq.api.core.HornetQException - if an exception occurs while committing the transaction

rollback

void rollback()
              throws org.hornetq.api.core.HornetQException

Rolls back the current transaction.

Throws:

org.hornetq.api.core.HornetQException - if an exception occurs while rolling back the transaction

rollback

void rollback(boolean considerLastMessageAsDelivered)
              throws org.hornetq.api.core.HornetQException

Rolls back the current transaction.

Parameters:

considerLastMessageAsDelivered - the first message on deliveringMessage Buffer is considered as delivered

Throws:

org.hornetq.api.core.HornetQException - 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

void setSendAcknowledgementHandler(SendAcknowledgementHandler handler)

Sets a SendAcknowledgementHandler for this session.

Parameters:

handler - a SendAcknowledgementHandler

addMetaData

void addMetaData(String key,
               String data)
                 throws org.hornetq.api.core.HornetQException

Attach any metadata to the session.

Throws:

org.hornetq.api.core.HornetQException

addUniqueMetaData

void addUniqueMetaData(String key,
                     String data)
                       throws org.hornetq.api.core.HornetQException

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:

org.hornetq.api.core.HornetQException