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