abs.ixi.client.net

Class SFCMConnection

java.lang.Object

abs.ixi.client.net.TCPConnection

abs.ixi.client.net.SFCMConnection

All Implemented Interfaces:

Identifiable<String>, Connection, NegotiatedConnection, AutoCloseable

public class SFCMConnection
extends TCPConnection
implements NegotiatedConnection

An implementation of TCPConnection used for transfering files using Stringflow Content Model. The implementation preserves all the sementics of a TCPConnection; additionally it has a state flag to indicate if the connection is ready for file transfer in either direction.

Stringflow Content Model (SFCM) mandates that once there is physical connection established with server, server assigns a SID to the connection and this SID must be communicated to server on an authenticated stream.

Author:

Yogi

Field Summary

Fields inherited from class abs.ixi.client.net.TCPConnection

isConnected

Constructor Summary

Constructors

Constructor and Description
SFCMConnection(ConnectionConfig config)

Method Summary

Modifier and Type	Method and Description
void	clearNegotiatedStatus() Clear the negotiated status of this connection; meaning the negotiated status will be changed to false.
void	clearSid() Clear sid for this connection,
void	close() It close the physical connection.
String	getSid() Returns negotiated connection sid, if connection is not negotiated then it sid will be null.
boolean	isNegotiated() Connection implementation with protocol semantics, generally, involves negotiating a packet stream; for example XMPP connections requires XMPP stream to be negotiated before user packets can be sent/received on the connection.
boolean	isReady() Checks that connection is ready for file transmission.
void	negotiationComplete() Set the negotiated status for this connection
void	setSid(String sid) After negotiation completion successfully, update this sid with server assigned connection id.

Methods inherited from class abs.ixi.client.net.TCPConnection

connect, getConnConfig, getId, getLastActivity, isConnected, read, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface abs.ixi.client.net.Connection

connect, getId, getLastActivity, isConnected, read, write, write

Constructor Detail

SFCMConnection

public SFCMConnection(ConnectionConfig config)

Method Detail

isNegotiated

public boolean isNegotiated()

Description copied from interface: NegotiatedConnection

Connection implementation with protocol semantics, generally, involves negotiating a packet stream; for example XMPP connections requires XMPP stream to be negotiated before user packets can be sent/received on the connection.

Specified by:

isNegotiated in interface NegotiatedConnection

Returns:

true if the negotiation has been completed on this connection and the connection is ready for file transfer

negotiationComplete

public void negotiationComplete()

Set the negotiated status for this connection

Specified by:

negotiationComplete in interface NegotiatedConnection

clearNegotiatedStatus

public void clearNegotiatedStatus()

Clear the negotiated status of this connection; meaning the negotiated status will be changed to false.

clearSid

public void clearSid()

Clear sid for this connection,

getSid

public String getSid()

Returns negotiated connection sid, if connection is not negotiated then it sid will be null.

Returns:

String

setSid

public void setSid(String sid)

After negotiation completion successfully, update this sid with server assigned connection id.

Parameters:

sid - sid

isReady

public boolean isReady()

Checks that connection is ready for file transmission.

Returns:

true if connection is physically connection and connection is already negotiated and sid is assigned to this connection.

close

public void close()
           throws IOException

It close the physical connection. and clear negotiated status and sid. status.

Specified by:

close in interface Connection

Specified by:

close in interface AutoCloseable

Overrides:

close in class TCPConnection

Throws:

IOException - IOException