Package org.jivesoftware.smackx.filetransfer

Class OutgoingFileTransfer

  • public class OutgoingFileTransfer
extends FileTransfer
    Handles the sending of a file to another user. File transfer's in jabber have several steps and there are several methods in this class that handle these steps differently.

    • Method Detail

      • getResponseTimeout

        public static int getResponseTimeout()
        Returns the time in milliseconds after which the file transfer negotiation process will timeout if the other user has not responded.
        Returns:
        Returns the time in milliseconds after which the file transfer negotiation process will timeout if the remote user has not responded.

      • setResponseTimeout

        public static void setResponseTimeout​(int responseTimeout)
        Sets the time in milliseconds after which the file transfer negotiation process will timeout if the other user has not responded.
        Parameters:
        responseTimeout - TODO javadoc me please The timeout time in milliseconds.

      • getOutputStream

        protected OutputStream getOutputStream()
        Returns the output stream connected to the peer to transfer the file. It is only available after it has been successfully negotiated by the StreamNegotiator.
        Returns:
        Returns the output stream connected to the peer to transfer the file.

      • sendFile

        public OutputStream sendFile​(String fileName,
                             long fileSize,
                             String description)
                      throws XMPPException,
                             SmackException,
                             InterruptedException
        This method handles the negotiation of the file transfer and the stream, it only returns the created stream after the negotiation has been completed.
        Parameters:
        fileName - TODO javadoc me please The name of the file that will be transmitted. It is preferable for this name to have an extension as it will be used to determine the type of file it is.
        fileSize - TODO javadoc me please The size in bytes of the file that will be transmitted.
        description - TODO javadoc me please A description of the file that will be transmitted.
        Returns:
        The OutputStream that is connected to the peer to transmit the file.
        Throws:
        XMPPException - if an XMPP protocol error was received. Thrown if an error occurs during the file transfer negotiation process.
        SmackException - if there was no response from the server.
        InterruptedException - if the calling thread was interrupted.

      • sendFile

        public void sendFile​(String fileName,
                     long fileSize,
                     String description,
                     OutgoingFileTransfer.NegotiationProgress progress)
        This methods handles the transfer and stream negotiation process. It returns immediately and its progress will be updated through the OutgoingFileTransfer.NegotiationProgress callback.
        Parameters:
        fileName - TODO javadoc me please The name of the file that will be transmitted. It is preferable for this name to have an extension as it will be used to determine the type of file it is.
        fileSize - TODO javadoc me please The size in bytes of the file that will be transmitted.
        description - TODO javadoc me please A description of the file that will be transmitted.
        progress - TODO javadoc me please A callback to monitor the progress of the file transfer negotiation process and to retrieve the OutputStream when it is complete.

      • sendFile

        public void sendFile​(File file,
                     String description)
              throws SmackException
        This method handles the stream negotiation process and transmits the file to the remote user. It returns immediately and the progress of the file transfer can be monitored through several methods:
        Parameters:
        file - the file to transfer to the remote entity.
        description - a description for the file to transfer.
        Throws:
        SmackException - if Smack detected an exceptional situation. If there is an error during the negotiation process or the sending of the file.

      • sendStream

        public void sendStream​(InputStream in,
                       String fileName,
                       long fileSize,
                       String description)
        This method handles the stream negotiation process and transmits the file to the remote user. It returns immediately and the progress of the file transfer can be monitored through several methods:
        Parameters:
        in - the stream to transfer to the remote entity.
        fileName - the name of the file that is transferred
        fileSize - the size of the file that is transferred
        description - a description for the file to transfer.

      • getBytesSent

        public long getBytesSent()
        Returns the amount of bytes that have been sent for the file transfer. Or -1 if the file transfer has not started.

        Note: This method is only useful when the sendFile(File, String) method is called, as it is the only method that actually transmits the file.

        Returns:
        Returns the amount of bytes that have been sent for the file transfer. Or -1 if the file transfer has not started.