abs.ixi.client.file.sfcm

Class FileTransferManager

java.lang.Object

abs.ixi.client.file.sfcm.FileTransferManager

All Implemented Interfaces:

Initializable

public class FileTransferManager
extends Object
implements Initializable

FileTransferManager is application facing class used to setup ability to transfer files across the network.

XMPP as a protocol is not suitable for media/file transfer; it allows to plug-in other technologies for media transfer. In addition to the various technologies such as SOCKS5, Out-of-band transfer etc, Stringflow has its Proprietary content model to transfer media content.

Stringflow content model uses MIME as underlying technology to transfer media. As recommended in various XEP specifications, media transfer negotiations take place on the XMPP stream; however the media/file is transferred on a TCP connection as a MIME message. When a user wants to transfer a media to another user, Stringflow transfers the thumb nail image, media type and size to the destination user over XMPP message stream keeping message ordering in place and real-time. Simultaneously, a request to transfer the file is handed-over to FileTransferManager to transfer the file in background.

Author:

Yogi

Method Summary

Modifier and Type	Method and Description
static FileTransferManager	getInstance()
void	init() Initialize this instance
boolean	isInitialized() Check if the FileTransferManager instance has been initialized
void	setFileReceiveRequestFilter(InboundFileTransferFilter fileReceiveRequestFilter)
void	setFileSupplier(FileInstanceSupplier fileSupplier)
void	setXmppStreamManager(XMPPStreamManager xmppStreamManager)
void	shutdown() Shutdown FileTransferManager
FileTransferFuture	transferFileInbound(JID from, String fileId, ContentType contentType) File thumb and its unique id is transferred to receiver immediately.
void	transferFileInbound(JID from, String fileId, ContentType contentType, Callback<File,FileTransfer.FailureReason> callback) File thumb and its unique id is transferred to receiver immediately.
FileTransferFuture	transferFileOutbound(String mediaId, File file, ContentType contentType, JID to)
void	transferFileOutbound(String messageId, File file, ContentType contentType, JID to, Callback<String,FileTransfer.FailureReason> callback) Sends message with MediaContent to media receiver.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static FileTransferManager getInstance()

init

public void init()
          throws InitializationErrorException

Initialize this instance

Specified by:

init in interface Initializable

Throws:

InitializationErrorException - if any exception/error encountered while executing initialization hook

transferFileInbound

public void transferFileInbound(JID from,
                                String fileId,
                                ContentType contentType,
                                Callback<File,FileTransfer.FailureReason> callback)

File thumb and its unique id is transferred to receiver immediately. This method is to pull that file from Server. When this method is invoked, the client already had the file thumb, it's unique id and sender JID.

Receiving a file involves sending an IQ stanza to server requesting file download. On success result of the IQ, client initiates a MIME Connection with the server on which server writes the file.

Parameters:

from - JID

fileId - string

contentType - ContentType

callback - Callback

transferFileInbound

public FileTransferFuture transferFileInbound(JID from,
                                              String fileId,
                                              ContentType contentType)

File thumb and its unique id is transferred to receiver immediately. This method is to pull that file from Server. When this method is invoked, the client already had the file thumb, it's unique id and sender JID.

Receiving a file involves sending an IQ stanza to server requesting file download. On success result of the IQ, client initiates a MIME Connection with the server on which server writes the file.

Parameters:

from - JID

fileId - string

contentType - ContentType

Returns:

FileTransferFuture fileTransferFuture

transferFileOutbound

public FileTransferFuture transferFileOutbound(String mediaId,
                                               File file,
                                               ContentType contentType,
                                               JID to)

transferFileOutbound

public void transferFileOutbound(String messageId,
                                 File file,
                                 ContentType contentType,
                                 JID to,
                                 Callback<String,FileTransfer.FailureReason> callback)

Sends message with MediaContent to media receiver. And uploads given file to Stringflow server.

Parameters:

messageId - Id for media message

file - File object of media

contentType - ContentType of media file

to - JID of media message receiver

callback - callback to know file transfer status

setXmppStreamManager

public void setXmppStreamManager(XMPPStreamManager xmppStreamManager)

setFileSupplier

public void setFileSupplier(FileInstanceSupplier fileSupplier)

setFileReceiveRequestFilter

public void setFileReceiveRequestFilter(InboundFileTransferFilter fileReceiveRequestFilter)

isInitialized

public boolean isInitialized()

Check if the FileTransferManager instance has been initialized

Returns:

true if this instance has been initialized otherwise false

shutdown

public void shutdown()
              throws IOException

Shutdown FileTransferManager

Throws:

IOException - ioexception