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	addMetaData(String key, String data)
boolean	addUniqueMetaData(String key, String data)
void	close(boolean failed)
void	closeConsumer(long consumerID)
void	commit()
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 name)
void	describeProducersInfo(javax.json.JsonArrayBuilder objs) Add all the producers detail to the JSONArray object.
void	disableSecurity()
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()
QueueCreator	getQueueCreator()
RemotingConnection	getRemotingConnection()
Set<ServerConsumer>	getServerConsumers()
OperationContext	getSessionContext()
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)
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(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 totalBodySize, byte[] body, boolean continues)
void	sendLarge(MessageInternal msg)
void	setTransferring(boolean transferring)
void	start()
void	stop()
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 interface org.apache.activemq.artemis.core.security.SecurityAuth

getPassword, getUsername

Method Detail

getName

String getName()

getMinLargeMessageSize

int getMinLargeMessageSize()

getConnectionID

Object getConnectionID()

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)

getQueueCreator

QueueCreator getQueueCreator()

xaGetInDoubtXids

List<Xid> xaGetInDoubtXids()

xaGetTimeout

int xaGetTimeout()

xaSetTimeout

void xaSetTimeout(int timeout)

start

void start()

stop

void stop()

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,
                  SimpleString filterString,
                  boolean temporary,
                  boolean durable)
           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

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

sendContinuations

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

Throws:

Exception

send

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

Throws:

Exception

send

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

Throws:

Exception

send

RoutingStatus send(ServerMessage message,
                   boolean direct)
            throws Exception

Throws:

Exception

sendLarge

void sendLarge(MessageInternal msg)
        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

waitContextCompletion

void waitContextCompletion()
                    throws Exception

Throws:

Exception

setTransferring

void setTransferring(boolean transferring)

getServerConsumers

Set<ServerConsumer> getServerConsumers()

addMetaData

void addMetaData(String key,
                 String data)

addUniqueMetaData

boolean addUniqueMetaData(String key,
                          String data)

getMetaData

String getMetaData(String key)

getTargetAddresses

String[] getTargetAddresses()

describeProducersInfo

void describeProducersInfo(javax.json.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,
                       boolean durable,
                       SimpleString filterString)
                throws Exception

Throws:

Exception

getInTXMessagesForConsumer

List<MessageReference> getInTXMessagesForConsumer(long consumerId)

getValidatedUser

String getValidatedUser()