org.apache.qpid.server.protocol.v0_8

Interface AMQProtocolSession<T extends AMQProtocolSession<T>>

All Superinterfaces:

AMQConnectionModel<T,AMQChannel<T>>, org.apache.qpid.protocol.AMQProtocolWriter, org.apache.qpid.protocol.AMQVersionAwareProtocolSession, AuthorizationHolder, Deletable<T>, org.apache.qpid.protocol.ProtocolVersionAware, StatisticsGatherer

All Known Implementing Classes:

AMQProtocolEngine

public interface AMQProtocolSession<T extends AMQProtocolSession<T>>
extends org.apache.qpid.protocol.AMQVersionAwareProtocolSession, AuthorizationHolder, AMQConnectionModel<T,AMQChannel<T>>

Method Summary

Methods

Modifier and Type	Method and Description
void	addChannel(AMQChannel<T> channel) Associate a channel with this session.
boolean	channelAwaitingClosure(int channelId) Check to see if this chanel is closing
void	closeChannel(int channelId) Close a specific channel.
void	closeChannel(int channelId, org.apache.qpid.protocol.AMQConstant cause, String message)
void	closeChannelOk(int channelId) Marks the specific channel as closed.
void	closeProtocolSession()
void	closeSession() This must be called when the session is _closed in order to free up any resources managed by the session.
ClientDeliveryMethod	createDeliveryMethod(int channelId)
void	flushBatched()
AMQChannel<T>	getChannel(int channelId) Get the channel for this session associated with the specified id.
List<AMQChannel<T>>	getChannels()
String	getClientVersion()
org.apache.qpid.framing.AMQShortString	getContextKey() Get the context key associated with this session.
Object	getKey()
long	getLastIoTime()
long	getLastReceivedTime()
SocketAddress	getLocalAddress() Return the local socket address for the connection
String	getLocalFQDN() Get the fully qualified domain name of the local address to which this session is bound.
long	getMaxFrameSize()
Long	getMaximumNumberOfChannels()
int	getMessageCompressionThreshold()
org.apache.qpid.framing.MethodDispatcher	getMethodDispatcher()
org.apache.qpid.framing.MethodRegistry	getMethodRegistry()
Principal	getPeerPrincipal()
ProtocolOutputConverter	getProtocolOutputConverter()
Lock	getReceivedLock()
Object	getReference()
SocketAddress	getRemoteAddress()
SaslServer	getSaslServer()
long	getSessionID()
VirtualHostImpl<?,?,?>	getVirtualHost()
long	getWrittenBytes()
void	initHeartbeats(int delay) Initialise heartbeats on the session.
boolean	isCloseWhenNoRoute() Used for 0-8/0-9/0-9-1 connections to choose to close the connection when a transactional session receives a 'mandatory' message which can't be routed rather than returning the message.
boolean	isClosing()
boolean	isCompressionSupported()
void	removeChannel(int channelId) Remove a channel from the session but do not close it.
void	setAuthorizedSubject(Subject authorizedSubject)
void	setClientProperties(org.apache.qpid.framing.FieldTable clientProperties)
void	setContextKey(org.apache.qpid.framing.AMQShortString contextKey) Set the context key associated with this session.
void	setDeferFlush(boolean defer)
void	setMaxFrameSize(long frameMax)
void	setMaximumNumberOfChannels(Long value)
void	setSaslServer(SaslServer saslServer) Set the sasl server that is to perform authentication for this session.
void	setVirtualHost(VirtualHostImpl<?,?,?> virtualHost)

Methods inherited from interface org.apache.qpid.protocol.AMQVersionAwareProtocolSession

contentBodyReceived, contentHeaderReceived, heartbeatBodyReceived, methodFrameReceived, setSender

Methods inherited from interface org.apache.qpid.protocol.AMQProtocolWriter

writeFrame

Methods inherited from interface org.apache.qpid.protocol.ProtocolVersionAware

getProtocolMajorVersion, getProtocolMinorVersion, getProtocolVersion

Methods inherited from interface org.apache.qpid.server.security.AuthorizationHolder

getAuthorizedPrincipal, getAuthorizedSubject

Methods inherited from interface org.apache.qpid.server.protocol.AMQConnectionModel

addSessionListener, block, close, closeSession, getAuthorizedPrincipal, getClientId, getClientProduct, getConnectionId, getLogSubject, getPort, getRemoteAddressString, getRemoteContainerName, getRemoteProcessPid, getSessionCountLimit, getSessionModels, getTransport, getVirtualHostName, isSessionNameUnique, isStopped, removeSessionListener, stop, unblock

Methods inherited from interface org.apache.qpid.server.stats.StatisticsGatherer

getDataDeliveryStatistics, getDataReceiptStatistics, getMessageDeliveryStatistics, getMessageReceiptStatistics, registerMessageDelivered, registerMessageReceived, resetStatistics

Methods inherited from interface org.apache.qpid.server.util.Deletable

addDeleteTask, removeDeleteTask

Method Detail

getSessionID

long getSessionID()

setMaxFrameSize

void setMaxFrameSize(long frameMax)

getMaxFrameSize

long getMaxFrameSize()

isClosing

boolean isClosing()

flushBatched

void flushBatched()

setDeferFlush

void setDeferFlush(boolean defer)

createDeliveryMethod

ClientDeliveryMethod createDeliveryMethod(int channelId)

getLastReceivedTime

long getLastReceivedTime()

getLocalAddress

SocketAddress getLocalAddress()

Return the local socket address for the connection

Returns:

the socket address

getContextKey

org.apache.qpid.framing.AMQShortString getContextKey()

Get the context key associated with this session. Context key is described in the AMQ protocol specification (RFC 6).

Returns:

the context key

setContextKey

void setContextKey(org.apache.qpid.framing.AMQShortString contextKey)

Set the context key associated with this session. Context key is described in the AMQ protocol specification (RFC 6).

Parameters:

contextKey - the context key

getChannel

AMQChannel<T> getChannel(int channelId)

Get the channel for this session associated with the specified id. A channel id is unique per connection (i.e. per session).

Parameters:

channelId - the channel id which must be valid

Returns:

null if no channel exists, the channel otherwise

addChannel

void addChannel(AMQChannel<T> channel)
                throws org.apache.qpid.AMQException

Associate a channel with this session.

Parameters:

channel - the channel to associate with this session. It is an error to associate the same channel with more than one session but this is not validated.

Throws:

org.apache.qpid.AMQException

closeChannel

void closeChannel(int channelId)
                  throws org.apache.qpid.AMQException

Close a specific channel. This will remove any resources used by the channel, including:

• any queue subscriptions (this may in turn remove queues if they are auto delete

Parameters:

channelId - id of the channel to close

Throws:

org.apache.qpid.AMQException - if an error occurs closing the channel

IllegalArgumentException - if the channel id is not valid

closeChannel

void closeChannel(int channelId,
                org.apache.qpid.protocol.AMQConstant cause,
                String message)
                  throws org.apache.qpid.AMQException

Throws:

org.apache.qpid.AMQException

closeChannelOk

void closeChannelOk(int channelId)

Marks the specific channel as closed. This will release the lock for that channel id so a new channel can be created on that id.

Parameters:

channelId - id of the channel to close

channelAwaitingClosure

boolean channelAwaitingClosure(int channelId)

Check to see if this chanel is closing

Parameters:

channelId - id to check

Returns:

boolean with state of channel awaiting closure

removeChannel

void removeChannel(int channelId)

Remove a channel from the session but do not close it.

Parameters:

channelId -

initHeartbeats

void initHeartbeats(int delay)

Initialise heartbeats on the session.

Parameters:

delay - delay in seconds (not ms)

closeSession

void closeSession()

This must be called when the session is _closed in order to free up any resources managed by the session.

closeProtocolSession

void closeProtocolSession()

getKey

Object getKey()

Returns:

a key that uniquely identifies this session

getLocalFQDN

String getLocalFQDN()

Get the fully qualified domain name of the local address to which this session is bound. Since some servers may be bound to multiple addresses this could vary depending on the acceptor this session was created from.

Returns:

a String FQDN

getSaslServer

SaslServer getSaslServer()

Returns:

the sasl server that can perform authentication for this session.

setSaslServer

void setSaslServer(SaslServer saslServer)

Set the sasl server that is to perform authentication for this session.

Parameters:

saslServer -

setClientProperties

void setClientProperties(org.apache.qpid.framing.FieldTable clientProperties)

getReference

Object getReference()

getVirtualHost

VirtualHostImpl<?,?,?> getVirtualHost()

Specified by:

getVirtualHost in interface AMQConnectionModel<T extends AMQProtocolSession<T>,AMQChannel<T extends AMQProtocolSession<T>>>

setVirtualHost

void setVirtualHost(VirtualHostImpl<?,?,?> virtualHost)
                    throws org.apache.qpid.AMQException

Throws:

org.apache.qpid.AMQException

getProtocolOutputConverter

ProtocolOutputConverter getProtocolOutputConverter()

setAuthorizedSubject

void setAuthorizedSubject(Subject authorizedSubject)

getRemoteAddress

SocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface AMQConnectionModel<T extends AMQProtocolSession<T>,AMQChannel<T extends AMQProtocolSession<T>>>

getMethodRegistry

org.apache.qpid.framing.MethodRegistry getMethodRegistry()

Specified by:

getMethodRegistry in interface org.apache.qpid.protocol.AMQVersionAwareProtocolSession

getMethodDispatcher

org.apache.qpid.framing.MethodDispatcher getMethodDispatcher()

getClientVersion

String getClientVersion()

Specified by:

getClientVersion in interface AMQConnectionModel<T extends AMQProtocolSession<T>,AMQChannel<T extends AMQProtocolSession<T>>>

getLastIoTime

long getLastIoTime()

Specified by:

getLastIoTime in interface AMQConnectionModel<T extends AMQProtocolSession<T>,AMQChannel<T extends AMQProtocolSession<T>>>

getWrittenBytes

long getWrittenBytes()

getMaximumNumberOfChannels

Long getMaximumNumberOfChannels()

setMaximumNumberOfChannels

void setMaximumNumberOfChannels(Long value)

getChannels

List<AMQChannel<T>> getChannels()

getPeerPrincipal

Principal getPeerPrincipal()

getReceivedLock

Lock getReceivedLock()

isCloseWhenNoRoute

boolean isCloseWhenNoRoute()

Used for 0-8/0-9/0-9-1 connections to choose to close the connection when a transactional session receives a 'mandatory' message which can't be routed rather than returning the message.

isCompressionSupported

boolean isCompressionSupported()

getMessageCompressionThreshold

int getMessageCompressionThreshold()