org.hyperic.hq.ui.security.UISessionInitializationStrategy.java Source code

Java tutorial

Introduction

Here is the source code for org.hyperic.hq.ui.security.UISessionInitializationStrategy.java

Source

/**
 * NOTE: This copyright does *not* cover user programs that use HQ
 * program services by normal system calls through the application
 * program interfaces provided as part of the Hyperic Plug-in Development
 * Kit or the Hyperic Client Development Kit - this is merely considered
 * normal use of the program, and does *not* fall under the heading of
 *  "derived work".
 *
 *  Copyright (C) [2009-2010], VMware, Inc.
 *  This file is part of HQ.
 *
 *  HQ is free software; you can redistribute it and/or modify
 *  it under the terms version 2 of the GNU General Public License as
 *  published by the Free Software Foundation. This program 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 General Public License for more
 *  details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 *  USA.
 *
 */

package org.hyperic.hq.ui.security;

import java.util.Iterator;
import java.util.Set;
import java.util.Map.Entry;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.hyperic.hq.auth.server.session.UserAuditFactory;
import org.hyperic.hq.auth.shared.SessionManager;
import org.hyperic.hq.auth.shared.SessionNotFoundException;
import org.hyperic.hq.auth.shared.SessionTimeoutException;
import org.hyperic.hq.authz.server.session.AuthzSubject;
import org.hyperic.hq.authz.shared.AuthzSubjectManager;
import org.hyperic.hq.authz.shared.PermissionException;
import org.hyperic.hq.authz.shared.RoleManager;
import org.hyperic.hq.bizapp.shared.AuthBoss;
import org.hyperic.hq.bizapp.shared.AuthzBoss;
import org.hyperic.hq.ui.Constants;
import org.hyperic.hq.ui.WebUser;
import org.hyperic.hq.ui.server.session.UserDashboardConfig;
import org.hyperic.hq.ui.shared.DashboardManager;
import org.hyperic.image.widget.ResourceTree;
import org.hyperic.util.config.ConfigResponse;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.Authentication;
import org.springframework.security.web.authentication.session.SessionAuthenticationException;
import org.springframework.stereotype.Component;

/*
 * This class is responsible for setting up the new session and determining whether or not the user needs to register.
 */

@Component
public class UISessionInitializationStrategy extends BaseSessionInitializationStrategy {
    private static Log log = LogFactory.getLog(UISessionInitializationStrategy.class.getName());

    private DashboardManager dashboardManager;
    private AuthzBoss authzBoss;

    @Autowired
    public UISessionInitializationStrategy(AuthBoss authBoss, AuthzBoss authzBoss,
            AuthzSubjectManager authzSubjectManager, DashboardManager dashboardManager,
            UserAuditFactory userAuditFactory, SessionManager sessionManager, RoleManager roleManager) {
        super(authBoss, authzBoss, authzSubjectManager, userAuditFactory, sessionManager, roleManager);

        this.authzBoss = authzBoss;
        this.dashboardManager = dashboardManager;
    }

    public void onAuthentication(Authentication authentication, HttpServletRequest request,
            HttpServletResponse response) throws SessionAuthenticationException {
        super.onAuthentication(authentication, request, response);

        final boolean debug = log.isDebugEnabled();

        if (debug)
            log.debug("Initializing UI session parameters...");

        HttpSession session = request.getSession();
        WebUser webUser = (WebUser) session.getAttribute(Constants.WEBUSER_SES_ATTR);

        assert (webUser != null); // At this point webUser should never be null

        if (webUser.getPreferences().getKeys().size() == 0) {
            // will be cleaned out during registration
            session.setAttribute(Constants.PASSWORD_SES_ATTR, authentication.getCredentials().toString());
            session.setAttribute(Constants.NEEDS_REGISTRATION, Boolean.TRUE);

            if (debug)
                log.debug("Stashing registration parameters in the session for later use");
        }

        ServletContext ctx = session.getServletContext();

        // Load up the user's dashboard preferences
        loadDashboard(ctx, webUser, authzBoss);

        // Determine if we can render chart images
        setXlibFlag(session);
    }

    private boolean mergeValues(ConfigResponse config, ConfigResponse other, boolean overWrite) {
        boolean updated = true;
        Set<Entry<Object, Object>> entrySet = other.toProperties().entrySet();

        for (Iterator<Entry<Object, Object>> i = entrySet.iterator(); i.hasNext();) {
            Entry<Object, Object> entry = i.next();
            String key = (String) entry.getKey();
            String value = (String) entry.getValue();

            if (overWrite || config.getValue(key) == null) {
                config.setValue(key, value);
                updated = true;
            }
        }
        return updated;
    }

    private static void setXlibFlag(HttpSession session) {
        try {
            new ResourceTree(1); // See if graphics engine is present
            session.setAttribute(Constants.XLIB_INSTALLED, Boolean.TRUE);
        } catch (Throwable t) {
            log.warn("Server cannot render chart images.", t);

            session.setAttribute(Constants.XLIB_INSTALLED, Boolean.FALSE);
        }
    }

    private void loadDashboard(ServletContext ctx, WebUser webUser, AuthzBoss authzBoss) {
        try {
            ConfigResponse defaultUserDashPrefs = (ConfigResponse) ctx.getAttribute(Constants.DEF_USER_DASH_PREFS);
            AuthzSubject me = authzBoss.findSubjectById(webUser.getSessionId(), webUser.getSubject().getId());
            UserDashboardConfig userDashboard = dashboardManager.getUserDashboard(me, me);

            if (userDashboard == null) {
                userDashboard = dashboardManager.createUserDashboard(me, me, webUser.getName());
            }

            ConfigResponse userDashobardConfig = userDashboard.getConfig();

            if (mergeValues(userDashobardConfig, defaultUserDashPrefs, false)) {
                dashboardManager.configureDashboard(me, userDashboard, userDashobardConfig);
            }
        } catch (PermissionException e) {
            log.error(e);
        } catch (SessionNotFoundException e) {
            // User not logged in
            log.error(e);
        } catch (SessionTimeoutException e) {
            // User session has expired
            log.error(e);
        }
    }
}