Smack/smack-experimental/src/main/java/org/jivesoftware/smackx/jingle_filetransfer/component/JingleFileTransfer.java

/**
 *
 * Copyright 2017 Paul Schaub
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jivesoftware.smackx.jingle_filetransfer.component;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.jivesoftware.smack.SmackException;
import org.jivesoftware.smack.XMPPConnection;
import org.jivesoftware.smackx.jingle.component.JingleDescription;
import org.jivesoftware.smackx.jingle.element.JingleReasonElement;
import org.jivesoftware.smackx.jingle_filetransfer.controller.JingleFileTransferController;
import org.jivesoftware.smackx.jingle_filetransfer.element.JingleFileTransferElement;
import org.jivesoftware.smackx.jingle_filetransfer.listener.ProgressListener;

/**
 * Base class of a Jingle File Transfer.
 */
public abstract class JingleFileTransfer extends JingleDescription<JingleFileTransferElement> implements JingleFileTransferController {

    public static final String NAMESPACE_V5 = "urn:xmpp:jingle:apps:file-transfer:5";
    public static final String NAMESPACE = NAMESPACE_V5;

    protected State state;
    protected JingleFile metadata;
    protected float percentage;

    private final List<ProgressListener> progressListeners = Collections.synchronizedList(new ArrayList<ProgressListener>());

    /**
     * Create a new JingleFileTransfer.
     * @param metadata metadata of the transferred file.
     */
    JingleFileTransfer(JingleFile metadata) {
        this.metadata = metadata;
    }

    /**
     * Is this a file offer?
     * @return file offer?
     */
    public abstract boolean isOffer();

    /**
     * Is this a file request?
     * @return file request?
     */
    public abstract boolean isRequest();

    @Override
    public void addProgressListener(ProgressListener listener) {
        progressListeners.add(listener);
        //TODO: Notify new listener?
    }

    @Override
    public void removeProgressListener(ProgressListener listener) {
        progressListeners.remove(listener);
    }

    @Override
    public void cancel(XMPPConnection connection) throws SmackException.NotConnectedException, InterruptedException {
        getParent().onContentCancel();
        state = State.cancelled;
    }

    /**
     * Notify ProgressListeners, that the transmission has started. This happens after the negotiation is complete,
     * when the transports are ready.
     */
    public void notifyProgressListenersStarted() {
        for (ProgressListener p : progressListeners) {
            p.started();
        }
    }

    /**
     * Notify ProgressListeners, that the transmission has been terminated. This might happen at all times during the
     * lifetime of the session.
     * @param reason reason of termination.
     */
    public void notifyProgressListenersTerminated(JingleReasonElement.Reason reason) {
        for (ProgressListener p : progressListeners) {
            p.terminated(reason);
        }
    }

    /**
     * Return progress as a float value between 0 and 1.
     * If the transmission has not yet started, return -1.
     * @return -1 or percentage in [0,1]
     */
    public float getPercentage() {
        if (state == State.pending || state == State.negotiating) {
            return -1f;
        }

        return percentage;
    }

    @Override
    public String getNamespace() {
        return JingleFileTransfer.NAMESPACE;
    }

    @Override
    public void handleContentTerminate(JingleReasonElement.Reason reason) {
        notifyProgressListenersTerminated(reason);
    }

    @Override
    public JingleFileTransferElement getElement() {
        return new JingleFileTransferElement(metadata.getElement());
    }

    @Override
    public State getState() {
        return state;
    }

    @Override
    public JingleFile getMetadata() {
        return metadata;
    }
}