org.hornetq.core.client.impl

Class DelegatingSession

java.lang.Object

org.hornetq.core.client.impl.DelegatingSession

All Implemented Interfaces:

XAResource, ClientSession, ClientSessionInternal

public class DelegatingSession
extends Object
implements ClientSessionInternal

A DelegatingSession

We wrap the real session, so we can add a finalizer on this and close the session on GC if it has not already been closed

Author:

Tim Fox

Nested Class Summary

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

ClientSession.BindingQuery, ClientSession.QueueQuery

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	debug

Fields inherited from interface javax.transaction.xa.XAResource

TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

Constructor Summary

Constructors

Constructor and Description
DelegatingSession(ClientSessionInternal session)

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledge(long consumerID, long messageID)
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	checkDefaultAddress(SimpleString address)
void	cleanUp(boolean failingOver)
void	close() Closes the session.
void	commit() Commits the current transaction.
void	commit(Xid xid, boolean onePhase) Commit the work done on this resource in the given transaction.
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) 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 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 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(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	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.
static void	dumpSessionCreationStacks()
void	end(Xid xid, int flags) Called to disassociate the resource from a transaction.
void	endCall()
void	expire(long consumerID, long messageID)
protected void	finalize()
void	forceDelivery(long consumerID, long sequence)
void	forget(Xid xid) Tells the resource manager to forget about a heuristic decision.
Channel	getChannel()
RemotingConnection	getConnection()
ClientProducerCredits	getCredits(SimpleString address, boolean anon)
int	getMinLargeMessageSize()
String	getName()
ClientProducerCreditManager	getProducerCreditManager()
ClientSessionFactoryInternal	getSessionFactory()
int	getTransactionTimeout() Get the current transaction timeout value for this resource.
int	getVersion() Returns the server's incrementingVersion.
XAResource	getXAResource() Returns the XAResource associated to the session.
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	isRollbackOnly() Returns true if the current transaction has been flagged to rollback, false else.
boolean	isSameRM(XAResource xares) Tells the caller if this resource has the same resource manager as the argument resource.
boolean	isXA() Return true if the session supports XA, false else.
void	markRollbackOnly()
void	preHandleFailover(CoreRemotingConnection connection)
int	prepare(Xid xid) Prepare to commit the work done on this resource in the given transaction.
ClientSession.QueueQuery	queueQuery(SimpleString queueName) Queries information on a queue.
Xid[]	recover(int flag) Return a list of transactions that are in a prepared or heuristically state.
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 considerLastMessageAsDelivered) Rolls back the current transaction.
void	rollback(Xid xid) Roll back the work done on this resource in the given transaction.
void	sendProducerCreditsMessage(int credits, SimpleString address)
void	setAddress(Message message, SimpleString address) This will set the address at the message
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) Set the transaction timeout value for this resource.
void	start() Starts the session.
void	start(Xid xid, int flags) Called to associate the resource with a transaction.
void	startCall() This is used internally to control and educate the user about using the thread boundaries properly.
void	stop() Stops the session.
String	toString()
void	workDone()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

debug

public static volatile boolean debug

Constructor Detail

DelegatingSession

public DelegatingSession(ClientSessionInternal session)

Method Detail

dumpSessionCreationStacks

public static void dumpSessionCreationStacks()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

checkDefaultAddress

public void checkDefaultAddress(SimpleString address)

Specified by:

checkDefaultAddress in interface ClientSessionInternal

acknowledge

public void acknowledge(long consumerID,
               long messageID)
                 throws HornetQException

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

addConsumer

public void addConsumer(ClientConsumerInternal consumer)

Specified by:

addConsumer in interface ClientSessionInternal

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

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

addProducer

public void addProducer(ClientProducerInternal producer)

Specified by:

addProducer in interface ClientSessionInternal

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

cleanUp

public void cleanUp(boolean failingOver)
             throws HornetQException

Specified by:

cleanUp in interface ClientSessionInternal

Throws:

HornetQException

close

public void close()
           throws HornetQException

Description copied from interface: ClientSession

Closes the session.

Specified by:

close in interface ClientSession

Throws:

HornetQException - if an exception occurs while closing the session

markRollbackOnly

public void markRollbackOnly()

Specified by:

markRollbackOnly in interface ClientSessionInternal

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

commit

public void commit(Xid xid,
          boolean onePhase)
            throws XAException

Description copied from interface: XAResource

Commit the work done on this resource in the given transaction. If the onePhase argument is true, one-phase optimization is being used, and the prepare method must not have been called for this transaction. Otherwise, this is the second phase of the two-phase commit protocol.

Specified by:

commit in interface XAResource

Parameters:

xid - The id of the transaction to commit work for.

onePhase - If true, the transaction manager is using one-phase optimization.

Throws:

XAException - If an error occurred.

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

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

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,
                            SimpleString 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

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

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,
                            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,
                            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

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(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,
                            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,
                            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

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,
                            int rate)
                              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

rate - the producer rate

Returns:

a ClientProducer

Throws:

HornetQException - if an exception occurs while creating the ClientProducer

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

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

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(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,
               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,
               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,
                        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(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,
                        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

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

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

end

public void end(Xid xid,
       int flags)
         throws XAException

Description copied from interface: XAResource

Called to disassociate the resource from a transaction. If the flags argument is XAResource.TMSUCCESS, the portion of work was done sucessfully. If the flags argument is XAResource.TMFAIL, the portion of work failed. The resource manager may mark the transaction for rollback only to avoid the transaction being committed. If the flags argument is XAResource.TMSUSPEND the resource will temporarily suspend the transaction association. The transaction must later be re-associated by giving the XAResource.TMRESUME flag to the start method.

Specified by:

end in interface XAResource

Parameters:

xid - The id of the transaction to disassociate from.

flags - Must be either XAResource.TMSUCCESS, XAResource.TMFAIL or XAResource.TMSUSPEND.

Throws:

XAException - If an error occurred.

expire

public void expire(long consumerID,
          long messageID)
            throws HornetQException

Specified by:

expire in interface ClientSessionInternal

Throws:

HornetQException

forget

public void forget(Xid xid)
            throws XAException

Description copied from interface: XAResource

Tells the resource manager to forget about a heuristic decision.

Specified by:

forget in interface XAResource

Parameters:

xid - The id of the transaction that was ended with a heuristic decision.

Throws:

XAException - If an error occurred.

getConnection

public RemotingConnection getConnection()

Specified by:

getConnection in interface ClientSessionInternal

getMinLargeMessageSize

public int getMinLargeMessageSize()

Specified by:

getMinLargeMessageSize in interface ClientSessionInternal

getName

public String getName()

Specified by:

getName in interface ClientSessionInternal

getTransactionTimeout

public int getTransactionTimeout()
                          throws XAException

Description copied from interface: XAResource

Get the current transaction timeout value for this resource.

Specified by:

getTransactionTimeout in interface XAResource

Returns:

The current timeout value, in seconds.

Throws:

XAException - If an error occurred.

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

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

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

handleReceiveContinuation

public void handleReceiveContinuation(long consumerID,
                             SessionReceiveContinuationMessage continuation)
                               throws Exception

Specified by:

handleReceiveContinuation in interface ClientSessionInternal

Throws:

Exception

handleReceiveLargeMessage

public void handleReceiveLargeMessage(long consumerID,
                             SessionReceiveLargeMessage message)
                               throws Exception

Specified by:

handleReceiveLargeMessage in interface ClientSessionInternal

Throws:

Exception

handleReceiveMessage

public void handleReceiveMessage(long consumerID,
                        SessionReceiveMessage message)
                          throws Exception

Specified by:

handleReceiveMessage in interface ClientSessionInternal

Throws:

Exception

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

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

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

isCacheLargeMessageClient

public boolean isCacheLargeMessageClient()

Specified by:

isCacheLargeMessageClient in interface ClientSessionInternal

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

isSameRM

public boolean isSameRM(XAResource xares)
                 throws XAException

Description copied from interface: XAResource

Tells the caller if this resource has the same resource manager as the argument resource. The transaction manager needs this method to be able to decide if the start method should be given the XAResource.TMJOIN flag.

Specified by:

isSameRM in interface XAResource

Throws:

XAException - If an error occurred.

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.

prepare

public int prepare(Xid xid)
            throws XAException

Description copied from interface: XAResource

Prepare to commit the work done on this resource in the given transaction. This method cannot return a status indicating that the transaction should be rolled back. If the resource wants the transaction to be rolled back, it should throw an XAException at the caller.

Specified by:

prepare in interface XAResource

Parameters:

xid - The id of the transaction to prepare to commit work for.

Returns:

Either XAResource.XA_OK or XAResource.XA_RDONLY.

Throws:

XAException - If an error occurred.

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

recover

public Xid[] recover(int flag)
              throws XAException

Description copied from interface: XAResource

Return a list of transactions that are in a prepared or heuristically state. This method looks not only at the resource it is invoked on, but also on all other resources managed by the same resource manager. It is intended to be used by the application server when recovering after a server crash.

A recovery scan is done with one or more calls to this method. At the first call, XAResource.TMSTARTRSCAN must be in the flag argument to indicate that the scan should be started. During the recovery scan, the resource manager maintains an internal cursor that keeps track of the progress of the recovery scan. To end the recovery scan, the XAResource.TMENDRSCAN must be passed in the flag argument.

Specified by:

recover in interface XAResource

Parameters:

flag - Must be either XAResource.TMNOFLAGS, XAResource.TMSTARTRSCAN, XAResource.TMENDRSCAN or TMSTARTRSCAN|TMENDRSCAN.

Returns:

An array of zero or more transaction ids.

Throws:

XAException - If an error occurred.

removeConsumer

public void removeConsumer(ClientConsumerInternal consumer)
                    throws HornetQException

Specified by:

removeConsumer in interface ClientSessionInternal

Throws:

HornetQException

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

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

removeProducer

public void removeProducer(ClientProducerInternal producer)

Specified by:

removeProducer in interface ClientSessionInternal

returnBlocking

public void returnBlocking()

Specified by:

returnBlocking in interface ClientSessionInternal

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

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(boolean considerLastMessageAsDelivered)
              throws HornetQException

Description copied from interface: ClientSession

Rolls back the current transaction.

Specified by:

rollback in interface ClientSession

Parameters:

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

Throws:

HornetQException - if an exception occurs while rolling back the transaction

rollback

public void rollback(Xid xid)
              throws XAException

Description copied from interface: XAResource

Roll back the work done on this resource in the given transaction.

Specified by:

rollback in interface XAResource

Parameters:

xid - The id of the transaction to commit work for.

Throws:

XAException - If an error occurred.

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

setTransactionTimeout

public boolean setTransactionTimeout(int seconds)
                              throws XAException

Description copied from interface: XAResource

Set the transaction timeout value for this resource. If the seconds argument is 0, the timeout value is set to the default timeout value of the resource manager. Not all resource managers support setting the timeout value. If the resource manager does not support setting the timeout value, it should return false.

Specified by:

setTransactionTimeout in interface XAResource

Parameters:

seconds - The timeout value, in seconds.

Returns:

True if the timeout value could be set, otherwise false.

Throws:

XAException - If an error occurred.

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

start

public void start(Xid xid,
         int flags)
           throws XAException

Description copied from interface: XAResource

Called to associate the resource with a transaction. If the flags argument is XAResource.TMNOFLAGS, the transaction must not previously have been seen by this resource manager, or an XAException with error code XAER_DUPID will be thrown. If the flags argument is XAResource.TMJOIN, the resource will join a transaction previously seen by tis resource manager. If the flags argument is XAResource.TMRESUME the resource will resume the transaction association that was suspended with end(TMSUSPEND).

Specified by:

start in interface XAResource

Parameters:

xid - The id of the transaction to associate with.

flags - Must be either XAResource.TMNOFLAGS, XAResource.TMJOIN or XAResource.TMRESUME.

Throws:

XAException - If an error occurred.

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

getSessionFactory

public ClientSessionFactoryInternal getSessionFactory()

Specified by:

getSessionFactory in interface ClientSessionInternal

setForceNotSameRM

public void setForceNotSameRM(boolean force)

Specified by:

setForceNotSameRM in interface ClientSessionInternal

workDone

public void workDone()

Specified by:

workDone 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

setAddress

public void setAddress(Message message,
              SimpleString address)

Description copied from interface: ClientSessionInternal

This will set the address at the message

Specified by:

setAddress in interface ClientSessionInternal

setPacketSize

public void setPacketSize(int packetSize)

Specified by:

setPacketSize 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

isCompressLargeMessages

public boolean isCompressLargeMessages()

Specified by:

isCompressLargeMessages in interface ClientSessionInternal

toString

public String toString()

Overrides:

toString in class Object

getChannel

public Channel getChannel()

Specified by:

getChannel in interface ClientSessionInternal

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

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()

setStopSignal

public void setStopSignal()

Description copied from interface: ClientSessionInternal

Sets a stop signal to true. This will cancel

Specified by:

setStopSignal in interface ClientSessionInternal