fr.paris.lutece.plugins.mydashboard.business.portlet.MyDashboardPortlet.java Source code

Introduction

Here is the source code for fr.paris.lutece.plugins.mydashboard.business.portlet.MyDashboardPortlet.java

Source

/*
 * Copyright (c) 2002-2014, Mairie de Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.mydashboard.business.portlet;

import fr.paris.lutece.plugins.mydashboard.service.IMyDashboardComponent;
import fr.paris.lutece.plugins.mydashboard.service.MyDashboardService;
import fr.paris.lutece.portal.business.portlet.PortletHtmlContent;
import fr.paris.lutece.portal.service.security.LuteceUser;
import fr.paris.lutece.portal.service.security.SecurityService;
import fr.paris.lutece.portal.service.template.AppTemplateService;
import fr.paris.lutece.util.html.HtmlTemplate;

import org.apache.commons.lang.StringUtils;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

/**
 * Portlet to display dashboards of front office users
 */

/**
 * @author vbroussard
 *
 */
public class MyDashboardPortlet extends PortletHtmlContent {
    private static final String MARK_LIST_DASHBOARDS_CONTENT = "listDashboardsContent";
    private static final String MARK_PORTLET = "portlet";
    private static final String TEMPLATE_PORTLET_MY_DASHBOARDS = "skin/plugins/mydashboard/portlet/portlet_my_dashboards.html";

    /**
     * {@inheritDoc}
     */
    @Override
    public String getHtmlContent(HttpServletRequest request) {
        if (SecurityService.isAuthenticationEnable()) {
            LuteceUser user = SecurityService.getInstance().getRegisteredUser(request);

            if (user == null) {
                return StringUtils.EMPTY;
            }

            Map<String, Object> model = new HashMap<String, Object>();

            List<IMyDashboardComponent> listDashboardComponents = MyDashboardService.getInstance()
                    .getDashboardComponentListFromUser(user);

            List<String> listDashboardContent = new ArrayList<String>(listDashboardComponents.size());

            for (IMyDashboardComponent dashboardComponent : listDashboardComponents) {
                if (dashboardComponent.isAvailable(user)) {
                    listDashboardContent.add(dashboardComponent.getDashboardData(request));
                }
            }

            model.put(MARK_LIST_DASHBOARDS_CONTENT, listDashboardContent);
            model.put(MARK_PORTLET, this);

            HtmlTemplate template = AppTemplateService.getTemplate(TEMPLATE_PORTLET_MY_DASHBOARDS,
                    request.getLocale(), model);

            return template.getHtml();
        }

        return StringUtils.EMPTY;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean canBeCachedForAnonymousUsers() {
        return true;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean canBeCachedForConnectedUsers() {
        return false;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void remove() {
        MyDashboardPortletHome.getInstance().remove(this);
    }
}