org.apache.qpid.client.protocol

Class AMQProtocolSession

java.lang.Object

org.apache.qpid.client.protocol.AMQProtocolSession

All Implemented Interfaces:

AMQProtocolWriter, AMQVersionAwareProtocolSession, ProtocolVersionAware

public class AMQProtocolSession
extends Object
implements AMQVersionAwareProtocolSession

Wrapper for protocol session that provides type-safe access to session attributes.

The underlying protocol session is still available but clients should not use it to obtain session attributes.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	_logger
static int	MAX_CHANNEL_MAX
static int	MIN_USABLE_CHANNEL_NUM

Constructor Summary

Constructors

Constructor and Description
AMQProtocolSession(AMQProtocolHandler protocolHandler, AMQConnection connection)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	channelClosed(int channelId, int code, String text) Called from the ChannelClose handler when a channel close frame is received.
void	closeProtocolSession()
void	closeSession(AMQSession<?,?> session) Starts the process of closing a session
void	confirmConsumerCancelled(int channelId, AMQShortString consumerTag)
void	contentBodyReceived(int channelId, ContentBody contentBody)
void	contentHeaderReceived(int channelId, ContentHeaderBody contentHeader)
AMQConnection	getAMQConnection()
String	getClientID()
protected AMQConnection	getConnection()
ConnectionSettings	getConnectionSettings()
FieldTable	getConnectionStartServerProperties()
ConnectionTuneParameters	getConnectionTuneParameters()
MethodDispatcher	getMethodDispatcher()
FrameCreatingMethodProcessor	getMethodProcessor()
MethodRegistry	getMethodRegistry() Gets the method registry for a specific version of the AMQP.
ProtocolVersion	getProtocolVersion()
SaslClient	getSaslClient()
ByteBufferSender	getSender()
protected AMQSession	getSession(int channelId)
AMQStateManager	getStateManager()
String	getVirtualHost()
void	heartbeatBodyReceived(int channelId, HeartbeatBody body)
void	init(ConnectionSettings settings)
void	methodFrameReceived(int channelId, AMQMethodBody amqMethodBody)
void	notifyError(Exception error)
void	setClientID(String clientID)
void	setConnectionStartServerProperties(FieldTable serverProperties)
void	setFlowControl(int channelId, boolean active)
void	setMaxFrameSize(long frameMax)
void	setProtocolVersion(ProtocolVersion pv)
void	setSaslClient(SaslClient client) Store the SASL client currently being used for the authentication handshake
void	setSender(ByteBufferSender sender)
void	setTicket(int ticket, int channelId)
String	toString()
void	tuneConnection(ConnectionTuneParameters params)
void	unprocessedMessageReceived(int channelId, UnprocessedMessage message) Callback invoked from the BasicDeliverMethodHandler when a message has been received.
void	writeFrame(AMQDataBlock frame) Writes a frame to the wire, encoding it as necessary, for example, into a sequence of bytes.

Methods inherited from class java.lang.Object

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

Field Detail

_logger

protected static final org.slf4j.Logger _logger

MAX_CHANNEL_MAX

public static final int MAX_CHANNEL_MAX

See Also:

Constant Field Values

MIN_USABLE_CHANNEL_NUM

public static final int MIN_USABLE_CHANNEL_NUM

See Also:

Constant Field Values

Constructor Detail

AMQProtocolSession

public AMQProtocolSession(AMQProtocolHandler protocolHandler,
                  AMQConnection connection)

Method Detail

init

public void init(ConnectionSettings settings)

getConnectionSettings

public ConnectionSettings getConnectionSettings()

getConnectionTuneParameters

public ConnectionTuneParameters getConnectionTuneParameters()

tuneConnection

public void tuneConnection(ConnectionTuneParameters params)

getClientID

public String getClientID()

setClientID

public void setClientID(String clientID)
                 throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getStateManager

public AMQStateManager getStateManager()

getVirtualHost

public String getVirtualHost()

getSaslClient

public SaslClient getSaslClient()

setSaslClient

public void setSaslClient(SaslClient client)

Store the SASL client currently being used for the authentication handshake

Parameters:

client - if non-null, stores this in the session. if null clears any existing client being stored

unprocessedMessageReceived

public void unprocessedMessageReceived(int channelId,
                              UnprocessedMessage message)
                                throws QpidException

Callback invoked from the BasicDeliverMethodHandler when a message has been received.

Throws:

QpidException - if this was not expected

contentHeaderReceived

public void contentHeaderReceived(int channelId,
                         ContentHeaderBody contentHeader)
                           throws QpidException

Specified by:

contentHeaderReceived in interface AMQVersionAwareProtocolSession

Throws:

QpidException

contentBodyReceived

public void contentBodyReceived(int channelId,
                       ContentBody contentBody)
                         throws QpidException

Specified by:

contentBodyReceived in interface AMQVersionAwareProtocolSession

Throws:

QpidException

heartbeatBodyReceived

public void heartbeatBodyReceived(int channelId,
                         HeartbeatBody body)
                           throws QpidException

Specified by:

heartbeatBodyReceived in interface AMQVersionAwareProtocolSession

Throws:

QpidException

getSession

protected AMQSession getSession(int channelId)

writeFrame

public void writeFrame(AMQDataBlock frame)

Description copied from interface: AMQProtocolWriter

Writes a frame to the wire, encoding it as necessary, for example, into a sequence of bytes.

Specified by:

writeFrame in interface AMQProtocolWriter

Parameters:

frame - The frame to be encoded and written.

closeSession

public void closeSession(AMQSession<?,?> session)

Starts the process of closing a session

Parameters:

session - the AMQSession being closed

channelClosed

public boolean channelClosed(int channelId,
                    int code,
                    String text)
                      throws QpidException

Called from the ChannelClose handler when a channel close frame is received. This method decides whether this is a response or an initiation. The latter case causes the AMQSession to be closed and an exception to be thrown if appropriate.

Parameters:

channelId - the id of the channel (session)

Returns:

true if the client must respond to the server, i.e. if the server initiated the channel close, false if the channel close is just the server responding to the client's earlier request to close the channel.

Throws:

QpidException

getAMQConnection

public AMQConnection getAMQConnection()

closeProtocolSession

public void closeProtocolSession()
                          throws QpidException

Throws:

QpidException

getSender

public ByteBufferSender getSender()

confirmConsumerCancelled

public void confirmConsumerCancelled(int channelId,
                            AMQShortString consumerTag)

setProtocolVersion

public void setProtocolVersion(ProtocolVersion pv)

getProtocolVersion

public ProtocolVersion getProtocolVersion()

Specified by:

getProtocolVersion in interface ProtocolVersionAware

getMethodRegistry

public MethodRegistry getMethodRegistry()

Description copied from interface: AMQVersionAwareProtocolSession

Gets the method registry for a specific version of the AMQP.

Specified by:

getMethodRegistry in interface AMQVersionAwareProtocolSession

Returns:

The method registry for a specific version of the AMQP.

getMethodDispatcher

public MethodDispatcher getMethodDispatcher()

setTicket

public void setTicket(int ticket,
             int channelId)

setFlowControl

public void setFlowControl(int channelId,
                  boolean active)

methodFrameReceived

public void methodFrameReceived(int channelId,
                       AMQMethodBody amqMethodBody)
                         throws QpidException

Specified by:

methodFrameReceived in interface AMQVersionAwareProtocolSession

Throws:

QpidException

notifyError

public void notifyError(Exception error)

setSender

public void setSender(ByteBufferSender sender)

Specified by:

setSender in interface AMQVersionAwareProtocolSession

toString

public String toString()

Overrides:

toString in class Object

getConnection

protected AMQConnection getConnection()

setConnectionStartServerProperties

public void setConnectionStartServerProperties(FieldTable serverProperties)

getConnectionStartServerProperties

public FieldTable getConnectionStartServerProperties()

setMaxFrameSize

public void setMaxFrameSize(long frameMax)

getMethodProcessor

public FrameCreatingMethodProcessor getMethodProcessor()