001/**
002 *
003 * Copyright 2014 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;
020
021import org.jivesoftware.smack.SmackException.NotLoggedInException;
022import org.jivesoftware.smack.util.Objects;
023
024public abstract class Manager {
025
026    final WeakReference<XMPPConnection> weakConnection;
027
028    public Manager(XMPPConnection connection) {
029        Objects.requireNonNull(connection, "XMPPConnection must not be null");
030
031        weakConnection = new WeakReference<>(connection);
032    }
033
034    protected final XMPPConnection connection() {
035        return weakConnection.get();
036    }
037
038    /**
039     * Get the XMPPConnection of this Manager if it's authenticated, i.e. logged in. Otherwise throw a {@link NotLoggedInException}.
040     *
041     * @return the XMPPConnection of this Manager.
042     * @throws NotLoggedInException if the connection is not authenticated.
043     */
044    protected final XMPPConnection getAuthenticatedConnectionOrThrow() throws NotLoggedInException {
045        XMPPConnection connection = connection();
046        if (!connection.isAuthenticated()) {
047            throw new NotLoggedInException();
048        }
049        return connection;
050    }
051}