1 /**
2 * This file Copyright (c) 2010-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;
35
36 /**
37 * ComponentProvider is responsible for providing components, these can be scoped as singletons or live in narrower
38 * scopes such as local and session, or be non scoped in which case a new instances will be created. Magnolia "beans",
39 * "managers" etc are all provided by this.
40 *
41 * Since Magnolia 4.5, you are encouraged to use IoC, only in rare cases should you need to directly use this class.
42 *
43 * @see ComponentFactory
44 */
45 public interface ComponentProvider {
46
47 /**
48 * Returns the implementation type mapped for a given type. This is primarily used by Content2Bean.
49 *
50 * @throws ClassNotFoundException in case there's no implementation for the provided type
51 */
52 <T> Class<? extends T> getImplementation(Class<T> type) throws ClassNotFoundException;
53
54 /**
55 * Returns the component mapped for a given type.
56 *
57 * @see #getComponent(Class)
58 * @deprecated since 4.5, use IoC. If you really need to look up a component, then use {@link #getComponent(Class)}
59 */
60 @Deprecated
61 <T> T getSingleton(Class<T> type);
62
63 /**
64 * Returns the component mapped for a given type.
65 *
66 * @return the component that is mapped for this type or null if there is none
67 * @throws NoSuchComponentException in case the component wasn't found
68 */
69 <T> T getComponent(Class<T> type) throws NoSuchComponentException;
70
71 /**
72 * Creates a new instance of the passed interface / class by using the registered implementation. The parameters are
73 * used to build the object. Most likely they are passed to the constructor. If this fails a
74 * {@link MgnlInstantiationException} is thrown.
75 */
76 <T> T newInstance(Class<T> type, Object... parameters);
77
78 <T> T newInstanceWithParameterResolvers(Class<T> type, ParameterResolver... parameters);
79
80 ComponentProvider getParent();
81 }