org.pentaho.pat.server.servlet.AbstractServlet.java Source code

Introduction

Here is the source code for org.pentaho.pat.server.servlet.AbstractServlet.java

Source

/*
 * Copyright (C) 2009 Luc Boudreau
 *
 * This program is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU General Public License as published by the Free 
 * Software Foundation; either version 2 of the License, or (at your option) 
 * any later version.
 *
 * 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 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.pentaho.pat.server.servlet;

import javax.servlet.ServletException;

import org.apache.log4j.Logger;
import org.pentaho.pat.rpc.exceptions.RpcException;
import org.pentaho.pat.server.data.UserManager;
import org.pentaho.pat.server.data.pojo.User;
import org.pentaho.pat.server.messages.Messages;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.security.Authentication;
import org.springframework.security.GrantedAuthority;
import org.springframework.security.GrantedAuthorityImpl;
import org.springframework.security.adapters.PrincipalSpringSecurityUserToken;
import org.springframework.security.context.SecurityContextHolder;
import org.springframework.web.context.ContextLoader;

import com.google.gwt.user.server.rpc.RemoteServiceServlet;

public abstract class AbstractServlet extends RemoteServiceServlet {
    private static final long serialVersionUID = 1L;

    private static boolean initDone;

    private static boolean standaloneMode;

    private static Authentication standaloneAuth;

    protected static ApplicationContext applicationContext;

    private static final Logger LOG = Logger.getLogger(AbstractServlet.class);

    private final String[] contextFiles = { "./src/main/webapp/WEB-INF/pat-applicationContext.xml", //$NON-NLS-1$
            "./src/main/webapp/WEB-INF/pat-securityContext.xml" //$NON-NLS-1$
    };

    static {
        initDone = false;
        standaloneMode = false;
    }

    @Override
    public void init() throws ServletException {
        super.init();

        if (!initDone) {
            if (!standaloneMode) {
                applicationContext = ContextLoader.getCurrentWebApplicationContext();
            }

            if (applicationContext == null) {
                LOG.info(Messages.getString("Servlet.AbstractServlet.StandAlone")); //$NON-NLS-1$

                // This happens if we launch PAT without a web context, like in the
                // GWT shell for example. We'll initialize the context manually.
                // applicationContext = new FileSystemXmlApplicationContext(contextFiles);
                applicationContext = new ClassPathXmlApplicationContext("pat-applicationContext.xml"); //$NON-NLS-1$

                standaloneMode = true;

                initSecurityTokens();
            }

            initDone = true;
        }
    }

    private static void initSecurityTokens() {
        if (standaloneAuth == null && standaloneMode) {
            final UserManager userManager = (UserManager) applicationContext.getBean("userManager"); //$NON-NLS-1$
            final User user = userManager.getUser("admin"); //$NON-NLS-1$

            final GrantedAuthority userAuths[] = { new GrantedAuthorityImpl("Users"), //$NON-NLS-1$
                    new GrantedAuthorityImpl("Administrators") //$NON-NLS-1$
            };

            standaloneAuth = new PrincipalSpringSecurityUserToken("", //$NON-NLS-1$
                    "admin", //$NON-NLS-1$
                    "admin", //$NON-NLS-1$
                    userAuths, user);
        }
    }

    /**
     * Helper method to gain access to the current user's security object.
     * 
     * @return The current user name.
     */
    public static String getCurrentUserId() {
        if (standaloneMode) {
            SecurityContextHolder.getContext().setAuthentication(standaloneAuth);
        }
        return SecurityContextHolder.getContext().getAuthentication().getName();

    }

    /**
     * Setter for testing purposes. Injects the application context to use. Calling this method also configures the
     * servlets in "stand alone" mode. No security config will be used.
     * 
     * @param applicationContext
     *            The application context to use.
     */
    public static void setApplicationContext(final ApplicationContext applicationContext) {
        AbstractServlet.applicationContext = applicationContext;
        standaloneMode = true;
        initSecurityTokens();
        initDone = true;
    }

    protected void doUnexpectedFailure(final Throwable e) {
        LOG.error(Messages.getString("Servlet.AbstractServlet.RpcCallException"), e); //$NON-NLS-1$
        super.doUnexpectedFailure((e instanceof RpcException) ? e : new RpcException(e.getMessage(), e));
    }

    public boolean isStandalone() {
        return standaloneMode;
    }

    public void setStandalone(boolean flag) {
        standaloneMode = flag;
    }
}