View Javadoc

1   /**
2    * This file Copyright (c) 2003-2014 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.context;
35  
36  import java.util.Locale;
37  
38  import org.slf4j.Logger;
39  import org.slf4j.LoggerFactory;
40  
41  import info.magnolia.cms.i18n.MessagesManager;
42  
43  
44  /**
45   * This is the system context using the not secured HierarchyManagers. The context uses only one scope.
46   * @author Philipp Bracher
47   * @version $Revision$ ($Author$)
48   */
49  public abstract class AbstractSystemContext extends AbstractContext implements SystemContext {
50  
51      private static final Logger log = LoggerFactory.getLogger(AbstractSystemContext.class);
52  
53      /**
54       * Stable serialVersionUID.
55       */
56      private static final long serialVersionUID = 222L;
57  
58      protected static ThreadLocal<JCRSessionStrategy> repositoryStrategyThreadLocal = new ThreadLocal<JCRSessionStrategy>();
59  
60      /**
61       * DON'T CREATE AN OBJECT. The SystemContext is set by magnolia system itself. Init the scopes
62       */
63      public AbstractSystemContext() {
64          setAttributeStrategy(new MapAttributeStrategy());
65      }
66  
67      @Override
68      public void setAttribute(String name, Object value, int scope) {
69          if (scope == Context.LOCAL_SCOPE || scope == Context.SESSION_SCOPE) {
70              log.warn("you should not set an attribute in the system context in request or session scope. You are setting {}={}", name, value);
71          }
72          super.setAttribute(name, value, scope);
73      }
74  
75      public void removeAttribute(String name, Object value, int scope) {
76          if (scope == Context.LOCAL_SCOPE || scope == Context.SESSION_SCOPE) {
77              log.warn("you should not manipulate an attribute in the system context in request or session scope. You are setting {}={}", name, value);
78          }
79          super.removeAttribute(name, scope);
80      }
81  
82      /**
83       * @deprecated since 4.0 - this shouldn't be exposed in the SystemContext interface. Prevent calls by
84       * throwing an UnsupportedOperationException.
85       */
86      @Deprecated
87      @Override
88      public void setLocale(Locale locale) {
89          throw new UnsupportedOperationException("setLocale() should not be called on SystemContext - system default locale is handled by MessagesManager");
90      }
91  
92      // TODO - See MAGNOLIA-2531
93      @Override
94      public Locale getLocale() {
95          return MessagesManager.getInstance().getDefaultLocale();
96      }
97  }