/* ======================================================================
The Bodington System Software License, Version 1.0
 
Copyright (c) 2001 The University of Leeds.  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,
this list of conditions and the following disclaimer.
 
2.  Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
 
3.  The end-user documentation included with the redistribution, if any,
must include the following acknowledgement:  "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)."  Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.
 
4.  The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.
 
5.  The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.
 
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  TITLE,  THE IMPLIED WARRANTIES
OF QUALITY  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO
EVENT SHALL THE UNIVERSITY OF LEEDS OR ITS 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.
=========================================================
 
This software was originally created by the University of Leeds and may contain voluntary
contributions from others.  For more information on the Bodington Open Source Project, please
see http://bodington.org/
 
====================================================================== */

package org.bodington.spring;

import java.rmi.RemoteException;
import java.util.ArrayList;
import java.util.List;

import javax.servlet.http.HttpServletRequest;

import org.bodington.server.BuildingServerException;
import org.bodington.server.BuildingSession;
import org.bodington.server.BuildingSessionManagerImpl;
import org.bodington.server.NavigationSession;
import org.bodington.server.realm.User;
import org.bodington.server.resources.Resource;
import org.bodington.servlet.HttpSession;
import org.bodington.servlet.Request;
import org.springframework.web.servlet.mvc.AbstractCommandController;

/**
 * Utility methods for SpringMVC controllers.
 * 
 * @author buckett
 */
final public class Utils
{
    
    /**
     * Gets the resource that is needed by this controller. Should be overridden
     * in subclasses and checks should be done to ensure that you have the
     * correct resource.
     * @param request The incomming servlet request.
     * @return The resource object associated with this request.
     */
    public static Resource getResource(HttpServletRequest request)
    {
        Object resource = request.getAttribute(Request.RESOURCE_ATTRIBUTE);
        return (Resource)resource;
    }
    
    public static BuildingSession getSession(HttpServletRequest request) throws BuildingServerException
    {
        return BuildingSessionManagerImpl.getSession(getResource(request));
    }
    
    public static User getUser(HttpServletRequest request) throws BuildingServerException, RemoteException
    {
        return ((NavigationSession)request.getAttribute(Request.NAVIGATION_ATTRIBUTE)).getAuthenticatedUser();
    }
    
    /**
     * Add a message to the request.
     * @param request The request to add the message to.
     * @param msg The message.
     */
    public static void saveMessage(HttpServletRequest request, Object msg) {
        List messages = (List) request.getAttribute("messages");
        if (messages == null) {
            messages = new ArrayList();
        }
        messages.add(msg);
        request.setAttribute("messages", messages);
    }
    
    
}