001/**
002 *
003 * Copyright 2014-2018 Florian Schmaus
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smack;
018
019import java.lang.ref.WeakReference;
020import java.util.concurrent.ScheduledFuture;
021import java.util.concurrent.TimeUnit;
022
023import org.jivesoftware.smack.SmackException.NotLoggedInException;
024import org.jivesoftware.smack.util.Objects;
025
026public abstract class Manager {
027
028    final WeakReference<XMPPConnection> weakConnection;
029
030    public Manager(XMPPConnection connection) {
031        Objects.requireNonNull(connection, "XMPPConnection must not be null");
032
033        weakConnection = new WeakReference<>(connection);
034    }
035
036    protected final XMPPConnection connection() {
037        return weakConnection.get();
038    }
039
040    /**
041     * Get the XMPPConnection of this Manager if it's authenticated, i.e. logged in. Otherwise throw a {@link NotLoggedInException}.
042     *
043     * @return the XMPPConnection of this Manager.
044     * @throws NotLoggedInException if the connection is not authenticated.
045     */
046    protected final XMPPConnection getAuthenticatedConnectionOrThrow() throws NotLoggedInException {
047        XMPPConnection connection = connection();
048        if (!connection.isAuthenticated()) {
049            throw new NotLoggedInException();
050        }
051        return connection;
052    }
053
054    protected static final ScheduledFuture<?> schedule(Runnable runnable, long delay, TimeUnit unit) {
055        return AbstractXMPPConnection.SCHEDULED_EXECUTOR_SERVICE.schedule(runnable, delay, unit);
056    }
057}