rocks.xmpp.extensions.filetransfer.FileTransfer Maven / Gradle / Ivy
/*
* The MIT License (MIT)
*
* Copyright (c) 2014-2016 Christian Schudt
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package rocks.xmpp.extensions.filetransfer;
import rocks.xmpp.util.XmppUtils;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.EnumSet;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
/**
* A class for managing a single file transfer.
* It allows to monitor the progress and status of a file transfer by {@linkplain #addFileTransferStatusListener(Consumer) adding a listener}.
*
* @author Christian Schudt
*/
public final class FileTransfer {
private final long length;
private final InputStream inputStream;
private final OutputStream outputStream;
private final Set> fileTransferStatusListeners = new CopyOnWriteArraySet<>();
private final ExecutorService executorService;
private final String sessionId;
private final AtomicReference status = new AtomicReference<>(Status.INITIAL);
private volatile Exception exception;
private volatile long bytesTransferred;
public FileTransfer(String sessionId, InputStream inputStream, OutputStream outputStream, long length) {
this.inputStream = inputStream;
this.outputStream = outputStream;
this.length = length;
this.sessionId = sessionId;
this.executorService = Executors.newSingleThreadExecutor();
}
/**
* Adds a file transfer status listener, which allows to listen for file transfer status changes.
*
* @param fileTransferStatusListener The listener.
* @see #removeFileTransferStatusListener(Consumer)
*/
public final void addFileTransferStatusListener(Consumer fileTransferStatusListener) {
fileTransferStatusListeners.add(fileTransferStatusListener);
}
/**
* Removes a previously added file transfer status listener.
*
* @param fileTransferStatusListener The listener.
* @see #addFileTransferStatusListener(Consumer)
*/
public final void removeFileTransferStatusListener(Consumer fileTransferStatusListener) {
fileTransferStatusListeners.remove(fileTransferStatusListener);
}
private void notifyFileTransferStatusListeners() {
XmppUtils.notifyEventListeners(fileTransferStatusListeners, new FileTransferStatusEvent(this, status.get(), bytesTransferred));
}
/**
* Gets the status of the file transfer.
*
* @return The status.
*/
public final Status getStatus() {
return status.get();
}
private void updateStatus(Status status) {
if (this.status.getAndSet(status) != status) {
notifyFileTransferStatusListeners();
}
}
private void updateStatusIf(Status expected, Status status) {
if (this.status.compareAndSet(expected, status)) {
notifyFileTransferStatusListeners();
}
}
/**
* Returns true, if the file transfer is done, i.e. neither in progress nor in initial status.
*
* @return True, if the file transfer is done.
*/
public final boolean isDone() {
return EnumSet.of(Status.CANCELED, Status.COMPLETED, Status.FAILED, Status.REJECTED).contains(status.get());
}
/**
* Gets the transferred bytes.
*
* @return The transferred bytes.
*/
public long getBytesTransferred() {
return bytesTransferred;
}
private void setBytesTransferred(final long bytesTransferred) {
if (this.bytesTransferred == bytesTransferred)
return;
this.bytesTransferred = bytesTransferred;
notifyFileTransferStatusListeners();
}
private void addBytesTransferred(final long bytesTransferredAdditionally) {
setBytesTransferred(bytesTransferred + bytesTransferredAdditionally);
}
/**
* Gets the progress of the file transfer.
*
* @return A value between 0 and 1 indicating the progress or -1 if the progress is unknown.
*/
public final double getProgress() {
if (length != 0) {
return (double) getBytesTransferred() / length;
}
return -1;
}
/**
* Transfers the file in its own thread.
*
* @return The future which is done when transferring is complete.
*/
public final Future> transfer() {
return executorService.submit(() -> {
byte[] buffer = new byte[8192];
int len;
bytesTransferred = 0;
updateStatus(Status.IN_PROGRESS);
try {
while ((len = inputStream.read(buffer)) > -1 && status.get() != Status.CANCELED) {
outputStream.write(buffer, 0, len);
addBytesTransferred(len);
}
if (bytesTransferred != length && status.get() != Status.CANCELED) {
updateStatus(Status.FAILED);
}
} catch (IOException e) {
exception = e;
updateStatus(Status.FAILED);
} finally {
// Close the streams
try {
try {
inputStream.close();
} catch (IOException e) {
exception = e;
updateStatus(Status.FAILED);
}
try {
outputStream.close();
} catch (IOException e) {
exception = e;
updateStatus(Status.FAILED);
}
} finally {
updateStatusIf(Status.IN_PROGRESS, Status.COMPLETED);
}
}
}
);
}
/**
* Cancels the file transfer.
*/
public void cancel() {
updateStatus(Status.CANCELED);
}
/**
* Gets the session id for this file transfer session.
*
* @return The session id.
*/
public final String getSessionId() {
return sessionId;
}
/**
* Gets the exception if the status is {@link rocks.xmpp.extensions.filetransfer.FileTransfer.Status#FAILED}
*
* @return The exception or null.
*/
public final Exception getException() {
return exception;
}
/**
* The status of the file transfer.
*/
public enum Status {
/**
* Indicates that the file transfer request has not been accepted yet.
*/
INITIAL,
/**
* Indicates that the file transfer has been cancelled.
*/
CANCELED,
/**
* Indicates that the file transfer has been completed successfully.
*/
COMPLETED,
/**
* Indicates that the file transfer failed.
*/
FAILED,
/**
* Indicates that the file transfer is in progress, i.e. bytes are currently streamed.
*/
IN_PROGRESS,
/**
* Indicates that the file transfer request has been rejected.
*/
REJECTED
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy