rocks.xmpp.extensions.filetransfer

Class FileTransferManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.core.session.ExtensionManager

rocks.xmpp.extensions.filetransfer.FileTransferManager

public final class FileTransferManager
extends ExtensionManager

Author:

Christian Schudt

Field Summary

Fields inherited from class rocks.xmpp.core.session.ExtensionManager

features, xmppSession

Method Summary

Modifier and Type	Method and Description
void	addFileTransferOfferListener(FileTransferOfferListener fileTransferOfferListener) Adds a file transfer listener, which allows to listen for incoming file transfer requests.
void	fileTransferOffered(rocks.xmpp.core.stanza.model.client.IQ iq, String sessionId, String mimeType, FileTransferOffer fileTransferOffer, Object protocol, FileTransferNegotiator fileTransferNegotiator)
FileTransfer	offerFile(File file, String description, rocks.xmpp.core.Jid recipient, long timeout) Offers a file to another user.
void	offerFile(URL url, String description, rocks.xmpp.core.Jid recipient, long timeout) Offers a file to another user in form of an URL.
void	removeFileTransferOfferListener(FileTransferOfferListener fileTransferOfferListener) Removes a previously added file transfer listener.

Methods inherited from class rocks.xmpp.core.session.ExtensionManager

setEnabled

Methods inherited from class rocks.xmpp.core.session.Manager

isEnabled

Methods inherited from class java.lang.Object

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

Method Detail

offerFile

public void offerFile(URL url,
                      String description,
                      rocks.xmpp.core.Jid recipient,
                      long timeout)
               throws rocks.xmpp.core.XmppException

Offers a file to another user in form of an URL. The file can be downloaded by the recipient via an HTTP GET request. If this method returns without exception you can assume, that the file has been successfully downloaded by the recipient.

Parameters:

url - The URL of the file.

description - The description of the file.

recipient - The recipient's JID (must be a full JID).

timeout - The timeout (indicates how long to wait until the file has been downloaded).

Throws:

FileTransferRejectedException - If the recipient rejected the file.

rocks.xmpp.core.stanza.model.StanzaException - If the user is unavailable or failed to download the file.

NoResponseException - If the recipient did not downloaded the file within the timeout.

rocks.xmpp.core.XmppException

See Also:

XEP-0066: Out of Band Data

offerFile

public FileTransfer offerFile(File file,
                              String description,
                              rocks.xmpp.core.Jid recipient,
                              long timeout)
                       throws rocks.xmpp.core.XmppException,
                              IOException

Offers a file to another user. If this method returns successfully, the recipient has accepted the offer, the stream method has been negotiated and the file is ready to be transferred. Call FileTransfer.transfer() to start the file transfer.

Parameters:

file - The file.

description - The description of the file.

recipient - The recipient's JID (must be a full JID).

timeout - The timeout (indicates how long to wait until the file offer has either been accepted or rejected).

Returns:

The file transfer object.

Throws:

FileTransferRejectedException - If the recipient rejected the file.

rocks.xmpp.core.stanza.model.StanzaException - If the user is unavailable or failed to download the file.

NoResponseException - If the recipient did not downloaded the file within the timeout.

IOException - If the file could not be read.

rocks.xmpp.core.XmppException

fileTransferOffered

public void fileTransferOffered(rocks.xmpp.core.stanza.model.client.IQ iq,
                                String sessionId,
                                String mimeType,
                                FileTransferOffer fileTransferOffer,
                                Object protocol,
                                FileTransferNegotiator fileTransferNegotiator)

addFileTransferOfferListener

public void addFileTransferOfferListener(FileTransferOfferListener fileTransferOfferListener)

Adds a file transfer listener, which allows to listen for incoming file transfer requests.

Parameters:

fileTransferOfferListener - The listener.

See Also:

removeFileTransferOfferListener(FileTransferOfferListener)

removeFileTransferOfferListener

public void removeFileTransferOfferListener(FileTransferOfferListener fileTransferOfferListener)

Removes a previously added file transfer listener.

Parameters:

fileTransferOfferListener - The listener.

See Also:

addFileTransferOfferListener(FileTransferOfferListener)