View Javadoc

1   /**
2    * This file Copyright (c) 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.objectfactory.guice;
35  
36  import javax.servlet.http.HttpServletRequest;
37  import javax.servlet.http.HttpServletResponse;
38  import javax.servlet.http.HttpSession;
39  
40  import com.google.inject.Provider;
41  import info.magnolia.cms.core.AggregationState;
42  import info.magnolia.context.Context;
43  import info.magnolia.context.MgnlContext;
44  import info.magnolia.context.WebContext;
45  import info.magnolia.objectfactory.annotation.LazySingleton;
46  import info.magnolia.objectfactory.annotation.RequestScoped;
47  import info.magnolia.objectfactory.annotation.SessionScoped;
48  
49  /**
50   * Registers request and session scopes and providers for accessing MgnlContext.
51   *
52   * @version $Id$
53   */
54  public class GuiceContextAndScopesConfigurer extends AbstractGuiceComponentConfigurer {
55  
56      @Override
57      protected void configure() {
58  
59          // We don't need to register these providers at every level, would be enough to do it in the top parent
60          bind(Context.class).toProvider(new Provider<Context>() {
61              @Override
62              public Context get() {
63                  return MgnlContext.getInstance();
64              }
65          });
66          bind(WebContext.class).toProvider(new Provider<WebContext>() {
67              @Override
68              public WebContext get() {
69                  return MgnlContext.getWebContext();
70              }
71          }).in(RequestScoped.class);
72          bind(AggregationState.class).toProvider(new Provider<AggregationState>() {
73              @Override
74              public AggregationState get() {
75                  return MgnlContext.getAggregationState();
76              }
77          }).in(RequestScoped.class);
78          bind(HttpSession.class).toProvider(new Provider<HttpSession>() {
79              @Override
80              public HttpSession get() {
81                  return MgnlContext.getWebContext().getRequest().getSession();
82              }
83          }).in(SessionScoped.class);
84          bind(HttpServletRequest.class).toProvider(new Provider<HttpServletRequest>() {
85              @Override
86              public HttpServletRequest get() {
87                  return MgnlContext.getWebContext().getRequest();
88              }
89          }).in(RequestScoped.class);
90          bind(HttpServletResponse.class).toProvider(new Provider<HttpServletResponse>() {
91              @Override
92              public HttpServletResponse get() {
93                  return MgnlContext.getWebContext().getResponse();
94              }
95          }).in(RequestScoped.class);
96  
97          // But the scopes need to be registered at every level
98          bindScope(RequestScoped.class, MagnoliaScopes.REQUEST);
99          bindScope(SessionScoped.class, MagnoliaScopes.SESSION);
100         bindScope(LazySingleton.class, MagnoliaScopes.LAZY_SINGLETON);
101     }
102 }