org.apache.activemq.artemis.core.server.impl

Class ServerSessionImpl

java.lang.Object

org.apache.activemq.artemis.core.server.impl.ServerSessionImpl

All Implemented Interfaces:

FailureListener, SecurityAuth, ServerSession

public class ServerSessionImpl
extends Object
implements ServerSession, FailureListener

Server side Session implementation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerSessionImpl.TempQueueCleanerUpper

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoCommitAcks
protected boolean	autoCommitSends
protected SessionCallback	callback
protected Map<Long,ServerConsumer>	consumers
protected ManagementService	managementService
protected String	name
protected PagingManager	pagingManager
protected String	password
PostOffice	postOffice
protected boolean	preAcknowledge
protected RemotingConnection	remotingConnection
protected RoutingContext	routingContext
protected ActiveMQServer	server
protected boolean	started
protected StorageManager	storageManager
protected boolean	strictUpdateDeliveryCount
protected Map<SimpleString,Pair<UUID,AtomicLong>>	targetAddressInfos
protected Map<SimpleString,ServerSessionImpl.TempQueueCleanerUpper>	tempQueueCleannerUppers
protected Transaction	tx
protected String	username
protected String	validatedUser
protected boolean	xa

Constructor Summary

Constructors

Constructor and Description

ServerSessionImpl(String name, String username, String password, String validatedUser, int minLargeMessageSize, boolean autoCommitSends, boolean autoCommitAcks, boolean preAcknowledge, boolean strictUpdateDeliveryCount, boolean xa, RemotingConnection remotingConnection, StorageManager storageManager, PostOffice postOffice, ResourceManager resourceManager, SecurityStore securityStore, ManagementService managementService, ActiveMQServer server, SimpleString managementAddress, SimpleString defaultAddress, SessionCallback callback, OperationContext context, QueueCreator queueCreator, PagingManager pagingManager)

Method Summary

Modifier and Type	Method and Description
void	acknowledge(long consumerID, long messageID)
void	addMetaData(String key, String data)
boolean	addUniqueMetaData(String key, String data)
void	clearLargeMessage()
void	close(boolean failed)
void	closeConsumer(long consumerID)
void	commit()
void	connectionFailed(ActiveMQException me, boolean failedOver) Notifies that a connection has failed due to the specified exception.
void	connectionFailed(ActiveMQException me, boolean failedOver, String scaleDownTargetNodeID) Notifies that a connection has failed due to the specified exception.
ServerConsumer	createConsumer(long consumerID, SimpleString queueName, SimpleString filterString, boolean browseOnly)
ServerConsumer	createConsumer(long consumerID, SimpleString queueName, SimpleString filterString, boolean browseOnly, boolean supportLargeMessage, Integer credits)
Queue	createQueue(SimpleString address, SimpleString name, SimpleString filterString, boolean temporary, boolean durable)
void	createSharedQueue(SimpleString address, SimpleString name, boolean durable, SimpleString filterString)
void	deleteQueue(SimpleString queueToDelete)
void	describeProducersInfo(javax.json.JsonArrayBuilder array) Add all the producers detail to the JSONArray object.
void	disableSecurity()
protected void	doClose(boolean failed)
RoutingStatus	doSend(Transaction tx, ServerMessage msg, boolean direct, boolean noAutoCreateQueue)
void	enableSecurity() Certain protocols may create an internal session that shouldn't go through security checks.
BindingQueryResult	executeBindingQuery(SimpleString address)
QueueQueryResult	executeQueueQuery(SimpleString name)
void	expire(long consumerID, long messageID)
void	forceConsumerDelivery(long consumerID, long sequence)
Object	getConnectionID()
long	getCreationTime()
Transaction	getCurrentTransaction()
List<MessageReference>	getInTXMessagesForConsumer(long consumerId)
String	getLastSentMessageID(String address)
String	getMetaData(String key)
int	getMinLargeMessageSize()
String	getName()
String	getPassword()
QueueCreator	getQueueCreator()
RemotingConnection	getRemotingConnection()
Set<ServerConsumer>	getServerConsumers()
OperationContext	getSessionContext()
StorageManager	getStorageManager()
String[]	getTargetAddresses()
String	getUsername()
String	getValidatedUser()
void	individualAcknowledge(long consumerID, long messageID)
void	individualCancel(long consumerID, long messageID, boolean failed)
boolean	isClosed()
ServerConsumer	locateConsumer(long consumerID)
void	markTXFailed(Throwable e)
Transaction	newTransaction()
void	receiveConsumerCredits(long consumerID, int credits)
boolean	removeConsumer(long consumerID)
void	requestProducerCredits(SimpleString address, int credits)
void	resetTX(Transaction transaction) Some protocols may chose to hold their transactions outside of the ServerSession.
void	rollback(boolean considerLastMessageAsDelivered)
protected void	securityCheck(SimpleString address, CheckType checkType, SecurityAuth auth)
RoutingStatus	send(ServerMessage message, boolean direct)
RoutingStatus	send(ServerMessage message, boolean direct, boolean noAutoCreateQueue)
RoutingStatus	send(Transaction tx, ServerMessage message, boolean direct, boolean noAutoCreateQueue)
void	sendContinuations(int packetSize, long messageBodySize, byte[] body, boolean continues)
void	sendLarge(MessageInternal message)
void	setTransferring(boolean transferring)
void	start()
void	stop()
String	toString()
void	waitContextCompletion()
void	xaCommit(Xid xid, boolean onePhase)
void	xaEnd(Xid xid)
void	xaFailed(Xid xid)
void	xaForget(Xid xid)
List<Xid>	xaGetInDoubtXids()
int	xaGetTimeout()
void	xaJoin(Xid xid)
void	xaPrepare(Xid xid)
void	xaResume(Xid xid)
void	xaRollback(Xid xid)
void	xaSetTimeout(int timeout)
void	xaStart(Xid xid)
void	xaSuspend()

Methods inherited from class java.lang.Object

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

Field Detail

username

protected final String username

password

protected final String password

validatedUser

protected final String validatedUser

autoCommitSends

protected boolean autoCommitSends

autoCommitAcks

protected boolean autoCommitAcks

preAcknowledge

protected final boolean preAcknowledge

strictUpdateDeliveryCount

protected final boolean strictUpdateDeliveryCount

remotingConnection

protected final RemotingConnection remotingConnection

consumers

protected final Map<Long,ServerConsumer> consumers

tx

protected Transaction tx

xa

protected boolean xa

pagingManager

protected final PagingManager pagingManager

storageManager

protected final StorageManager storageManager

postOffice

public final PostOffice postOffice

managementService

protected final ManagementService managementService

started

protected volatile boolean started

tempQueueCleannerUppers

protected final Map<SimpleString,ServerSessionImpl.TempQueueCleanerUpper> tempQueueCleannerUppers

name

protected final String name

server

protected final ActiveMQServer server

routingContext

protected final RoutingContext routingContext

callback

protected final SessionCallback callback

targetAddressInfos

protected final Map<SimpleString,Pair<UUID,AtomicLong>> targetAddressInfos

Constructor Detail

ServerSessionImpl

public ServerSessionImpl(String name,
                         String username,
                         String password,
                         String validatedUser,
                         int minLargeMessageSize,
                         boolean autoCommitSends,
                         boolean autoCommitAcks,
                         boolean preAcknowledge,
                         boolean strictUpdateDeliveryCount,
                         boolean xa,
                         RemotingConnection remotingConnection,
                         StorageManager storageManager,
                         PostOffice postOffice,
                         ResourceManager resourceManager,
                         SecurityStore securityStore,
                         ManagementService managementService,
                         ActiveMQServer server,
                         SimpleString managementAddress,
                         SimpleString defaultAddress,
                         SessionCallback callback,
                         OperationContext context,
                         QueueCreator queueCreator,
                         PagingManager pagingManager)
                  throws Exception

Throws:

Exception

Method Detail

enableSecurity

public void enableSecurity()

Description copied from interface: ServerSession

Certain protocols may create an internal session that shouldn't go through security checks. make sure you don't expose this property through any protocol layer as that would be a security breach

Specified by:

enableSecurity in interface ServerSession

disableSecurity

public void disableSecurity()

Specified by:

disableSecurity in interface ServerSession

isClosed

public boolean isClosed()

Specified by:

isClosed in interface ServerSession

getSessionContext

public OperationContext getSessionContext()

Specified by:

getSessionContext in interface ServerSession

Returns:

the sessionContext

getUsername

public String getUsername()

Specified by:

getUsername in interface SecurityAuth

getPassword

public String getPassword()

Specified by:

getPassword in interface SecurityAuth

getMinLargeMessageSize

public int getMinLargeMessageSize()

Specified by:

getMinLargeMessageSize in interface ServerSession

getName

public String getName()

Specified by:

getName in interface ServerSession

getConnectionID

public Object getConnectionID()

Specified by:

getConnectionID in interface ServerSession

getServerConsumers

public Set<ServerConsumer> getServerConsumers()

Specified by:

getServerConsumers in interface ServerSession

markTXFailed

public void markTXFailed(Throwable e)

Specified by:

markTXFailed in interface ServerSession

removeConsumer

public boolean removeConsumer(long consumerID)
                       throws Exception

Specified by:

removeConsumer in interface ServerSession

Throws:

Exception

doClose

protected void doClose(boolean failed)
                throws Exception

Throws:

Exception

getQueueCreator

public QueueCreator getQueueCreator()

Specified by:

getQueueCreator in interface ServerSession

securityCheck

protected void securityCheck(SimpleString address,
                             CheckType checkType,
                             SecurityAuth auth)
                      throws Exception

Throws:

Exception

createConsumer

public ServerConsumer createConsumer(long consumerID,
                                     SimpleString queueName,
                                     SimpleString filterString,
                                     boolean browseOnly)
                              throws Exception

Specified by:

createConsumer in interface ServerSession

Throws:

Exception

createConsumer

public ServerConsumer createConsumer(long consumerID,
                                     SimpleString queueName,
                                     SimpleString filterString,
                                     boolean browseOnly,
                                     boolean supportLargeMessage,
                                     Integer credits)
                              throws Exception

Specified by:

createConsumer in interface ServerSession

Throws:

Exception

resetTX

public void resetTX(Transaction transaction)

Some protocols may chose to hold their transactions outside of the ServerSession. This can be used to replace the transaction. Notice that we set autoCommitACK and autoCommitSends to true if tx == null

Specified by:

resetTX in interface ServerSession

createQueue

public Queue createQueue(SimpleString address,
                         SimpleString name,
                         SimpleString filterString,
                         boolean temporary,
                         boolean durable)
                  throws Exception

Specified by:

createQueue in interface ServerSession

Throws:

Exception

createSharedQueue

public void createSharedQueue(SimpleString address,
                              SimpleString name,
                              boolean durable,
                              SimpleString filterString)
                       throws Exception

Specified by:

createSharedQueue in interface ServerSession

Throws:

Exception

getRemotingConnection

public RemotingConnection getRemotingConnection()

Specified by:

getRemotingConnection in interface SecurityAuth

Specified by:

getRemotingConnection in interface ServerSession

deleteQueue

public void deleteQueue(SimpleString queueToDelete)
                 throws Exception

Specified by:

deleteQueue in interface ServerSession

Throws:

Exception

executeQueueQuery

public QueueQueryResult executeQueueQuery(SimpleString name)
                                   throws Exception

Specified by:

executeQueueQuery in interface ServerSession

Throws:

Exception

executeBindingQuery

public BindingQueryResult executeBindingQuery(SimpleString address)
                                       throws Exception

Specified by:

executeBindingQuery in interface ServerSession

Throws:

Exception

forceConsumerDelivery

public void forceConsumerDelivery(long consumerID,
                                  long sequence)
                           throws Exception

Specified by:

forceConsumerDelivery in interface ServerSession

Throws:

Exception

acknowledge

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

Specified by:

acknowledge in interface ServerSession

Throws:

Exception

locateConsumer

public ServerConsumer locateConsumer(long consumerID)

Specified by:

locateConsumer in interface ServerSession

individualAcknowledge

public void individualAcknowledge(long consumerID,
                                  long messageID)
                           throws Exception

Specified by:

individualAcknowledge in interface ServerSession

Throws:

Exception

individualCancel

public void individualCancel(long consumerID,
                             long messageID,
                             boolean failed)
                      throws Exception

Specified by:

individualCancel in interface ServerSession

Throws:

Exception

expire

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

Specified by:

expire in interface ServerSession

Throws:

Exception

commit

public void commit()
            throws Exception

Specified by:

commit in interface ServerSession

Throws:

Exception

rollback

public void rollback(boolean considerLastMessageAsDelivered)
              throws Exception

Specified by:

rollback in interface ServerSession

Throws:

Exception

newTransaction

public Transaction newTransaction()

Specified by:

newTransaction in interface ServerSession

Returns:

xaCommit

public void xaCommit(Xid xid,
                     boolean onePhase)
              throws Exception

Specified by:

xaCommit in interface ServerSession

Throws:

Exception

xaEnd

public void xaEnd(Xid xid)
           throws Exception

Specified by:

xaEnd in interface ServerSession

Throws:

Exception

xaForget

public void xaForget(Xid xid)
              throws Exception

Specified by:

xaForget in interface ServerSession

Throws:

Exception

xaJoin

public void xaJoin(Xid xid)
            throws Exception

Specified by:

xaJoin in interface ServerSession

Throws:

Exception

xaResume

public void xaResume(Xid xid)
              throws Exception

Specified by:

xaResume in interface ServerSession

Throws:

Exception

xaRollback

public void xaRollback(Xid xid)
                throws Exception

Specified by:

xaRollback in interface ServerSession

Throws:

Exception

xaStart

public void xaStart(Xid xid)
             throws Exception

Specified by:

xaStart in interface ServerSession

Throws:

Exception

xaFailed

public void xaFailed(Xid xid)
              throws Exception

Specified by:

xaFailed in interface ServerSession

Throws:

Exception

xaSuspend

public void xaSuspend()
               throws Exception

Specified by:

xaSuspend in interface ServerSession

Throws:

Exception

xaPrepare

public void xaPrepare(Xid xid)
               throws Exception

Specified by:

xaPrepare in interface ServerSession

Throws:

Exception

xaGetInDoubtXids

public List<Xid> xaGetInDoubtXids()

Specified by:

xaGetInDoubtXids in interface ServerSession

xaGetTimeout

public int xaGetTimeout()

Specified by:

xaGetTimeout in interface ServerSession

xaSetTimeout

public void xaSetTimeout(int timeout)

Specified by:

xaSetTimeout in interface ServerSession

start

public void start()

Specified by:

start in interface ServerSession

stop

public void stop()

Specified by:

stop in interface ServerSession

waitContextCompletion

public void waitContextCompletion()

Specified by:

waitContextCompletion in interface ServerSession

close

public void close(boolean failed)

Specified by:

close in interface ServerSession

closeConsumer

public void closeConsumer(long consumerID)
                   throws Exception

Specified by:

closeConsumer in interface ServerSession

Throws:

Exception

receiveConsumerCredits

public void receiveConsumerCredits(long consumerID,
                                   int credits)
                            throws Exception

Specified by:

receiveConsumerCredits in interface ServerSession

Throws:

Exception

getCurrentTransaction

public Transaction getCurrentTransaction()

Specified by:

getCurrentTransaction in interface ServerSession

sendLarge

public void sendLarge(MessageInternal message)
               throws Exception

Specified by:

sendLarge in interface ServerSession

Throws:

Exception

send

public RoutingStatus send(ServerMessage message,
                          boolean direct)
                   throws Exception

Specified by:

send in interface ServerSession

Throws:

Exception

send

public RoutingStatus send(ServerMessage message,
                          boolean direct,
                          boolean noAutoCreateQueue)
                   throws Exception

Specified by:

send in interface ServerSession

Throws:

Exception

send

public RoutingStatus send(Transaction tx,
                          ServerMessage message,
                          boolean direct,
                          boolean noAutoCreateQueue)
                   throws Exception

Specified by:

send in interface ServerSession

Throws:

Exception

sendContinuations

public void sendContinuations(int packetSize,
                              long messageBodySize,
                              byte[] body,
                              boolean continues)
                       throws Exception

Specified by:

sendContinuations in interface ServerSession

Throws:

Exception

requestProducerCredits

public void requestProducerCredits(SimpleString address,
                                   int credits)
                            throws Exception

Specified by:

requestProducerCredits in interface ServerSession

Throws:

Exception

setTransferring

public void setTransferring(boolean transferring)

Specified by:

setTransferring in interface ServerSession

addMetaData

public void addMetaData(String key,
                        String data)

Specified by:

addMetaData in interface ServerSession

addUniqueMetaData

public boolean addUniqueMetaData(String key,
                                 String data)

Specified by:

addUniqueMetaData in interface ServerSession

getMetaData

public String getMetaData(String key)

Specified by:

getMetaData in interface ServerSession

getTargetAddresses

public String[] getTargetAddresses()

Specified by:

getTargetAddresses in interface ServerSession

getLastSentMessageID

public String getLastSentMessageID(String address)

Specified by:

getLastSentMessageID in interface ServerSession

getCreationTime

public long getCreationTime()

Specified by:

getCreationTime in interface ServerSession

getStorageManager

public StorageManager getStorageManager()

describeProducersInfo

public void describeProducersInfo(javax.json.JsonArrayBuilder array)
                           throws Exception

Description copied from interface: ServerSession

Add all the producers detail to the JSONArray object. This is a method to be used by the management layer.

Specified by:

describeProducersInfo in interface ServerSession

Throws:

Exception

getValidatedUser

public String getValidatedUser()

Specified by:

getValidatedUser in interface ServerSession

toString

public String toString()

Overrides:

toString in class Object

connectionFailed

public void connectionFailed(ActiveMQException me,
                             boolean failedOver)

Description copied from interface: FailureListener

Notifies that a connection has failed due to the specified exception.

Specified by:

connectionFailed in interface FailureListener

Parameters:

me - exception which has caused the connection to fail

connectionFailed

public void connectionFailed(ActiveMQException me,
                             boolean failedOver,
                             String scaleDownTargetNodeID)

Description copied from interface: FailureListener

Notifies that a connection has failed due to the specified exception.

Specified by:

connectionFailed in interface FailureListener

Parameters:

me - exception which has caused the connection to fail

scaleDownTargetNodeID - the ID of the node to which messages are scaling down

clearLargeMessage

public void clearLargeMessage()

doSend

public RoutingStatus doSend(Transaction tx,
                            ServerMessage msg,
                            boolean direct,
                            boolean noAutoCreateQueue)
                     throws Exception

Throws:

Exception

getInTXMessagesForConsumer

public List<MessageReference> getInTXMessagesForConsumer(long consumerId)

Specified by:

getInTXMessagesForConsumer in interface ServerSession