rocks.xmpp.extensions.bytestreams.ibb.InBandByteStreamManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xmpp-extensions-client Show documentation
Client side business logic for XMPP extensions
There is a newer version: 0.9.1
Show newest version
/*
 * 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.bytestreams.ibb;

import rocks.xmpp.addr.Jid;
import rocks.xmpp.core.session.XmppSession;
import rocks.xmpp.core.stanza.AbstractIQHandler;
import rocks.xmpp.core.stanza.IQHandler;
import rocks.xmpp.core.stanza.MessageEvent;
import rocks.xmpp.core.stanza.model.IQ;
import rocks.xmpp.core.stanza.model.StanzaError;
import rocks.xmpp.core.stanza.model.errors.Condition;
import rocks.xmpp.extensions.bytestreams.ByteStreamManager;
import rocks.xmpp.extensions.bytestreams.ByteStreamSession;
import rocks.xmpp.extensions.bytestreams.ibb.model.InBandByteStream;
import rocks.xmpp.util.XmppUtils;
import rocks.xmpp.util.concurrent.AsyncResult;

import java.io.IOException;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Consumer;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * A manager for XEP-0047: In-Band Bytestreams. IBB streams use the same transport as XMPP, i.e. the same TCP or BOSH connection.
 * 
 * To initiate an IBB session with another entity, use {@link #initiateSession(Jid, String, int)}.
 * 
 * This class is thread-safe.
 *
 * @author Christian Schudt
 * @see XEP-0047: In-Band Bytestreams
 */
public final class InBandByteStreamManager extends ByteStreamManager {

    private static final Logger logger = Logger.getLogger(InBandByteStreamManager.class.getName());

    final Map ibbSessionMap = new ConcurrentHashMap<>();

    private final IQHandler openIQHandler;

    private final IQHandler dataIQHandler;

    private final IQHandler closeIQHandler;

    private final Consumer messageListener;

    private InBandByteStreamManager(final XmppSession xmppSession) {
        super(xmppSession);
        openIQHandler = new AbstractIQHandler(IQ.Type.SET) {
            @Override
            protected IQ processRequest(IQ iq) {
                InBandByteStream.Open open = iq.getExtension(InBandByteStream.Open.class);
                if (open.getBlockSize() > 65535) {
                    return iq.createError(new StanzaError(StanzaError.Type.MODIFY, rocks.xmpp.core.stanza.model.errors.Condition.RESOURCE_CONSTRAINT));
                } else {
                    // Somebody wants to create a IBB session with me.
                    // Notify the listeners.
                    XmppUtils.notifyEventListeners(byteStreamListeners, new IbbEvent(InBandByteStreamManager.this, open.getSessionId(), xmppSession, iq, open.getBlockSize()));
                    return null;
                }
            }
        };
        dataIQHandler = new AbstractIQHandler(IQ.Type.SET) {
            @Override
            protected IQ processRequest(IQ iq) {
                InBandByteStream.Data data = iq.getExtension(InBandByteStream.Data.class);
                IbbSession ibbSession = ibbSessionMap.get(data.getSessionId());
                // Data has been received for a session, so notify the IBB session about it.
                if (ibbSession != null) {
                    if (ibbSession.dataReceived(data)) {
                        return iq.createResult();
                    } else {
                        // 2. Because the sequence number has already been used, the recipient returns an  error with a type of 'cancel'.
                        return iq.createError(new StanzaError(StanzaError.Type.CANCEL, rocks.xmpp.core.stanza.model.errors.Condition.UNEXPECTED_REQUEST));
                    }
                } else {
                    return iq.createError(Condition.ITEM_NOT_FOUND);
                }
            }
        };
        closeIQHandler = new AbstractIQHandler(IQ.Type.SET) {
            @Override
            protected IQ processRequest(IQ iq) {
                // Must be a close element.
                InBandByteStream.Close close = iq.getExtension(InBandByteStream.Close.class);
                IbbSession ibbSession = ibbSessionMap.get(close.getSessionId());
                if (ibbSession != null) {
                    try {
                        ibbSessionMap.remove(close.getSessionId());
                        ibbSession.closedByPeer();
                        return iq.createResult();
                    } catch (IOException e1) {
                        logger.log(Level.WARNING, e1.getMessage(), e1);
                        return iq.createResult();
                    }
                } else {
                    return iq.createError(Condition.ITEM_NOT_FOUND);
                }
            }
        };
        messageListener = e -> {
            if (isEnabled()) {
                InBandByteStream.Data data = e.getMessage().getExtension(InBandByteStream.Data.class);
                if (data != null) {
                    IbbSession ibbSession = ibbSessionMap.get(data.getSessionId());
                    if (ibbSession != null) {
                        if (!ibbSession.dataReceived(data)) {
                            // 2. Because the sequence number has already been used, the recipient returns an  error with a type of 'cancel'.
                            xmppSession.send(e.getMessage().createError(new StanzaError(StanzaError.Type.CANCEL, Condition.UNEXPECTED_REQUEST)));
                        }
                    } else {
                        xmppSession.send(e.getMessage().createError(Condition.ITEM_NOT_FOUND));
                    }
                }
            }
        };
    }

    @Override
    protected final void onEnable() {
        super.onEnable();

        xmppSession.addIQHandler(InBandByteStream.Open.class, openIQHandler, false);
        xmppSession.addIQHandler(InBandByteStream.Data.class, dataIQHandler, false);
        xmppSession.addIQHandler(InBandByteStream.Close.class, closeIQHandler, false);

        // 4. Use of Message Stanzas
        // an application MAY use message stanzas instead.
        xmppSession.addInboundMessageListener(messageListener);
    }

    @Override
    protected final void onDisable() {
        super.onDisable();
        xmppSession.removeIQHandler(InBandByteStream.Open.class);
        xmppSession.removeIQHandler(InBandByteStream.Data.class);
        xmppSession.removeIQHandler(InBandByteStream.Close.class);
        xmppSession.removeInboundMessageListener(messageListener);
    }

    /**
     * Creates an in-band byte stream session.
     *
     * @param receiver  The receiver.
     * @param sessionId The session id.
     * @param blockSize The block size.
     * @return The in-band byte stream session.
     */
    IbbSession createSession(Jid receiver, final String sessionId, int blockSize) {
        IbbSession ibbSession = new IbbSession(sessionId, xmppSession, receiver, blockSize, xmppSession.getConfiguration().getDefaultResponseTimeout(), this);
        ibbSessionMap.put(ibbSession.getSessionId(), ibbSession);
        return ibbSession;
    }

    /**
     * Initiates an in-band byte stream session.
     *
     * @param receiver  The receiver.
     * @param sessionId The session id.
     * @param blockSize The block size.
     * @return The async result with the in-band byte stream session.
     */
    public final AsyncResult initiateSession(Jid receiver, final String sessionId, int blockSize) {
        if (blockSize > 65535) {
            throw new IllegalArgumentException("blockSize must not be greater than 65535.");
        }
        IbbSession ibbSession = createSession(receiver, sessionId, blockSize);
        return ibbSession.open().thenApply(result -> ibbSession);
    }

    @Override
    protected void dispose() {
        super.dispose();
        ibbSessionMap.clear();
    }
}