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.module;
35  
36  import java.util.ArrayList;
37  import java.util.List;
38  import javax.servlet.ServletContext;
39  import javax.servlet.ServletException;
40  
41  import org.springframework.util.StringUtils;
42  import org.springframework.web.context.ConfigurableWebApplicationContext;
43  import org.springframework.web.context.ContextLoader;
44  import org.springframework.web.servlet.DispatcherServlet;
45  
46  import info.magnolia.module.blossom.render.BlossomDispatcherServlet;
47  import info.magnolia.module.blossom.support.CustomServletConfig;
48  import info.magnolia.objectfactory.Components;
49  
50  /**
51   * Intended to be used as a base class for Magnolia modules that use Blossom. Provides support for initializing
52   * the root WebApplicationContext and DispatcherServlets. Initializing them like this makes them participate
53   * properly at module install time. Servlets apart from {@link BlossomDispatcherServlet} should be configured
54   * in your module's definition file with their url mappings.
55   *
56   * @since 1.1
57   */
58  public class BlossomModuleSupport {
59  
60      private ContextLoader contextLoader;
61      private List<DispatcherServlet> dispatcherServlets = new ArrayList<DispatcherServlet>();
62  
63      public void initRootWebApplicationContext(final String configLocation) {
64  
65          initRootWebApplicationContext(new ContextLoader() {
66  
67              @Override
68              protected void customizeContext(ServletContext servletContext, ConfigurableWebApplicationContext applicationContext) {
69  
70                  applicationContext.setConfigLocations(StringUtils.tokenizeToStringArray(configLocation, ConfigurableWebApplicationContext.CONFIG_LOCATION_DELIMITERS));
71              }
72          });
73      }
74  
75      public void initRootWebApplicationContext(ContextLoader contextLoader) {
76          if (this.contextLoader != null) {
77              throw new IllegalStateException("ContextLoader already set, root WebApplicationContext has already been initialized");
78          }
79          this.contextLoader = contextLoader;
80          this.contextLoader.initWebApplicationContext(getServletContext());
81      }
82  
83      public void closeRootWebApplicationContext() {
84          if (contextLoader != null) {
85              contextLoader.closeWebApplicationContext(getServletContext());
86              contextLoader = null;
87          }
88      }
89  
90      public void initBlossomDispatcherServlet(String servletName, String configLocation) {
91          initDispatcherServlet(new BlossomDispatcherServlet(), servletName, configLocation);
92      }
93  
94      public void initDispatcherServlet(String servletName, String configLocation) {
95          initDispatcherServlet(new DispatcherServlet(), servletName, configLocation);
96      }
97  
98      public void initDispatcherServlet(DispatcherServlet dispatcherServlet, String servletName, String configLocation) {
99          try {
100 
101             CustomServletConfig servletConfig = new CustomServletConfig(servletName, getServletContext());
102             servletConfig.addInitParameter("contextConfigLocation", configLocation);
103 
104             dispatcherServlet.init(servletConfig);
105 
106             dispatcherServlets.add(dispatcherServlet);
107 
108         } catch (ServletException e) {
109             throw new RuntimeException("Servlet initialization failed for servlet [" + servletName + "]", e);
110         }
111     }
112 
113     public void destroyDispatcherServlets() {
114         for (int i = dispatcherServlets.size() - 1; i >= 0; i--) {
115             dispatcherServlets.get(i).destroy();
116         }
117         dispatcherServlets.clear();
118     }
119 
120     public List<DispatcherServlet> getDispatcherServlets() {
121         return dispatcherServlets;
122     }
123 
124     public ServletContext getServletContext() {
125         return Components.getComponent(ServletContext.class);
126     }
127 }