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

Interface ClientSessionInternal

All Superinterfaces:

AutoCloseable, ClientSession, XAResource

All Known Implementing Classes:

ClientSessionImpl

public interface ClientSessionInternal
extends ClientSession

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.activemq.artemis.api.core.client.ClientSession

ClientSession.AddressQuery, ClientSession.QueueQuery

Field Summary

Fields inherited from interface org.apache.activemq.artemis.api.core.client.ClientSession

JMS_SESSION_CLIENT_ID_PROPERTY, JMS_SESSION_IDENTIFIER_PROPERTY

Fields inherited from interface javax.transaction.xa.XAResource

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

Method Summary

Modifier and Type	Method	Description
void	acknowledge(ClientConsumer consumer, Message message)
void	addConsumer(ClientConsumerInternal consumer)
void	addProducer(ClientProducerInternal producer)
void	cleanUp(boolean failingOver)
void	endCall()	Opposite of startCall()
void	expire(ClientConsumer consumer, Message message)
int	getCompressionLevel()
RemotingConnection	getConnection()
ClientProducerCredits	getCredits(SimpleString address, boolean anon)
int	getMinLargeMessageSize()
String	getName()
String	getNodeId()
ClientProducerCreditManager	getProducerCreditManager()
SessionContext	getSessionContext()
void	handleConsumerDisconnect(ConsumerContext consumerContext)
boolean	handleFailover(RemotingConnection backupConnection, ActiveMQException cause)
void	handleReceiveContinuation(ConsumerContext consumerID, byte[] chunk, int flowControlSize, boolean isContinues)
void	handleReceiveLargeMessage(ConsumerContext consumerID, ClientLargeMessageInternal clientLargeMessage, long largeMessageSize)
void	handleReceiveMessage(ConsumerContext consumerID, ClientMessageInternal message)
void	handleReceiveProducerCredits(SimpleString address, int credits)
void	handleReceiveProducerFailCredits(SimpleString address, int credits)
void	individualAcknowledge(ClientConsumer consumer, Message message)
boolean	isCacheLargeMessageClient()
boolean	isClosing()
boolean	isCompressLargeMessages()
boolean	isConfirmationWindowEnabled()
boolean	isWritable(ReadyListener callback)
void	markRollbackOnly()
void	postHandleFailover(RemotingConnection connection, boolean successful)
void	preHandleFailover(RemotingConnection connection)
void	removeConsumer(ClientConsumerInternal consumer)
void	removeProducer(ClientProducerInternal producer)
void	resetIfNeeded()
void	returnCredits(SimpleString address)
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	setStopSignal()
void	startCall()	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.
void	workDone()
SendAcknowledgementHandler	wrap(SendAcknowledgementHandler handler)

Methods inherited from interface org.apache.activemq.artemis.api.core.client.ClientSession

addFailoverListener, addFailureListener, addMetaData, addressQuery, addUniqueMetaData, close, commit, commit, createAddress, createAddress, createAddress, createConsumer, createConsumer, createConsumer, createConsumer, createConsumer, createConsumer, createConsumer, createConsumer, createConsumer, createConsumer, createConsumer, createConsumer, createMessage, createMessage, createMessage, createProducer, createProducer, createProducer, createProducer, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createQueue, createSharedQueue, createSharedQueue, createSharedQueue, createSharedQueue, createSharedQueue, createSharedQueue, createSharedQueue, createTemporaryQueue, createTemporaryQueue, createTemporaryQueue, createTemporaryQueue, createTemporaryQueue, createTemporaryQueue, createTemporaryQueue, createTemporaryQueue, createTemporaryQueue, createTemporaryQueue, deleteQueue, deleteQueue, getSessionFactory, getVersion, getXAResource, isAutoCommitAcks, isAutoCommitSends, isBlockOnAcknowledge, isClosed, isRollbackOnly, isXA, queueQuery, removeFailoverListener, removeFailureListener, rollback, rollback, setSendAcknowledgementHandler, start, stop

Methods inherited from interface javax.transaction.xa.XAResource

commit, end, forget, getTransactionTimeout, isSameRM, prepare, recover, rollback, setTransactionTimeout, start

Method Details

getName

String getName()

acknowledge

void acknowledge(ClientConsumer consumer,
 Message message)
          throws ActiveMQException

Throws:

ActiveMQException

individualAcknowledge

void individualAcknowledge(ClientConsumer consumer,
 Message message)
                    throws ActiveMQException

Throws:

ActiveMQException

isCacheLargeMessageClient

boolean isCacheLargeMessageClient()

getMinLargeMessageSize

int getMinLargeMessageSize()

isCompressLargeMessages

boolean isCompressLargeMessages()

getCompressionLevel

int getCompressionLevel()

expire

void expire(ClientConsumer consumer,
 Message message)
     throws ActiveMQException

Throws:

ActiveMQException

addConsumer

void addConsumer(ClientConsumerInternal consumer)

addProducer

void addProducer(ClientProducerInternal producer)

removeConsumer

void removeConsumer(ClientConsumerInternal consumer)
             throws ActiveMQException

Throws:

ActiveMQException

removeProducer

void removeProducer(ClientProducerInternal producer)

handleReceiveMessage

void handleReceiveMessage(ConsumerContext consumerID,
 ClientMessageInternal message)
                   throws Exception

Throws:

Exception

handleReceiveLargeMessage

void handleReceiveLargeMessage(ConsumerContext consumerID,
 ClientLargeMessageInternal clientLargeMessage,
 long largeMessageSize)
                        throws Exception

Throws:

Exception

handleReceiveContinuation

void handleReceiveContinuation(ConsumerContext consumerID,
 byte[] chunk,
 int flowControlSize,
 boolean isContinues)
                        throws Exception

Throws:

Exception

handleConsumerDisconnect

void handleConsumerDisconnect(ConsumerContext consumerContext)
                       throws ActiveMQException

Throws:

ActiveMQException

preHandleFailover

void preHandleFailover(RemotingConnection connection)

handleFailover

boolean handleFailover(RemotingConnection backupConnection,
 ActiveMQException cause)

postHandleFailover

void postHandleFailover(RemotingConnection connection,
 boolean successful)

getConnection

RemotingConnection getConnection()

cleanUp

void cleanUp(boolean failingOver)
      throws ActiveMQException

Throws:

ActiveMQException

setForceNotSameRM

void setForceNotSameRM(boolean force)

workDone

void workDone()

sendProducerCreditsMessage

void sendProducerCreditsMessage(int credits,
 SimpleString address)

getCredits

ClientProducerCredits getCredits(SimpleString address,
 boolean anon)

returnCredits

void returnCredits(SimpleString address)

handleReceiveProducerCredits

void handleReceiveProducerCredits(SimpleString address,
 int credits)

handleReceiveProducerFailCredits

void handleReceiveProducerFailCredits(SimpleString address,
 int credits)

getProducerCreditManager

ClientProducerCreditManager getProducerCreditManager()

setAddress

void setAddress(Message message,
 SimpleString address)

This will set the address at the message

setPacketSize

void setPacketSize(int packetSize)

resetIfNeeded

void resetIfNeeded()
            throws ActiveMQException

Throws:

ActiveMQException

markRollbackOnly

void markRollbackOnly()

startCall

void startCall()

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

endCall

void endCall()

Opposite of startCall()

See Also:

• startCall()

setStopSignal

void setStopSignal()

isConfirmationWindowEnabled

boolean isConfirmationWindowEnabled()

isClosing

boolean isClosing()

getNodeId

String getNodeId()

isWritable

boolean isWritable(ReadyListener callback)

getSessionContext

SessionContext getSessionContext()

wrap

SendAcknowledgementHandler wrap(SendAcknowledgementHandler handler)