org.apache.activemq.artemis.core.server

Interface ServerSession

All Superinterfaces:

SecurityAuth

All Known Implementing Classes:

ServerSessionImpl

public interface ServerSession
extends SecurityAuth

Method Summary

Modifier and Type	Method and Description
void	acknowledge(long consumerID, long messageID)
void	addCloseable(Closeable closeable)
void	addMetaData(String key, String data)
void	addProducer(ServerProducer serverProducer)
boolean	addUniqueMetaData(String key, String data)
void	close(boolean failed)
void	closeConsumer(long consumerID)
void	commit()
AddressInfo	createAddress(AddressInfo addressInfo, boolean autoCreated)
AddressInfo	createAddress(SimpleString address, EnumSet<RoutingType> routingTypes, boolean autoCreated)
AddressInfo	createAddress(SimpleString address, RoutingType routingType, boolean autoCreated)
ServerConsumer	createConsumer(long consumerID, SimpleString queueName, SimpleString filterString, boolean browseOnly)
ServerConsumer	createConsumer(long consumerID, SimpleString queueName, SimpleString filterString, boolean browseOnly, boolean supportLargeMessage, Integer credits)
ServerConsumer	createConsumer(long consumerID, SimpleString queueName, SimpleString filterString, int priority, boolean browseOnly, boolean supportLargeMessage, Integer credits)
Queue	createQueue(AddressInfo address, SimpleString name, SimpleString filterString, boolean temporary, boolean durable)
Queue	createQueue(AddressInfo addressInfo, SimpleString name, SimpleString filterString, boolean temporary, boolean durable, boolean autoCreated)
Queue	createQueue(AddressInfo addressInfo, SimpleString name, SimpleString filterString, boolean temporary, boolean durable, Boolean exclusive, Boolean lastValue, boolean autoCreated)
Queue	createQueue(SimpleString address, SimpleString name, RoutingType routingType, SimpleString filterString, boolean temporary, boolean durable)
Queue	createQueue(SimpleString address, SimpleString name, RoutingType routingType, SimpleString filterString, boolean temporary, boolean durable, boolean autoCreated)
Queue	createQueue(SimpleString address, SimpleString name, RoutingType routingType, SimpleString filterString, boolean temporary, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, boolean autoCreated)
Queue	createQueue(SimpleString address, SimpleString name, RoutingType routingType, SimpleString filterString, boolean temporary, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, Boolean exclusive, Boolean lastValue, boolean autoCreated)
Queue	createQueue(SimpleString address, SimpleString name, RoutingType routingType, SimpleString filterString, boolean temporary, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, Boolean lastValue, SimpleString lastValueKey, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, Boolean autoDelete, Long autoDeleteDelay, Long autoDeleteMessageCount, boolean autoCreated)
Queue	createQueue(SimpleString address, SimpleString name, RoutingType routingType, SimpleString filterString, boolean temporary, boolean durable, int maxConsumers, boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, SimpleString groupFirstKey, Boolean lastValue, SimpleString lastValueKey, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, Boolean autoDelete, Long autoDeleteDelay, Long autoDeleteMessageCount, boolean autoCreated)
Queue	createQueue(SimpleString address, SimpleString name, SimpleString filterString, boolean temporary, boolean durable) Create queue with default delivery mode
void	createSharedQueue(SimpleString address, SimpleString name, boolean durable, SimpleString filterString)
void	createSharedQueue(SimpleString address, SimpleString name, RoutingType routingType, boolean durable, SimpleString filterString)
void	createSharedQueue(SimpleString address, SimpleString name, RoutingType routingType, SimpleString filterString, boolean durable, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean lastValue)
void	createSharedQueue(SimpleString address, SimpleString name, RoutingType routingType, SimpleString filterString, boolean durable, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, Boolean lastValue, SimpleString lastValueKey, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, Boolean autoDelete, Long autoDeleteDelay, Long autoDeleteMessageCount)
void	createSharedQueue(SimpleString address, SimpleString name, RoutingType routingType, SimpleString filterString, boolean durable, Integer maxConsumers, Boolean purgeOnNoConsumers, Boolean exclusive, Boolean groupRebalance, Integer groupBuckets, SimpleString groupFirstKey, Boolean lastValue, SimpleString lastValueKey, Boolean nonDestructive, Integer consumersBeforeDispatch, Long delayBeforeDispatch, Boolean autoDelete, Long autoDeleteDelay, Long autoDeleteMessageCount)
void	deleteQueue(SimpleString name)
void	describeProducersInfo(JsonArrayBuilder objs) Add all the producers detail to the JSONArray object.
void	disableSecurity()
RoutingStatus	doSend(Transaction tx, Message msg, SimpleString originalAddress, boolean direct, boolean noAutoCreateQueue)
RoutingStatus	doSend(Transaction tx, Message msg, SimpleString originalAddress, boolean direct, boolean noAutoCreateQueue, RoutingContext routingContext)
void	enableSecurity() Certain protocols may create an internal session that shouldn't go through security checks.
AddressQueryResult	executeAddressQuery(SimpleString name)
BindingQueryResult	executeBindingQuery(SimpleString address)
QueueQueryResult	executeQueueQuery(SimpleString name)
void	expire(long consumerID, long messageID)
void	forceConsumerDelivery(long consumerID, long sequence)
AddressInfo	getAddress(SimpleString address)
AddressInfo	getAddressAndRoutingType(AddressInfo addressInfo) Get the canonical (i.e.
Pair<SimpleString,EnumSet<RoutingType>>	getAddressAndRoutingTypes(SimpleString address, EnumSet<RoutingType> defaultRoutingTypes) Get the canonical (i.e.
Object	getConnectionID()
int	getConsumerCount()
long	getCreationTime()
Transaction	getCurrentTransaction()
String	getDefaultAddress()
int	getDefaultConsumerWindowSize(SimpleString address)
List<MessageReference>	getInTXMessagesForConsumer(long consumerId)
String	getLastSentMessageID(String address)
SimpleString	getMatchingQueue(SimpleString address, RoutingType routingType)
SimpleString	getMatchingQueue(SimpleString address, SimpleString queueName, RoutingType routingType)
Map<String,String>	getMetaData()
String	getMetaData(String key)
int	getMinLargeMessageSize()
String	getName()
SimpleString	getPrefix(SimpleString address) Get the prefix (if it exists) from the address based on the prefixes provided to the ServerSession constructor.
int	getProducerCount()
RemotingConnection	getRemotingConnection()
Set<ServerConsumer>	getServerConsumers()
Map<String,ServerProducer>	getServerProducers()
OperationContext	getSessionContext()
Executor	getSessionExecutor()
String[]	getTargetAddresses()
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)
SimpleString	removePrefix(SimpleString address) Strip the prefix (if it exists) from the address based on the prefixes provided to the ServerSession constructor.
void	removeProducer(String ID)
void	requestProducerCredits(SimpleString address, int credits)
void	resetTX(Transaction transaction) To be used by protocol heads that needs to control the transaction outside the session context.
void	rollback(boolean considerLastMessageAsDelivered)
RoutingStatus	send(Message message, boolean direct)
RoutingStatus	send(Message message, boolean direct, boolean noAutoCreateQueue)
RoutingStatus	send(Transaction tx, Message message, boolean direct, boolean noAutoCreateQueue)
RoutingStatus	send(Transaction tx, Message message, boolean direct, boolean noAutoCreateQueue, RoutingContext routingContext)
void	setTransferring(boolean transferring)
void	start()
void	stop()
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 interface org.apache.activemq.artemis.core.security.SecurityAuth

getPassword, getUsername

Method Detail

getName

String getName()

getMinLargeMessageSize

int getMinLargeMessageSize()

getConnectionID

Object getConnectionID()

getSessionExecutor

Executor getSessionExecutor()

enableSecurity

void enableSecurity()

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

disableSecurity

void disableSecurity()

getRemotingConnection

RemotingConnection getRemotingConnection()

Specified by:

getRemotingConnection in interface SecurityAuth

newTransaction

Transaction newTransaction()

removeConsumer

boolean removeConsumer(long consumerID)
                throws Exception

Throws:

Exception

acknowledge

void acknowledge(long consumerID,
                 long messageID)
          throws Exception

Throws:

Exception

individualAcknowledge

void individualAcknowledge(long consumerID,
                           long messageID)
                    throws Exception

Throws:

Exception

individualCancel

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

Throws:

Exception

expire

void expire(long consumerID,
            long messageID)
     throws Exception

Throws:

Exception

rollback

void rollback(boolean considerLastMessageAsDelivered)
       throws Exception

Throws:

Exception

commit

void commit()
     throws Exception

Throws:

Exception

xaCommit

void xaCommit(Xid xid,
              boolean onePhase)
       throws Exception

Throws:

Exception

xaEnd

void xaEnd(Xid xid)
    throws Exception

Throws:

Exception

xaForget

void xaForget(Xid xid)
       throws Exception

Throws:

Exception

xaJoin

void xaJoin(Xid xid)
     throws Exception

Throws:

Exception

xaPrepare

void xaPrepare(Xid xid)
        throws Exception

Throws:

Exception

xaResume

void xaResume(Xid xid)
       throws Exception

Throws:

Exception

xaRollback

void xaRollback(Xid xid)
         throws Exception

Throws:

Exception

xaStart

void xaStart(Xid xid)
      throws Exception

Throws:

Exception

xaFailed

void xaFailed(Xid xid)
       throws Exception

Throws:

Exception

xaSuspend

void xaSuspend()
        throws Exception

Throws:

Exception

markTXFailed

void markTXFailed(Throwable e)

xaGetInDoubtXids

List<Xid> xaGetInDoubtXids()

xaGetTimeout

int xaGetTimeout()

xaSetTimeout

void xaSetTimeout(int timeout)

start

void start()

stop

void stop()

addCloseable

void addCloseable(Closeable closeable)

createConsumer

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

Throws:

Exception

resetTX

void resetTX(Transaction transaction)

To be used by protocol heads that needs to control the transaction outside the session context.

createQueue

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

Throws:

Exception

createQueue

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

Throws:

Exception

createQueue

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

Create queue with default delivery mode

Parameters:

address -

name -

filterString -

temporary -

durable -

Returns:

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  SimpleString name,
                  RoutingType routingType,
                  SimpleString filterString,
                  boolean temporary,
                  boolean durable,
                  int maxConsumers,
                  boolean purgeOnNoConsumers,
                  boolean autoCreated)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  SimpleString name,
                  RoutingType routingType,
                  SimpleString filterString,
                  boolean temporary,
                  boolean durable,
                  int maxConsumers,
                  boolean purgeOnNoConsumers,
                  Boolean exclusive,
                  Boolean lastValue,
                  boolean autoCreated)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  SimpleString name,
                  RoutingType routingType,
                  SimpleString filterString,
                  boolean temporary,
                  boolean durable,
                  int maxConsumers,
                  boolean purgeOnNoConsumers,
                  Boolean exclusive,
                  Boolean groupRebalance,
                  Integer groupBuckets,
                  Boolean lastValue,
                  SimpleString lastValueKey,
                  Boolean nonDestructive,
                  Integer consumersBeforeDispatch,
                  Long delayBeforeDispatch,
                  Boolean autoDelete,
                  Long autoDeleteDelay,
                  Long autoDeleteMessageCount,
                  boolean autoCreated)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  SimpleString name,
                  RoutingType routingType,
                  SimpleString filterString,
                  boolean temporary,
                  boolean durable,
                  int maxConsumers,
                  boolean purgeOnNoConsumers,
                  Boolean exclusive,
                  Boolean groupRebalance,
                  Integer groupBuckets,
                  SimpleString groupFirstKey,
                  Boolean lastValue,
                  SimpleString lastValueKey,
                  Boolean nonDestructive,
                  Integer consumersBeforeDispatch,
                  Long delayBeforeDispatch,
                  Boolean autoDelete,
                  Long autoDeleteDelay,
                  Long autoDeleteMessageCount,
                  boolean autoCreated)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(SimpleString address,
                  SimpleString name,
                  RoutingType routingType,
                  SimpleString filterString,
                  boolean temporary,
                  boolean durable,
                  boolean autoCreated)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(AddressInfo addressInfo,
                  SimpleString name,
                  SimpleString filterString,
                  boolean temporary,
                  boolean durable,
                  boolean autoCreated)
           throws Exception

Throws:

Exception

createQueue

Queue createQueue(AddressInfo addressInfo,
                  SimpleString name,
                  SimpleString filterString,
                  boolean temporary,
                  boolean durable,
                  Boolean exclusive,
                  Boolean lastValue,
                  boolean autoCreated)
           throws Exception

Throws:

Exception

createAddress

AddressInfo createAddress(SimpleString address,
                          EnumSet<RoutingType> routingTypes,
                          boolean autoCreated)
                   throws Exception

Throws:

Exception

createAddress

AddressInfo createAddress(SimpleString address,
                          RoutingType routingType,
                          boolean autoCreated)
                   throws Exception

Throws:

Exception

createAddress

AddressInfo createAddress(AddressInfo addressInfo,
                          boolean autoCreated)
                   throws Exception

Throws:

Exception

deleteQueue

void deleteQueue(SimpleString name)
          throws Exception

Throws:

Exception

createConsumer

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

Throws:

Exception

createConsumer

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

Throws:

Exception

executeQueueQuery

QueueQueryResult executeQueueQuery(SimpleString name)
                            throws Exception

Throws:

Exception

executeAddressQuery

AddressQueryResult executeAddressQuery(SimpleString name)
                                throws Exception

Throws:

Exception

executeBindingQuery

BindingQueryResult executeBindingQuery(SimpleString address)
                                throws Exception

Throws:

Exception

closeConsumer

void closeConsumer(long consumerID)
            throws Exception

Throws:

Exception

receiveConsumerCredits

void receiveConsumerCredits(long consumerID,
                            int credits)
                     throws Exception

Throws:

Exception

send

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

Throws:

Exception

send

RoutingStatus send(Transaction tx,
                   Message message,
                   boolean direct,
                   boolean noAutoCreateQueue,
                   RoutingContext routingContext)
            throws Exception

Throws:

Exception

doSend

RoutingStatus doSend(Transaction tx,
                     Message msg,
                     SimpleString originalAddress,
                     boolean direct,
                     boolean noAutoCreateQueue)
              throws Exception

Throws:

Exception

doSend

RoutingStatus doSend(Transaction tx,
                     Message msg,
                     SimpleString originalAddress,
                     boolean direct,
                     boolean noAutoCreateQueue,
                     RoutingContext routingContext)
              throws Exception

Throws:

Exception

send

RoutingStatus send(Message message,
                   boolean direct,
                   boolean noAutoCreateQueue)
            throws Exception

Throws:

Exception

send

RoutingStatus send(Message message,
                   boolean direct)
            throws Exception

Throws:

Exception

forceConsumerDelivery

void forceConsumerDelivery(long consumerID,
                           long sequence)
                    throws Exception

Throws:

Exception

requestProducerCredits

void requestProducerCredits(SimpleString address,
                            int credits)
                     throws Exception

Throws:

Exception

close

void close(boolean failed)
    throws Exception

Throws:

Exception

setTransferring

void setTransferring(boolean transferring)

getServerConsumers

Set<ServerConsumer> getServerConsumers()

addMetaData

void addMetaData(String key,
                 String data)
          throws Exception

Throws:

Exception

addUniqueMetaData

boolean addUniqueMetaData(String key,
                          String data)
                   throws Exception

Throws:

Exception

getMetaData

String getMetaData(String key)

getMetaData

Map<String,String> getMetaData()

getTargetAddresses

String[] getTargetAddresses()

describeProducersInfo

void describeProducersInfo(JsonArrayBuilder objs)
                    throws Exception

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

Parameters:

objs -

Throws:

Exception

getLastSentMessageID

String getLastSentMessageID(String address)

getCreationTime

long getCreationTime()

getSessionContext

OperationContext getSessionContext()

getCurrentTransaction

Transaction getCurrentTransaction()

locateConsumer

ServerConsumer locateConsumer(long consumerID)
                       throws Exception

Throws:

Exception

isClosed

boolean isClosed()

createSharedQueue

void createSharedQueue(SimpleString address,
                       SimpleString name,
                       RoutingType routingType,
                       SimpleString filterString,
                       boolean durable,
                       Integer maxConsumers,
                       Boolean purgeOnNoConsumers,
                       Boolean exclusive,
                       Boolean lastValue)
                throws Exception

Throws:

Exception

createSharedQueue

void createSharedQueue(SimpleString address,
                       SimpleString name,
                       RoutingType routingType,
                       SimpleString filterString,
                       boolean durable,
                       Integer maxConsumers,
                       Boolean purgeOnNoConsumers,
                       Boolean exclusive,
                       Boolean groupRebalance,
                       Integer groupBuckets,
                       Boolean lastValue,
                       SimpleString lastValueKey,
                       Boolean nonDestructive,
                       Integer consumersBeforeDispatch,
                       Long delayBeforeDispatch,
                       Boolean autoDelete,
                       Long autoDeleteDelay,
                       Long autoDeleteMessageCount)
                throws Exception

Throws:

Exception

createSharedQueue

void createSharedQueue(SimpleString address,
                       SimpleString name,
                       RoutingType routingType,
                       SimpleString filterString,
                       boolean durable,
                       Integer maxConsumers,
                       Boolean purgeOnNoConsumers,
                       Boolean exclusive,
                       Boolean groupRebalance,
                       Integer groupBuckets,
                       SimpleString groupFirstKey,
                       Boolean lastValue,
                       SimpleString lastValueKey,
                       Boolean nonDestructive,
                       Integer consumersBeforeDispatch,
                       Long delayBeforeDispatch,
                       Boolean autoDelete,
                       Long autoDeleteDelay,
                       Long autoDeleteMessageCount)
                throws Exception

Throws:

Exception

createSharedQueue

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

Throws:

Exception

createSharedQueue

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

Throws:

Exception

getInTXMessagesForConsumer

List<MessageReference> getInTXMessagesForConsumer(long consumerId)

getValidatedUser

String getValidatedUser()

getMatchingQueue

SimpleString getMatchingQueue(SimpleString address,
                              RoutingType routingType)
                       throws Exception

Throws:

Exception

getMatchingQueue

SimpleString getMatchingQueue(SimpleString address,
                              SimpleString queueName,
                              RoutingType routingType)
                       throws Exception

Throws:

Exception

getAddress

AddressInfo getAddress(SimpleString address)

removePrefix

SimpleString removePrefix(SimpleString address)

Strip the prefix (if it exists) from the address based on the prefixes provided to the ServerSession constructor.

Parameters:

address - the address to inspect

Returns:

the canonical (i.e. non-prefixed) address name

getPrefix

SimpleString getPrefix(SimpleString address)

Get the prefix (if it exists) from the address based on the prefixes provided to the ServerSession constructor.

Parameters:

address - the address to inspect

Returns:

the canonical (i.e. non-prefixed) address name

getAddressAndRoutingType

AddressInfo getAddressAndRoutingType(AddressInfo addressInfo)

Get the canonical (i.e. non-prefixed) address and the corresponding routing-type.

Parameters:

addressInfo - the address to inspect

Returns:

a org.apache.activemq.artemis.api.core.Pair representing the canonical (i.e. non-prefixed) address name and the org.apache.activemq.artemis.api.core.RoutingType corresponding to the that prefix.

getAddressAndRoutingTypes

Pair<SimpleString,EnumSet<RoutingType>> getAddressAndRoutingTypes(SimpleString address,
                                                                  EnumSet<RoutingType> defaultRoutingTypes)

Get the canonical (i.e. non-prefixed) address and the corresponding routing-type.

Parameters:

address - the address to inspect

defaultRoutingTypes - a the java.util.Set of org.apache.activemq.artemis.api.core.RoutingType objects to return if no prefix match is found.

Returns:

a org.apache.activemq.artemis.api.core.Pair representing the canonical (i.e. non-prefixed) address name and the java.util.Set of org.apache.activemq.artemis.api.core.RoutingType objects corresponding to the that prefix.

addProducer

void addProducer(ServerProducer serverProducer)

removeProducer

void removeProducer(String ID)

getServerProducers

Map<String,ServerProducer> getServerProducers()

getDefaultAddress

String getDefaultAddress()

getConsumerCount

int getConsumerCount()

getProducerCount

int getProducerCount()

getDefaultConsumerWindowSize

int getDefaultConsumerWindowSize(SimpleString address)