abs.ixi.client.io

Class XMPPStreamManager

java.lang.Object

abs.ixi.client.core.AbstractPacketForwarder

abs.ixi.client.io.XMPPStreamManager

All Implemented Interfaces:

PacketCollector, PacketForwarder, XMPPStream, ConnectionStateObserver

public class XMPPStreamManager
extends AbstractPacketForwarder
implements PacketCollector, XMPPStream

XMPPStreamManager is responsible for managing XMPP stream with server. It governs the overall stream and hence the communication with server. Being a central entity, all the inbound and outbound packets pass through it.

Author:

Yogi

Constructor Summary

Constructors

Constructor and Description
XMPPStreamManager(XMPPConnection connection) Instantiate XMPPStreamManager with given XMPPConnection.

Method Summary

Modifier and Type	Method and Description
void	closed() Called when connection is closed
void	closeStream() Close the ongoing stream.
void	closingConnection() Method call to inform the dependent entities that after this method call the connection will be closed.
void	collect(Packet packet) This collector takes the given packet.
void	connected() Invoked when physical connection is established with server.
void	resetStream() Reset Stream to its initial state.
StreamNegotiator.NegotiationResult	restartStream() Restart a broken stream.
boolean	sendPacketAsync(Stanza stanza) Send stanza packet to server; Stanza packets are delivered to server asynchronously.This methos simply adds the stanza to Writer queue and Writer thread will write the stanza whenver stream is ready
void	shutdown() Initiate stream manager shutdown sequence.
StreamNegotiator.NegotiationResult	startStream(String userName, String pwd, String domain) Start a stream with server for the first time.

Methods inherited from class abs.ixi.client.core.AbstractPacketForwarder

addPacketCollector, addPacketCollector, forwardDefault, forwardPacket, removePacketCollector, removePacketCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

XMPPStreamManager

public XMPPStreamManager(XMPPConnection connection)

Instantiate XMPPStreamManager with given XMPPConnection. The assumption is that supplied connection will be already connected to the remote server.

Parameters:

connection - underlying connection

Method Detail

startStream

public StreamNegotiator.NegotiationResult startStream(String userName,
                                                      String pwd,
                                                      String domain)
                                               throws NetworkException

Start a stream with server for the first time. If the stream is already open, it should be restarted. While the stream negotiations are in progress, negotiating flag is turned on.

Specified by:

startStream in interface XMPPStream

Parameters:

userName - userName

pwd - pwd

domain - domain

Returns:

NegotiationResult NegotiationResult

Throws:

NetworkException - NetworkException

restartStream

public StreamNegotiator.NegotiationResult restartStream()
                                                 throws NetworkException

Description copied from interface: XMPPStream

Restart a broken stream. For stream restart, underlying connection is reconnected with server and a new stream is negotiated with the server. The connection uses the previously used ConnectionConfig and user session data to restablish the connection and autentication. Essentially, the broken connection is re-established.

Stream negotiations are done synchronously. The method returns when stream negotiation is finished.

Specified by:

restartStream in interface XMPPStream

Returns:

NegotiationResult NegotiationResult

Throws:

NetworkException - NetworkException

collect

public void collect(Packet packet)

Description copied from interface: PacketCollector

This collector takes the given packet. The collector may employ further filtering and may decide to ignore/drop this packet.

Specified by:

collect in interface PacketCollector

Parameters:

packet - packet instance to be collected

sendPacketAsync

public boolean sendPacketAsync(Stanza stanza)

Send stanza packet to server; Stanza packets are delivered to server asynchronously.This methos simply adds the stanza to Writer queue and Writer thread will write the stanza whenver stream is ready

Parameters:

stanza - packet which will be written on the wire

Returns:

if the packet is a stanza packet, a true value indicates that the packet was added to the queue and a false value indicates that the queue was full and the packet could not be added to the queue.

closeStream

public void closeStream()
                 throws NetworkException

Description copied from interface: XMPPStream

Close the ongoing stream. closing a stream does not destroy/offload any object from memory. This is a protocol level action which simply informs server to close the ongoing stream. All the objects along with physical connection with server is kept intact.

Specified by:

closeStream in interface XMPPStream

Throws:

NetworkException - if an IO error occurrs while sending packet

shutdown

public void shutdown()

Initiate stream manager shutdown sequence. During stream manager shutdown, an attemp is made to gracefully close the ongoing stream with server. Further, StreamContext state is reset, Reader and Writer are shutdown.

connected

public void connected()

Description copied from interface: ConnectionStateObserver

Invoked when physical connection is established with server. This could be first time when tcp connection is extablished with the server or reconnected

Specified by:

connected in interface ConnectionStateObserver

closingConnection

public void closingConnection()

Description copied from interface: ConnectionStateObserver

Method call to inform the dependent entities that after this method call the connection will be closed.

Specified by:

closingConnection in interface ConnectionStateObserver

closed

public void closed()

Description copied from interface: ConnectionStateObserver

Called when connection is closed

Specified by:

closed in interface ConnectionStateObserver

resetStream

public void resetStream()

Description copied from interface: XMPPStream

Reset Stream to its initial state.

Specified by:

resetStream in interface XMPPStream