001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.ui.components.extensions;
029
030import org.opencms.main.CmsLog;
031import org.opencms.main.CmsUIServlet;
032import org.opencms.ui.A_CmsUI;
033import org.opencms.ui.apps.CmsAppWorkplaceUi;
034import org.opencms.ui.shared.rpc.I_CmsPollServerRpc;
035
036import org.apache.commons.logging.Log;
037
038import com.vaadin.server.AbstractExtension;
039import com.vaadin.server.VaadinServlet;
040import com.vaadin.ui.AbstractComponent;
041
042/**
043 * Allows the use of max height in combination with vaadin layout components.<p>
044 */
045public class CmsPollServerExtension extends AbstractExtension implements I_CmsPollServerRpc {
046
047    /** Logger instance for this class. */
048    private static final Log LOG = CmsLog.getLog(CmsPollServerExtension.class);
049
050    /** The serial version id. */
051    private static final long serialVersionUID = 3978957151754705873L;
052
053    /**
054     * Constructor.<p>
055     *
056     * @param component the component to extend
057     */
058    public CmsPollServerExtension(AbstractComponent component) {
059
060        extend(component);
061        registerRpc(this);
062    }
063
064    /**
065     * @see org.opencms.ui.shared.rpc.I_CmsPollServerRpc#poll()
066     */
067    public void poll() {
068
069        if (LOG.isDebugEnabled()) {
070            LOG.debug("Client poll recieved.");
071        }
072
073        ((CmsUIServlet)VaadinServlet.getCurrent()).setBroadcastPoll();
074        A_CmsUI ui = A_CmsUI.get();
075        if (ui instanceof CmsAppWorkplaceUi) {
076            ((CmsAppWorkplaceUi)ui).checkBroadcasts();
077        }
078    }
079}