1 /**
2 * This file Copyright (c) 2003-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.module;
35
36 import info.magnolia.module.model.ModuleDefinition;
37 import info.magnolia.objectfactory.Components;
38
39 import java.util.List;
40 import java.util.Set;
41
42 /**
43 * Holds instances and definitions of modules.
44 */
45 public interface ModuleRegistry {
46
47 void registerModuleDefinition(String name, ModuleDefinition moduleDefinition);
48
49 void registerModuleInstance(String name, Object moduleInstance);
50
51 void registerModuleVersionHandler(String name, ModuleVersionHandler moduleVersionHandler);
52
53 boolean isModuleRegistered(String name);
54
55 /**
56 * Returns the module's instance. This is useful for modules which use a common class (i.e content or theme modules, which
57 * can typically co-exist in a system and have the same module class).
58 *
59 * @throws IllegalArgumentException if no such module is registered.
60 * @see #getModuleInstance(Class) for a type-safer method to get module instances
61 */
62 Object getModuleInstance(String name);
63
64 /**
65 * Returns the module's instance. This is useful for modules of known type.
66 *
67 * @throws IllegalArgumentException if no such module is registered or if multiple modules are registered for this class.
68 */
69 <T> T getModuleInstance(Class<T> moduleClass);
70
71 /**
72 * @throws IllegalArgumentException if no such module is registered.
73 */
74 ModuleVersionHandler getVersionHandler(String name);
75
76 /**
77 * @throws IllegalArgumentException if no such module is registered.
78 */
79 ModuleDefinition getDefinition(String name);
80
81 /**
82 * Returns the names of configured modules.
83 *
84 * @return unmodifiable set of module names
85 */
86 Set<String> getModuleNames();
87
88 /**
89 * Returns the list of known <tt>ModuleDefinition</tt>s, as ordered by the loading mechanism (typically in dependency order).
90 *
91 * @since 4.5
92 */
93 List<ModuleDefinition> getModuleDefinitions();
94
95 /**
96 * Use this to retrieve the configured singleton impl of ModuleRegistry.
97 *
98 * @deprecated since 4.5, use IoC !
99 */
100 @Deprecated
101 public class Factory {
102 /**
103 * @deprecated since 4.5, use IoC !
104 */
105 @Deprecated
106 public static ModuleRegistry getInstance() {
107 return Components.getSingleton(ModuleRegistry.class);
108 }
109 }
110
111 }