org.richfaces.component.QueueRegistry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of richfaces-a4j Show documentation
There is a newer version: 4.5.17.Final
/**
 * License Agreement.
 *
 * Rich Faces - Natural Ajax for Java Server Faces (JSF)
 *
 * Copyright (C) 2007 Exadel, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License version 2.1 as published by the Free Software Foundation.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
 */
package org.richfaces.component;

import java.util.LinkedHashMap;
import java.util.Map;

import javax.faces.component.UIComponent;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;

import org.richfaces.log.Logger;
import org.richfaces.log.RichfacesLogger;

/**
 * @author Nick Belaevski
 * @since 3.3.0
 */
public final class QueueRegistry {
    public static final String QUEUE_SCRIPT_ID = "_org_richfaces_queue";
    private static final Logger LOGGER = RichfacesLogger.COMPONENTS.getLogger();
    private static final String REGISTRY_ATTRIBUTE_NAME = QueueRegistry.class.getName();
    private Map queuesData = new LinkedHashMap();

    private QueueRegistry() {
    }

    public static QueueRegistry getInstance(FacesContext context) {
        ExternalContext externalContext = context.getExternalContext();
        Map requestMap = externalContext.getRequestMap();
        QueueRegistry registry = (QueueRegistry) requestMap.get(REGISTRY_ATTRIBUTE_NAME);

        if (registry == null) {
            registry = new QueueRegistry();
            requestMap.put(REGISTRY_ATTRIBUTE_NAME, registry);
        }

        return registry;
    }

    public void addQueue(String clientName, UIComponent component) {
        if (!containsQueue(clientName)) {
            queuesData.put(clientName, component);
        } else {
            LOGGER.warn("Queue with name '" + clientName + "' has already been registered");
        }
    }

    public UIComponent removeQueue(String clientName) {
        return queuesData.remove(clientName);
    }

    public boolean containsQueue(String name) {
        return queuesData.containsKey(name);
    }

    public Map getRegisteredQueues() {
        return queuesData;
    }

    public boolean hasQueuesToEncode() {
        if (queuesData.isEmpty()) {
            return false;
        }
        for (Map.Entry queue : queuesData.entrySet()) {
            if (queue.getValue().isRendered()) {
                return true;
            }
        }
        return false;
    }
}