View Javadoc
1   /**
2    * This file Copyright (c) 2010-2016 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;
35  
36  import info.magnolia.objectfactory.guice.GuiceComponentProvider;
37  import info.magnolia.objectfactory.guice.GuiceUtils;
38  
39  import java.lang.annotation.Annotation;
40  
41  import javax.inject.Named;
42  
43  import com.google.inject.Injector;
44  import com.google.inject.Key;
45  
46  /**
47   * Static access utility for the currently set {@link ComponentProvider}. The current {@link ComponentProvider} is set
48   * during start-up and there should be little reason to change it at runtime.
49   *
50   * Since Magnolia 4.5, you are encouraged to use IoC, only in rare cases should you need to directly use this class.
51   *
52   * @see ComponentProvider
53   */
54  public class Components {
55  
56      private static volatile ComponentProvider componentProvider = new NullComponentProvider();
57      private static ThreadLocal<ComponentProvider> threadLocalHierarchy = new ThreadLocal<ComponentProvider>();
58  
59      /**
60       * Sets the current {@link ComponentProvider}.
61       */
62      public static void setComponentProvider(ComponentProvider provider) {
63          componentProvider = provider;
64      }
65  
66      /**
67       * Returns the currently set {@link ComponentProvider}.
68       */
69      public static ComponentProvider getComponentProvider() {
70          ComponentProvider scoped = threadLocalHierarchy.get();
71          if (scoped != null) {
72              return scoped;
73          }
74          return componentProvider;
75      }
76  
77      public static void pushProvider(ComponentProvider provider) {
78          if (threadLocalHierarchy.get() != null) {
79              throw new IllegalStateException("Only one additional scope is supported");
80          }
81          threadLocalHierarchy.set(provider);
82      }
83  
84      public static void popProvider() {
85          threadLocalHierarchy.remove();
86      }
87  
88      /**
89       * Returns a component from the currently set {@link ComponentProvider}.
90       *
91       * @see ComponentProvider#getComponent(Class)
92       * @deprecated since 4.5, use IoC to inject the component or use #getComponent(Class).
93       */
94      @Deprecated
95      public static <T> T getSingleton(Class<T> type) {
96          return getComponent(type);
97      }
98  
99      public static <T> T newInstance(Class<T> type, Object... parameters) {
100         return getComponentProvider().newInstance(type, parameters);
101     }
102 
103     /**
104      * Returns a component from the currently set {@link ComponentProvider}. Consider using IoC to inject the component instead.
105      */
106     public static <T> T getComponent(Class<T> type) {
107         return getComponentProvider().getComponent(type);
108     }
109 
110     public static <T> T getComponentWithAnnotation(Class<T> type, Annotation annotation) {
111         ComponentProvider componentProvider = getComponentProvider();
112         if (!(componentProvider instanceof GuiceComponentProvider)) {
113             throw new NoSuchComponentException("Component provider does not support resolving of components by annotation.");
114         }
115         Injector injector = ((GuiceComponentProvider) componentProvider).getInjector();
116         Key<T> key = Key.get(type, annotation);
117         if (!GuiceUtils.hasExplicitBindingFor(injector, key)) {
118             throw new NoSuchComponentException("No component configuration for type [" + type.getName() + "] with annotation [" + annotation + "] found. Please add a configuration to your module descriptor.");
119         }
120         return injector.getInstance(key);
121     }
122 
123     public static Named named(String name) {
124         return new NamedImpl(name);
125     }
126 
127     private static class NullComponentProvider implements ComponentProvider {
128 
129         @Override
130         public <C> Class<? extends C> getImplementation(Class<C> type) throws ClassNotFoundException {
131             throw new IllegalStateException("No ComponentProvider has been set yet, something must have gone terribly wrong at startup.");
132         }
133 
134         @Override
135         public <T> T getComponent(Class<T> type) {
136             throw new IllegalStateException("No ComponentProvider has been set yet, something must have gone terribly wrong at startup.");
137         }
138 
139         @Override
140         public <T> T getSingleton(Class<T> type) {
141             throw new IllegalStateException("No ComponentProvider has been set yet, something must have gone terribly wrong at startup.");
142         }
143 
144         public <T> T newInstance(Class<T> type) {
145             throw new IllegalStateException("No ComponentProvider has been set yet, something must have gone terribly wrong at startup.");
146         }
147 
148         @Override
149         public <T> T newInstance(Class<T> type, Object... parameters) {
150             throw new IllegalStateException("No ComponentProvider has been set yet, something must have gone terribly wrong at startup.");
151         }
152 
153         @Override
154         public <T> T newInstanceWithParameterResolvers(Class<T> type, ParameterResolver... parameters) {
155             throw new IllegalStateException("No ComponentProvider has been set yet, something must have gone terribly wrong at startup.");
156         }
157 
158         @Override
159         public ComponentProvider getParent() {
160             throw new IllegalStateException("No ComponentProvider has been set yet, something must have gone terribly wrong at startup.");
161         }
162 
163     }
164 }