View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 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.render;
35  
36  import java.io.IOException;
37  import javax.servlet.ServletException;
38  import javax.servlet.http.HttpServletRequest;
39  import javax.servlet.http.HttpServletResponse;
40  
41  import org.springframework.beans.BeansException;
42  import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
43  import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
44  import org.springframework.context.ApplicationContext;
45  import org.springframework.web.context.ConfigurableWebApplicationContext;
46  import org.springframework.web.servlet.DispatcherServlet;
47  import org.springframework.web.servlet.HandlerAdapter;
48  import org.springframework.web.servlet.LocaleResolver;
49  
50  import info.magnolia.context.MgnlContext;
51  import info.magnolia.module.blossom.context.MagnoliaLocaleResolver;
52  import info.magnolia.module.blossom.dialog.DialogExporter;
53  import info.magnolia.module.blossom.dispatcher.BlossomDispatcher;
54  import info.magnolia.module.blossom.dispatcher.BlossomDispatcherAwareBeanPostProcessor;
55  import info.magnolia.module.blossom.paragraph.ParagraphExporter;
56  import info.magnolia.module.blossom.support.ForwardRequestWrapper;
57  import info.magnolia.module.blossom.support.IncludeRequestWrapper;
58  import info.magnolia.module.blossom.template.TemplateExporter;
59  import info.magnolia.module.blossom.urimapping.AnnotatedVirtualURIMappingExporter;
60  import info.magnolia.module.blossom.urimapping.VirtualURIMappingExporter;
61  
62  /**
63   * Specialization of DispatcherServlet that detects templates, paragraphs and dialogs factories and expose functionality
64   * for rendering and pre-execution.
65   *
66   * @since 0.5
67   */
68  public class BlossomDispatcherServlet extends DispatcherServlet implements BlossomDispatcher {
69  
70      @Override
71      protected Object getDefaultStrategy(ApplicationContext context, Class strategyInterface) throws BeansException {
72          if (strategyInterface.equals(LocaleResolver.class))
73              return super.createDefaultStrategy(context, MagnoliaLocaleResolver.class);
74          return super.getDefaultStrategy(context, strategyInterface);
75      }
76  
77      @Override
78      protected void postProcessWebApplicationContext(final ConfigurableWebApplicationContext wac) {
79          wac.addBeanFactoryPostProcessor(new BeanFactoryPostProcessor() {
80              public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
81                  beanFactory.addBeanPostProcessor(new BlossomDispatcherAwareBeanPostProcessor(BlossomDispatcherServlet.this));
82                  beanFactory.addBeanPostProcessor(new ParagraphExporter(BlossomDispatcherServlet.this));
83                  beanFactory.addBeanPostProcessor(new TemplateExporter(BlossomDispatcherServlet.this));
84              }
85          });
86      }
87  
88      @Override
89      protected void onRefresh(ApplicationContext context) throws BeansException {
90          super.onRefresh(context);
91          context.getAutowireCapableBeanFactory().createBean(DialogExporter.class);
92          context.getAutowireCapableBeanFactory().createBean(AnnotatedVirtualURIMappingExporter.class);
93          context.getAutowireCapableBeanFactory().createBean(VirtualURIMappingExporter.class);
94      }
95  
96      @Override
97      public HandlerAdapter getHandlerAdapter(Object handler) throws ServletException {
98          return super.getHandlerAdapter(handler);
99      }
100 
101     public void forward(String path, HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
102 
103         String contextPath = request.getContextPath();
104 
105         request = new ForwardRequestWrapper(request, contextPath + path, contextPath, path, null);
106 
107         MgnlContext.push(request, response);
108         try {
109             super.service(request, response);
110         } finally {
111             MgnlContext.pop();
112         }
113     }
114 
115     public void include(String path, HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
116 
117         String contextPath = request.getContextPath();
118 
119         request = new IncludeRequestWrapper(request, contextPath + path, contextPath, path, null, request.getQueryString());
120 
121         MgnlContext.push(request, response);
122         try {
123             super.service(request, response);
124         } finally {
125             MgnlContext.pop();
126         }
127     }
128 }