org.jivesoftware.openfire.vcard.VCardEventDispatcher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xmppserver Show documentation
The newest version!
/*
 * Copyright (C) 2004-2008 Jive Software. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jivesoftware.openfire.vcard;

import org.dom4j.Element;

import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

/**
 * Dispatches vCard events. The following events are supported:
 * 
 * VCardCreated --> A VCard has been created.
 * VCardDeleted --> A VCard has been deleted.
 * VCardUpdate --> A VCard has been updated.
 * 
 * Use {@link #addListener(org.jivesoftware.openfire.vcard.VCardListener)}
 * to add or remove {@link org.jivesoftware.openfire.vcard.VCardListener}.
 *
 * @author Gabriel Guardincerri
 */
public class VCardEventDispatcher {
    /**
     * List of listeners that will be notified when vCards are created, updated or deleted.
     */
    private static List listeners = new CopyOnWriteArrayList<>();

    /**
     * Registers a listener to receive events when a vCard is created, updated or deleted.
     *
     * @param listener the listener.
     */
    public static void addListener(VCardListener listener) {
        if (listener == null) {
            throw new NullPointerException();
        }
        listeners.add(listener);
    }

    /**
     * Unregisters a listener to receive events.
     *
     * @param listener the listener.
     */
    public static void removeListener(VCardListener listener) {
        listeners.remove(listener);
    }

    /**
     * Dispatches that a vCard was updated to all listeners.
     *
     * @param user the user for which the vCard was set.
     * @param vCard the vcard updated.
     */
    public static void dispatchVCardUpdated(String user, Element vCard) {
        for (VCardListener listener : listeners) {
            listener.vCardUpdated(user, vCard);
        }
    }

    /**
     * Dispatches that a vCard was created to all listeners.
     *
     * @param user the user for which the vCard was created.
     * @param vCard the vcard created.
     */
    public static void dispatchVCardCreated(String user, Element vCard) {
        for (VCardListener listener : listeners) {
            listener.vCardCreated(user, vCard);
        }
    }

    /**
     * Dispatches that a vCard was deleted to all listeners.
     *
     * @param user the user for which the vCard was deleted.
     * @param vCard the vcard deleted.
     */
    public static void dispatchVCardDeleted(String user, Element vCard) {
        for (VCardListener listener : listeners) {
            listener.vCardDeleted(user, vCard);
        }
    }

}