|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AMQProtocolSession
Nested Class Summary | |
---|---|
static class |
AMQProtocolSession.ProtocolSessionIdentifier
|
static interface |
AMQProtocolSession.Task
|
Method Summary | |
---|---|
void |
addChannel(AMQChannel channel)
Associate a channel with this session. |
void |
addSessionCloseTask(AMQProtocolSession.Task task)
|
boolean |
channelAwaitingClosure(int channelId)
Check to see if this chanel is closing |
void |
closeChannel(int channelId)
Close a specific channel. |
void |
closeChannelOk(int channelId)
Markes the specific channel as closed. |
void |
closeConnection(int channelId,
org.apache.qpid.AMQConnectionException e,
boolean closeProtocolSession)
This must be called to close the session in order to free up any resources managed by the session. |
void |
closeIfLingeringClosedChannels()
|
void |
closeSession()
This must be called when the session is _closed in order to free up any resources managed by the session. |
void |
commitTransactions(AMQChannel channel)
|
void |
dataBlockReceived(org.apache.qpid.framing.AMQDataBlock message)
Called when a protocol data block is received |
AMQChannel |
getChannel(int channelId)
Get the channel for this session associated with the specified id. |
List<AMQChannel> |
getChannels()
|
Object |
getClientIdentifier()
|
org.apache.qpid.framing.FieldTable |
getClientProperties()
|
String |
getClientVersion()
|
org.apache.qpid.framing.AMQShortString |
getContextKey()
Get the context key associated with this session. |
Object |
getKey()
|
long |
getLastIoTime()
|
String |
getLocalFQDN()
Get the fully qualified domain name of the local address to which this session is bound. |
LogActor |
getLogActor()
|
long |
getMaxFrameSize()
|
Long |
getMaximumNumberOfChannels()
|
org.apache.qpid.framing.MethodDispatcher |
getMethodDispatcher()
|
org.apache.qpid.framing.MethodRegistry |
getMethodRegistry()
|
ProtocolOutputConverter |
getProtocolOutputConverter()
|
SocketAddress |
getRemoteAddress()
|
SaslServer |
getSaslServer()
|
long |
getSessionID()
|
AMQProtocolSession.ProtocolSessionIdentifier |
getSessionIdentifier()
|
VirtualHost |
getVirtualHost()
|
long |
getWrittenBytes()
|
void |
initHeartbeats(int delay)
Initialise heartbeats on the session. |
boolean |
isClosing()
|
void |
mgmtCloseChannel(int channelId)
|
void |
removeChannel(int channelId)
Remove a channel from the session but do not close it. |
void |
removeSessionCloseTask(AMQProtocolSession.Task task)
|
void |
rollbackTransactions(AMQChannel channel)
|
void |
setAuthorizedID(Principal authorizedID)
|
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 |
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(VirtualHost virtualHost)
|
Methods inherited from interface org.apache.qpid.protocol.AMQVersionAwareProtocolSession |
---|
contentBodyReceived, contentHeaderReceived, heartbeatBodyReceived, init, 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.PrincipalHolder |
---|
getPrincipal |
Methods inherited from interface org.apache.qpid.server.protocol.AMQConnectionModel |
---|
closeSession, getConnectionId |
Method Detail |
---|
long getSessionID()
LogActor getLogActor()
void setMaxFrameSize(long frameMax)
long getMaxFrameSize()
boolean isClosing()
void dataBlockReceived(org.apache.qpid.framing.AMQDataBlock message) throws Exception
message
- the data block that has been received
Exception
- if processing the datablock failsorg.apache.qpid.framing.AMQShortString getContextKey()
void setContextKey(org.apache.qpid.framing.AMQShortString contextKey)
contextKey
- the context keyAMQChannel getChannel(int channelId)
channelId
- the channel id which must be valid
void addChannel(AMQChannel channel) throws org.apache.qpid.AMQException
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.
org.apache.qpid.AMQException
void closeChannel(int channelId) throws org.apache.qpid.AMQException
channelId
- id of the channel to close
org.apache.qpid.AMQException
- if an error occurs closing the channel
IllegalArgumentException
- if the channel id is not validvoid closeChannelOk(int channelId)
channelId
- id of the channel to closeboolean channelAwaitingClosure(int channelId)
channelId
- id to check
void removeChannel(int channelId)
channelId
- void initHeartbeats(int delay)
delay
- delay in seconds (not ms)void closeSession() throws org.apache.qpid.AMQException
org.apache.qpid.AMQException
void closeConnection(int channelId, org.apache.qpid.AMQConnectionException e, boolean closeProtocolSession) throws org.apache.qpid.AMQException
org.apache.qpid.AMQException
Object getKey()
String getLocalFQDN()
SaslServer getSaslServer()
void setSaslServer(SaslServer saslServer)
saslServer
- org.apache.qpid.framing.FieldTable getClientProperties()
void setClientProperties(org.apache.qpid.framing.FieldTable clientProperties)
Object getClientIdentifier()
VirtualHost getVirtualHost()
void setVirtualHost(VirtualHost virtualHost) throws org.apache.qpid.AMQException
org.apache.qpid.AMQException
void addSessionCloseTask(AMQProtocolSession.Task task)
void removeSessionCloseTask(AMQProtocolSession.Task task)
ProtocolOutputConverter getProtocolOutputConverter()
void setAuthorizedID(Principal authorizedID)
SocketAddress getRemoteAddress()
org.apache.qpid.framing.MethodRegistry getMethodRegistry()
getMethodRegistry
in interface org.apache.qpid.protocol.AMQVersionAwareProtocolSession
org.apache.qpid.framing.MethodDispatcher getMethodDispatcher()
AMQProtocolSession.ProtocolSessionIdentifier getSessionIdentifier()
String getClientVersion()
long getLastIoTime()
long getWrittenBytes()
Long getMaximumNumberOfChannels()
void setMaximumNumberOfChannels(Long value)
void commitTransactions(AMQChannel channel) throws org.apache.qpid.AMQException
org.apache.qpid.AMQException
void rollbackTransactions(AMQChannel channel) throws org.apache.qpid.AMQException
org.apache.qpid.AMQException
List<AMQChannel> getChannels()
void closeIfLingeringClosedChannels()
void mgmtCloseChannel(int channelId)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |