1 /**
2 * This file Copyright (c) 2010-2013 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.module.blossom.preexecution;
35
36 import javax.servlet.http.HttpServletRequest;
37 import javax.servlet.http.HttpServletResponse;
38
39 import org.springframework.web.servlet.HandlerExecutionChain;
40 import org.springframework.web.servlet.ModelAndView;
41 import org.springframework.web.servlet.mvc.Controller;
42
43 import info.magnolia.module.blossom.dispatcher.BlossomDispatcher;
44
45 /**
46 * Wraps a controller that is being pre-executed and stores its resulting ModelAndView internally.
47 *
48 * @since 0.5
49 */
50 public class ModelAndViewGrabbingController implements Controller {
51
52 private PreexecutionContext preexecutionContext;
53 private HandlerExecutionChain handlerExecutionChain;
54 private DirectRenderingVoter directRenderingVoter;
55 private BlossomDispatcher dispatcher;
56
57 public ModelAndViewGrabbingController(PreexecutionContext preexecutionContext, HandlerExecutionChain handlerExecutionChain, DirectRenderingVoter directRenderingVoter, BlossomDispatcher dispatcher) {
58 this.preexecutionContext = preexecutionContext;
59 this.handlerExecutionChain = handlerExecutionChain;
60 this.directRenderingVoter = directRenderingVoter;
61 this.dispatcher = dispatcher;
62 }
63
64 @Override
65 public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
66
67 ModelAndView mv = dispatcher.executeChain(handlerExecutionChain, request, response);
68
69 // If the handler took care of rendering then we're done.
70 if (mv == null) {
71 return null;
72 }
73
74 // If the handler returned a ModelAndView that should be rendered directly then return it now.
75 if (directRenderingVoter.renderDirectly(mv, request, response)) {
76 return mv;
77 }
78
79 // Otherwise store the result for later rendering.
80 preexecutionContext.setModelAndView(mv);
81
82 // Tell the DispatcherServlet that nothing needs to be rendered at this point.
83 return null;
84 }
85 }