Package org.apache.activemq.artemis.core.protocol.core.impl

Class ActiveMQSessionContext

java.lang.Object

org.apache.activemq.artemis.spi.core.remoting.SessionContext

org.apache.activemq.artemis.core.protocol.core.impl.ActiveMQSessionContext

Direct Known Subclasses:

HornetQClientSessionContext

public class ActiveMQSessionContext
extends SessionContext

Field Summary

Fields inherited from class org.apache.activemq.artemis.spi.core.remoting.SessionContext

idGenerator, remotingConnection, sendAckHandler, session

Constructor Summary

Constructors

Constructor	Description
ActiveMQSessionContext(String name, RemotingConnection remotingConnection, Channel sessionChannel, int serverVersion, int confirmationWindow)

Method Summary

Modifier and Type	Method	Description
ClientSession.AddressQuery	addressQuery(SimpleString address)
void	addSessionMetadata(String key, String data)
void	addUniqueMetaData(String key, String data)
protected int	calcWindowSize(int windowSize)
void	cleanup()
void	closeConsumer(ClientConsumer consumer)
boolean	configureTransactionTimeout(int seconds)
void	createAddress(SimpleString address, EnumSet<RoutingType> routingTypes, boolean autoCreated)
void	createAddress(SimpleString address, Set<RoutingType> routingTypes, boolean autoCreated)
ClientConsumerInternal	createConsumer(SimpleString queueName, SimpleString filterString, int priority, int windowSize, int maxRate, int ackBatchSize, boolean browseOnly, Executor executor, Executor flowControlExecutor)
void	createQueue(QueueConfiguration queueConfiguration)
void	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filterString, boolean durable, boolean temp, int maxConsumers, boolean purgeOnNoConsumers, boolean autoCreated)	Deprecated.
void	createQueue(SimpleString address, RoutingType routingType, SimpleString queueName, SimpleString filterString, boolean durable, boolean temp, int maxConsumers, boolean purgeOnNoConsumers, boolean autoCreated, Boolean exclusive, Boolean lastValue)	Deprecated.
void	createQueue(SimpleString address, SimpleString queueName, boolean temp, boolean autoCreated, QueueAttributes queueAttributes)	Deprecated.
void	createQueue(SimpleString address, SimpleString queueName, SimpleString filterString, boolean durable, boolean temp, boolean autoCreated)	Deprecated.
void	createSharedQueue(QueueConfiguration queueConfiguration)
void	createSharedQueue(SimpleString address, SimpleString queueName, QueueAttributes queueAttributes)	Deprecated.
void	createSharedQueue(SimpleString address, SimpleString queueName, RoutingType routingType, SimpleString filterString, boolean durable)	Deprecated.
void	createSharedQueue(SimpleString address, SimpleString queueName, RoutingType routingType, SimpleString filterString, boolean durable, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean lastValue)	Deprecated.
void	createSharedQueue(SimpleString address, SimpleString queueName, SimpleString filterString, boolean durable)	Deprecated.
void	deleteQueue(SimpleString queueName)
void	expireMessage(ClientConsumer consumer, Message message)
void	forceDelivery(ClientConsumer consumer, long sequence)
protected int	getConfirmationWindow()
int	getCreditsOnSendingFull(Message msgI)
int	getDefaultConsumerWindowSize(SessionQueueQueryResponseMessage response)
protected String	getName()
int	getReconnectID()
SendAcknowledgementHandler	getSendAcknowledgementHandler()
int	getServerVersion()
Channel	getSessionChannel()
protected void	handleReceiveProducerCredits(SessionProducerCreditsMessage message)
protected void	handleReceiveProducerFailCredits(SessionProducerCreditsFailMessage message)
protected void	handleReceiveSlowConsumerKillMessage(DisconnectConsumerWithKillMessage message)
boolean	isKilled()
boolean	isWritable(ReadyListener callback)
void	kill()
void	linkFlowControl(SimpleString address, ClientProducerCredits clientProducerCredits)
void	lockCommunications()	it will lock the communication channel of the session avoiding anything to come while failover is happening.
protected ClassLoader	lookupTCCL()
protected CreateSessionMessage	newCreateSession(String username, String password, int minLargeMessageSize, boolean xa, boolean autoCommitSends, boolean autoCommitAcks, boolean preAcknowledge)
ClientSession.QueueQuery	queueQuery(SimpleString queueName)
boolean	reattachOnNewConnection(RemotingConnection newConnection)	it will either reattach or reconnect, preferably reattaching it.
int	recoverSessionTimeout()	Performs a round trip to the server requesting what is the current tx timeout on the session
void	recreateConsumerOnServer(ClientConsumerInternal consumerInternal, long consumerId, boolean isSessionStarted)
void	recreateSession(String username, String password, int minLargeMessageSize, boolean xa, boolean autoCommitSends, boolean autoCommitAcks, boolean preAcknowledge)
void	releaseCommunications()
void	resetMetadata(HashMap<String,String> metaDataToSend)
void	resetName(String name)
void	restartSession()
void	returnBlocking(ActiveMQException cause)	Interrupt and return any blocked calls
void	sendACK(boolean individual, boolean block, ClientConsumer consumer, Message message)
void	sendConsumerCredits(ClientConsumer consumer, int credits)
void	sendFullMessage(ICoreMessage msgI, boolean sendBlocking, SendAcknowledgementHandler handler, SimpleString defaultAddress)
int	sendInitialChunkOnLargeMessage(Message msgI)	it should return the number of credits (or bytes) used to send this packet
int	sendLargeMessageChunk(Message msgI, long messageBodySize, boolean sendBlocking, boolean lastChunk, byte[] chunk, int reconnectID, SendAcknowledgementHandler messageHandler)
void	sendProducerCreditsMessage(int credits, SimpleString address)
int	sendServerLargeMessageChunk(Message msgI, long messageBodySize, boolean sendBlocking, boolean lastChunk, byte[] chunk, SendAcknowledgementHandler messageHandler)
void	sessionClose()
void	sessionStart()
void	sessionStop()
void	setSendAcknowledgementHandler(SendAcknowledgementHandler handler)
void	simpleCommit()
void	simpleCommit(boolean block)
void	simpleRollback(boolean lastMessageAsDelivered)	If we are doing a simple rollback on the RA, we need to ack the last message sent to the consumer, otherwise DLQ won't work.
boolean	supportsLargeMessage()	ActiveMQ Artemis does support large messages
void	transferConnection(RemotingConnection newConnection)	Transfers the session context to the given newConnection on the client-side
void	xaCommit(Xid xid, boolean onePhase)
void	xaEnd(Xid xid, int flags)
void	xaFailed(Xid xid)
void	xaForget(Xid xid)
int	xaPrepare(Xid xid)
void	xaRollback(Xid xid, boolean wasStarted)
Xid[]	xaScan()
void	xaStart(Xid xid, int flags)

Methods inherited from class org.apache.activemq.artemis.spi.core.remoting.SessionContext

getRemotingConnection, getSession, handleReceiveContinuation, handleReceiveLargeMessage, handleReceiveMessage, handleReceiveProducerCredits, handleReceiveProducerFailCredits, setSession

Methods inherited from class java.lang.Object

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

Constructor Detail

ActiveMQSessionContext

public ActiveMQSessionContext(String name,
                              RemotingConnection remotingConnection,
                              Channel sessionChannel,
                              int serverVersion,
                              int confirmationWindow)

Method Detail

getSessionChannel

public Channel getSessionChannel()

getName

protected String getName()

resetName

public void resetName(String name)

Specified by:

resetName in class SessionContext

getConfirmationWindow

protected int getConfirmationWindow()

getReconnectID

public int getReconnectID()

Specified by:

getReconnectID in class SessionContext

isKilled

public boolean isKilled()

kill

public void kill()

returnBlocking

public void returnBlocking(ActiveMQException cause)

Description copied from class: SessionContext

Interrupt and return any blocked calls

Specified by:

returnBlocking in class SessionContext

lockCommunications

public void lockCommunications()

Description copied from class: SessionContext

it will lock the communication channel of the session avoiding anything to come while failover is happening. It happens on preFailover from ClientSessionImpl

Specified by:

lockCommunications in class SessionContext

releaseCommunications

public void releaseCommunications()

Specified by:

releaseCommunications in class SessionContext

cleanup

public void cleanup()

Specified by:

cleanup in class SessionContext

linkFlowControl

public void linkFlowControl(SimpleString address,
                            ClientProducerCredits clientProducerCredits)

Specified by:

linkFlowControl in class SessionContext

setSendAcknowledgementHandler

public void setSendAcknowledgementHandler(SendAcknowledgementHandler handler)

Specified by:

setSendAcknowledgementHandler in class SessionContext

getSendAcknowledgementHandler

public SendAcknowledgementHandler getSendAcknowledgementHandler()

Specified by:

getSendAcknowledgementHandler in class SessionContext

createSharedQueue

@Deprecated
public void createSharedQueue(SimpleString address,
                              SimpleString queueName,
                              RoutingType routingType,
                              SimpleString filterString,
                              boolean durable,
                              Integer maxConsumers,
                              Boolean purgeOnNoConsumers,
                              Boolean exclusive,
                              Boolean lastValue)
                       throws ActiveMQException

Deprecated.

Description copied from class: SessionContext

Creates a shared queue using the routing type set by the Address. If the Address supports more than one type of delivery then the default delivery mode (MULTICAST) is used.

Specified by:

createSharedQueue in class SessionContext

Throws:

ActiveMQException

createSharedQueue

@Deprecated
public void createSharedQueue(SimpleString address,
                              SimpleString queueName,
                              QueueAttributes queueAttributes)
                       throws ActiveMQException

Deprecated.

Description copied from class: SessionContext

Creates a shared queue using the routing type set by the Address. If the Address supports more than one type of delivery then the default delivery mode (MULTICAST) is used.

Specified by:

createSharedQueue in class SessionContext

Throws:

ActiveMQException

createSharedQueue

public void createSharedQueue(QueueConfiguration queueConfiguration)
                       throws ActiveMQException

Specified by:

createSharedQueue in class SessionContext

Throws:

ActiveMQException

createSharedQueue

@Deprecated
public void createSharedQueue(SimpleString address,
                              SimpleString queueName,
                              RoutingType routingType,
                              SimpleString filterString,
                              boolean durable)
                       throws ActiveMQException

Deprecated.

Specified by:

createSharedQueue in class SessionContext

Throws:

ActiveMQException

createSharedQueue

@Deprecated
public void createSharedQueue(SimpleString address,
                              SimpleString queueName,
                              SimpleString filterString,
                              boolean durable)
                       throws ActiveMQException

Deprecated.

Specified by:

createSharedQueue in class SessionContext

Throws:

ActiveMQException

deleteQueue

public void deleteQueue(SimpleString queueName)
                 throws ActiveMQException

Specified by:

deleteQueue in class SessionContext

Throws:

ActiveMQException

queueQuery

public ClientSession.QueueQuery queueQuery(SimpleString queueName)
                                    throws ActiveMQException

Specified by:

queueQuery in class SessionContext

Throws:

ActiveMQException

isWritable

public boolean isWritable(ReadyListener callback)

Specified by:

isWritable in class SessionContext

createConsumer

public ClientConsumerInternal createConsumer(SimpleString queueName,
                                             SimpleString filterString,
                                             int priority,
                                             int windowSize,
                                             int maxRate,
                                             int ackBatchSize,
                                             boolean browseOnly,
                                             Executor executor,
                                             Executor flowControlExecutor)
                                      throws ActiveMQException

Specified by:

createConsumer in class SessionContext

Throws:

ActiveMQException

getServerVersion

public int getServerVersion()

Specified by:

getServerVersion in class SessionContext

addressQuery

public ClientSession.AddressQuery addressQuery(SimpleString address)
                                        throws ActiveMQException

Specified by:

addressQuery in class SessionContext

Throws:

ActiveMQException

closeConsumer

public void closeConsumer(ClientConsumer consumer)
                   throws ActiveMQException

Specified by:

closeConsumer in class SessionContext

Throws:

ActiveMQException

sendConsumerCredits

public void sendConsumerCredits(ClientConsumer consumer,
                                int credits)

Specified by:

sendConsumerCredits in class SessionContext

forceDelivery

public void forceDelivery(ClientConsumer consumer,
                          long sequence)
                   throws ActiveMQException

Specified by:

forceDelivery in class SessionContext

Throws:

ActiveMQException

simpleCommit

public void simpleCommit()
                  throws ActiveMQException

Specified by:

simpleCommit in class SessionContext

Throws:

ActiveMQException

simpleCommit

public void simpleCommit(boolean block)
                  throws ActiveMQException

Specified by:

simpleCommit in class SessionContext

Throws:

ActiveMQException

simpleRollback

public void simpleRollback(boolean lastMessageAsDelivered)
                    throws ActiveMQException

Description copied from class: SessionContext

If we are doing a simple rollback on the RA, we need to ack the last message sent to the consumer, otherwise DLQ won't work.

this is because we only ACK after on the RA, We may review this if we always acked earlier.

Specified by:

simpleRollback in class SessionContext

Throws:

ActiveMQException

sessionStart

public void sessionStart()
                  throws ActiveMQException

Specified by:

sessionStart in class SessionContext

Throws:

ActiveMQException

sessionStop

public void sessionStop()
                 throws ActiveMQException

Specified by:

sessionStop in class SessionContext

Throws:

ActiveMQException

addSessionMetadata

public void addSessionMetadata(String key,
                               String data)
                        throws ActiveMQException

Specified by:

addSessionMetadata in class SessionContext

Throws:

ActiveMQException

addUniqueMetaData

public void addUniqueMetaData(String key,
                              String data)
                       throws ActiveMQException

Specified by:

addUniqueMetaData in class SessionContext

Throws:

ActiveMQException

xaCommit

public void xaCommit(Xid xid,
                     boolean onePhase)
              throws XAException,
                     ActiveMQException

Specified by:

xaCommit in class SessionContext

Throws:

XAException

ActiveMQException

xaEnd

public void xaEnd(Xid xid,
                  int flags)
           throws XAException,
                  ActiveMQException

Specified by:

xaEnd in class SessionContext

Throws:

XAException

ActiveMQException

sendProducerCreditsMessage

public void sendProducerCreditsMessage(int credits,
                                       SimpleString address)

Specified by:

sendProducerCreditsMessage in class SessionContext

supportsLargeMessage

public boolean supportsLargeMessage()

ActiveMQ Artemis does support large messages

Specified by:

supportsLargeMessage in class SessionContext

Returns:

getCreditsOnSendingFull

public int getCreditsOnSendingFull(Message msgI)

Specified by:

getCreditsOnSendingFull in class SessionContext

sendFullMessage

public void sendFullMessage(ICoreMessage msgI,
                            boolean sendBlocking,
                            SendAcknowledgementHandler handler,
                            SimpleString defaultAddress)
                     throws ActiveMQException

Specified by:

sendFullMessage in class SessionContext

Throws:

ActiveMQException

sendInitialChunkOnLargeMessage

public int sendInitialChunkOnLargeMessage(Message msgI)
                                   throws ActiveMQException

Description copied from class: SessionContext

it should return the number of credits (or bytes) used to send this packet

Specified by:

sendInitialChunkOnLargeMessage in class SessionContext

Returns:

Throws:

ActiveMQException

sendLargeMessageChunk

public int sendLargeMessageChunk(Message msgI,
                                 long messageBodySize,
                                 boolean sendBlocking,
                                 boolean lastChunk,
                                 byte[] chunk,
                                 int reconnectID,
                                 SendAcknowledgementHandler messageHandler)
                          throws ActiveMQException

Specified by:

sendLargeMessageChunk in class SessionContext

Throws:

ActiveMQException

sendServerLargeMessageChunk

public int sendServerLargeMessageChunk(Message msgI,
                                       long messageBodySize,
                                       boolean sendBlocking,
                                       boolean lastChunk,
                                       byte[] chunk,
                                       SendAcknowledgementHandler messageHandler)
                                throws ActiveMQException

Specified by:

sendServerLargeMessageChunk in class SessionContext

Throws:

ActiveMQException

sendACK

public void sendACK(boolean individual,
                    boolean block,
                    ClientConsumer consumer,
                    Message message)
             throws ActiveMQException

Specified by:

sendACK in class SessionContext

Throws:

ActiveMQException

expireMessage

public void expireMessage(ClientConsumer consumer,
                          Message message)
                   throws ActiveMQException

Specified by:

expireMessage in class SessionContext

Throws:

ActiveMQException

sessionClose

public void sessionClose()
                  throws ActiveMQException

Specified by:

sessionClose in class SessionContext

Throws:

ActiveMQException

xaForget

public void xaForget(Xid xid)
              throws XAException,
                     ActiveMQException

Specified by:

xaForget in class SessionContext

Throws:

XAException

ActiveMQException

xaPrepare

public int xaPrepare(Xid xid)
              throws XAException,
                     ActiveMQException

Specified by:

xaPrepare in class SessionContext

Throws:

XAException

ActiveMQException

xaScan

public Xid[] xaScan()
             throws ActiveMQException

Specified by:

xaScan in class SessionContext

Throws:

ActiveMQException

xaRollback

public void xaRollback(Xid xid,
                       boolean wasStarted)
                throws ActiveMQException,
                       XAException

Specified by:

xaRollback in class SessionContext

Throws:

ActiveMQException

XAException

xaStart

public void xaStart(Xid xid,
                    int flags)
             throws XAException,
                    ActiveMQException

Specified by:

xaStart in class SessionContext

Throws:

XAException

ActiveMQException

configureTransactionTimeout

public boolean configureTransactionTimeout(int seconds)
                                    throws ActiveMQException

Specified by:

configureTransactionTimeout in class SessionContext

Throws:

ActiveMQException

recoverSessionTimeout

public int recoverSessionTimeout()
                          throws ActiveMQException

Description copied from class: SessionContext

Performs a round trip to the server requesting what is the current tx timeout on the session

Specified by:

recoverSessionTimeout in class SessionContext

Returns:

Throws:

ActiveMQException

createAddress

public void createAddress(SimpleString address,
                          Set<RoutingType> routingTypes,
                          boolean autoCreated)
                   throws ActiveMQException

Specified by:

createAddress in class SessionContext

Throws:

ActiveMQException

createAddress

public void createAddress(SimpleString address,
                          EnumSet<RoutingType> routingTypes,
                          boolean autoCreated)
                   throws ActiveMQException

Specified by:

createAddress in class SessionContext

Throws:

ActiveMQException

createQueue

@Deprecated
public void createQueue(SimpleString address,
                        SimpleString queueName,
                        SimpleString filterString,
                        boolean durable,
                        boolean temp,
                        boolean autoCreated)
                 throws ActiveMQException

Deprecated.

Specified by:

createQueue in class SessionContext

Throws:

ActiveMQException

createQueue

@Deprecated
public void createQueue(SimpleString address,
                        SimpleString queueName,
                        boolean temp,
                        boolean autoCreated,
                        QueueAttributes queueAttributes)
                 throws ActiveMQException

Deprecated.

Specified by:

createQueue in class SessionContext

Throws:

ActiveMQException

createQueue

@Deprecated
public void createQueue(SimpleString address,
                        RoutingType routingType,
                        SimpleString queueName,
                        SimpleString filterString,
                        boolean durable,
                        boolean temp,
                        int maxConsumers,
                        boolean purgeOnNoConsumers,
                        boolean autoCreated,
                        Boolean exclusive,
                        Boolean lastValue)
                 throws ActiveMQException

Deprecated.

Specified by:

createQueue in class SessionContext

Throws:

ActiveMQException

createQueue

@Deprecated
public void createQueue(SimpleString address,
                        RoutingType routingType,
                        SimpleString queueName,
                        SimpleString filterString,
                        boolean durable,
                        boolean temp,
                        int maxConsumers,
                        boolean purgeOnNoConsumers,
                        boolean autoCreated)
                 throws ActiveMQException

Deprecated.

Specified by:

createQueue in class SessionContext

Throws:

ActiveMQException

createQueue

public void createQueue(QueueConfiguration queueConfiguration)
                 throws ActiveMQException

Specified by:

createQueue in class SessionContext

Throws:

ActiveMQException

transferConnection

public void transferConnection(RemotingConnection newConnection)

Description copied from class: SessionContext

Transfers the session context to the given newConnection on the client-side

Specified by:

transferConnection in class SessionContext

reattachOnNewConnection

public boolean reattachOnNewConnection(RemotingConnection newConnection)
                                throws ActiveMQException

Description copied from class: SessionContext

it will either reattach or reconnect, preferably reattaching it.

Specified by:

reattachOnNewConnection in class SessionContext

Returns:

true if it was possible to reattach

Throws:

ActiveMQException

recreateSession

public void recreateSession(String username,
                            String password,
                            int minLargeMessageSize,
                            boolean xa,
                            boolean autoCommitSends,
                            boolean autoCommitAcks,
                            boolean preAcknowledge)
                     throws ActiveMQException

Specified by:

recreateSession in class SessionContext

Throws:

ActiveMQException

newCreateSession

protected CreateSessionMessage newCreateSession(String username,
                                                String password,
                                                int minLargeMessageSize,
                                                boolean xa,
                                                boolean autoCommitSends,
                                                boolean autoCommitAcks,
                                                boolean preAcknowledge)

recreateConsumerOnServer

public void recreateConsumerOnServer(ClientConsumerInternal consumerInternal,
                                     long consumerId,
                                     boolean isSessionStarted)
                              throws ActiveMQException

Specified by:

recreateConsumerOnServer in class SessionContext

Throws:

ActiveMQException

xaFailed

public void xaFailed(Xid xid)
              throws ActiveMQException

Specified by:

xaFailed in class SessionContext

Throws:

ActiveMQException

restartSession

public void restartSession()
                    throws ActiveMQException

Specified by:

restartSession in class SessionContext

Throws:

ActiveMQException

resetMetadata

public void resetMetadata(HashMap<String,String> metaDataToSend)

Specified by:

resetMetadata in class SessionContext

getDefaultConsumerWindowSize

public int getDefaultConsumerWindowSize(SessionQueueQueryResponseMessage response)
                                 throws ActiveMQException

Specified by:

getDefaultConsumerWindowSize in class SessionContext

Throws:

ActiveMQException

handleReceiveProducerCredits

protected void handleReceiveProducerCredits(SessionProducerCreditsMessage message)

handleReceiveProducerFailCredits

protected void handleReceiveProducerFailCredits(SessionProducerCreditsFailMessage message)

handleReceiveSlowConsumerKillMessage

protected void handleReceiveSlowConsumerKillMessage(DisconnectConsumerWithKillMessage message)

lookupTCCL

protected ClassLoader lookupTCCL()

calcWindowSize

protected int calcWindowSize(int windowSize)