/*

  * Copyright 2007 The Kuali Foundation

  *

  * Licensed under the Educational Community License, Version 1.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  * http://www.opensource.org/licenses/ecl1.php

  *

  * 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 License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.kuali.rice.kns.web.spring;

 import javax.servlet.http.HttpServletRequest;

 import javax.servlet.http.HttpServletResponse;

 import org.apache.log4j.Logger;

 import org.kuali.rice.kns.UserSession;

 import org.kuali.rice.kns.service.KNSServiceLocatorWeb;

 import org.kuali.rice.kns.service.SessionDocumentService;

 import org.kuali.rice.kns.uif.service.ViewService;

 import org.kuali.rice.kns.uif.util.UifWebUtils;

 import org.kuali.rice.kns.util.GlobalVariables;

 import org.kuali.rice.kns.util.WebUtils;

 import org.springframework.web.servlet.HandlerInterceptor;

 import org.springframework.web.servlet.ModelAndView;

 /**

  * Spring controller intercepter for KRAD controllers

  * 

  * <p>

  * Provides infrastructure for preparing the form and view before and after the

  * controller is invoked. Included in this is form session management and

  * preparation of the view for rendering

  * </p>

  * 

  * @author Kuali Rice Team (rice.collab@kuali.org)

  */

 public class UifControllerHandlerInterceptor implements HandlerInterceptor {

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

     @Override

     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)

             throws Exception {

         // do nothing

     }

     /**

      * After the controller logic is executed, the form is placed into session

      * and the corresponding view is prepared for rendering

      * 

      * @see org.springframework.web.servlet.HandlerInterceptor#postHandle(javax.servlet.http.HttpServletRequest,

      *      javax.servlet.http.HttpServletResponse, java.lang.Object,

      *      org.springframework.web.servlet.ModelAndView)

      */

     @Override

     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,

             ModelAndView modelAndView) throws Exception {

         UifWebUtils.postControllerHandle(request, response, handler, modelAndView);

     }

     /**

      * Before the controller executes the user session is set on GlobalVariables

      * and messages are cleared

      * 

      * TODO: do we need to clear the messages before this so that formatting and

      * validation errors done during the binding are not cleared out?

      * 

      * @see org.springframework.web.servlet.HandlerInterceptor#preHandle(javax.servlet.http.HttpServletRequest,

      *      javax.servlet.http.HttpServletResponse, java.lang.Object)

      */

     @Override

     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

         final UserSession session = WebUtils.getUserSessionFromRequest(request);

         if (session == null) {

             throw new IllegalStateException("the user session has not been established");

         }

         GlobalVariables.setUserSession(session);

         GlobalVariables.clear();

         return true;

     }

         public SessionDocumentService getSessionDocumentService() {

                 return KNSServiceLocatorWeb.getSessionDocumentService();

         }    

     protected ViewService getViewService() {

         return KNSServiceLocatorWeb.getViewService();

     }

 }