View Javadoc
1   /**
2    * This file Copyright (c) 2011-2018 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 info.magnolia.cms.core.AggregationState;
37  import info.magnolia.cms.core.Channel;
38  import info.magnolia.context.Context;
39  import info.magnolia.context.MgnlContext;
40  import info.magnolia.context.WebContext;
41  import info.magnolia.objectfactory.annotation.LazySingleton;
42  import info.magnolia.objectfactory.annotation.LocalScoped;
43  import info.magnolia.objectfactory.annotation.SessionScoped;
44  
45  import javax.servlet.http.HttpServletRequest;
46  import javax.servlet.http.HttpServletResponse;
47  import javax.servlet.http.HttpSession;
48  
49  import com.google.inject.Provider;
50  
51  /**
52   * Registers request and session scopes and providers for accessing MgnlContext.
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.getWebContextOrNull();
70              }
71          });
72          bind(AggregationState.class).toProvider(new Provider<AggregationState>() {
73              @Override
74              public AggregationState get() {
75                  final WebContext webContext = MgnlContext.getWebContextOrNull();
76                  return webContext == null ? null : webContext.getAggregationState();
77              }
78          });
79          bind(Channel.class).toProvider(new Provider<Channel>() {
80              @Override
81              public Channel get() {
82                  final WebContext webContext = MgnlContext.getWebContextOrNull();
83                  return webContext == null ? null : webContext.getAggregationState().getChannel();
84              }
85          });
86          bind(HttpSession.class).toProvider(new Provider<HttpSession>() {
87              @Override
88              public HttpSession get() {
89                  final WebContext webContext = MgnlContext.getWebContextOrNull();
90                  return webContext == null ? null : webContext.getRequest().getSession();
91              }
92          });
93          bind(HttpServletRequest.class).toProvider(new Provider<HttpServletRequest>() {
94              @Override
95              public HttpServletRequest get() {
96                  final WebContext webContext = MgnlContext.getWebContextOrNull();
97                  return webContext == null ? null : webContext.getRequest();
98              }
99          });
100         bind(HttpServletResponse.class).toProvider(new Provider<HttpServletResponse>() {
101             @Override
102             public HttpServletResponse get() {
103                 final WebContext webContext = MgnlContext.getWebContextOrNull();
104                 return webContext == null ? null : webContext.getResponse();
105             }
106         });
107 
108         // But the scopes need to be registered at every level
109         bindScope(LocalScoped.class, MagnoliaScopes.LOCAL);
110         bindScope(SessionScoped.class, MagnoliaScopes.SESSION);
111         bindScope(LazySingleton.class, MagnoliaScopes.LAZY_SINGLETON);
112     }
113 }