BasePairingHandler.java

/*
 * Copyright 2015 Vineet Garg <grg.vineet@gmail.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License or (at your option) version 3 or any later version
 * accepted by the membership of KDE e.V. (or its successor approved
 * by the membership of KDE e.V.), which shall act as a proxy
 * defined in Section 14 of version 3 of the license.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package org.kde.kdeconnect.Backends;

import org.kde.kdeconnect.Device;
import org.kde.kdeconnect.NetworkPackage;

/**
 * This class separates the pairing interface for each type of link.
 * Since different links can pair via different methods, like for LanLink certificate and public key should be shared,
 * for Bluetooth link they should be paired via bluetooth etc.
 * Each "Device" instance maintains a hash map for these pairing handlers so that there can be single pairing handler per
 * per link type per device.
 * Pairing handler keeps information about device, latest link, and pair status of the link
 * During first pairing process, the pairing process is nearly same as old process.
 * After that if any one of the link is paired, then we can say that device is paired, so new link will pair automatically
 */

public abstract class BasePairingHandler {

    protected enum PairStatus{
        NotPaired,
        Requested,
        RequestedByPeer,
        Paired
    }

    public interface PairingHandlerCallback {
        void incomingRequest();
        void pairingDone();
        void pairingFailed(String error);
        void unpaired();
    }


    protected Device mDevice;
    protected PairStatus mPairStatus;
    protected PairingHandlerCallback mCallback;

    public BasePairingHandler(Device device, PairingHandlerCallback callback) {
        this.mDevice = device;
        this.mCallback = callback;
    }

    public boolean isPaired() {
        return mPairStatus == PairStatus.Paired;
    }

    public boolean isPairRequested() {
        return mPairStatus == PairStatus.Requested;
    }

    public boolean isPairRequestedByPeer() {
        return mPairStatus == PairStatus.RequestedByPeer;
    }

    /* To be implemented by respective pairing handler */
    public abstract void packageReceived(NetworkPackage np) throws Exception;
    public abstract void requestPairing();
    public abstract void acceptPairing();
    public abstract void rejectPairing();
    public abstract void unpair();

}