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