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.TimeUnit; 021 022import org.jivesoftware.smack.SmackException.NotLoggedInException; 023import org.jivesoftware.smack.util.Objects; 024 025/** 026 * Managers provide the high-level API of certain functionality (often standardized by XMPP Extension Protocols). 027 */ 028public abstract class Manager { 029 030 final WeakReference<XMPPConnection> weakConnection; 031 032 public Manager(XMPPConnection connection) { 033 Objects.requireNonNull(connection, "XMPPConnection must not be null"); 034 035 weakConnection = new WeakReference<>(connection); 036 } 037 038 protected final XMPPConnection connection() { 039 return weakConnection.get(); 040 } 041 042 /** 043 * Get the XMPPConnection of this Manager if it's authenticated, i.e. logged in. Otherwise throw a {@link NotLoggedInException}. 044 * 045 * @return the XMPPConnection of this Manager. 046 * @throws NotLoggedInException if the connection is not authenticated. 047 */ 048 protected final XMPPConnection getAuthenticatedConnectionOrThrow() throws NotLoggedInException { 049 XMPPConnection connection = connection(); 050 if (!connection.isAuthenticated()) { 051 throw new NotLoggedInException(); 052 } 053 return connection; 054 } 055 056 protected static final ScheduledAction schedule(Runnable runnable, long delay, TimeUnit unit) { 057 return schedule(runnable, delay, unit, ScheduledAction.Kind.NonBlocking); 058 } 059 060 protected static final ScheduledAction scheduleBlocking(Runnable runnable, long delay, TimeUnit unit) { 061 return schedule(runnable, delay, unit, ScheduledAction.Kind.Blocking); 062 } 063 064 protected static final ScheduledAction schedule(Runnable runnable, long delay, TimeUnit unit, ScheduledAction.Kind scheduledActionKind) { 065 return AbstractXMPPConnection.SMACK_REACTOR.schedule(runnable, delay, unit, scheduledActionKind); 066 } 067}