1 /**
2 * This file Copyright (c) 2003-2010 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 java.util.Set;
37
38 import info.magnolia.module.model.ModuleDefinition;
39 import info.magnolia.objectfactory.Components;
40
41 /**
42 * Holds instances and definitions of modules.
43 *
44 * @author gjoseph
45 * @version $Revision: $ ($Author: $)
46 */
47 public interface ModuleRegistry {
48
49 void registerModuleDefinition(String name, ModuleDefinition moduleDefinition);
50
51 void registerModuleInstance(String name, Object moduleInstance);
52
53 void registerModuleVersionHandler(String name, ModuleVersionHandler moduleVersionHandler);
54
55 boolean isModuleRegistered(String name);
56
57 /**
58 * Returns the module's instance. This is useful for modules which use a common class (i.e content or theme modules, which
59 * can typically co-exist in a system and have the same module class).
60 * @see #getModuleInstance(Class) for a type-safer method to get module instances
61 * @throws IllegalArgumentException if no such module is registered.
62 */
63 Object getModuleInstance(String name);
64
65 /**
66 * Returns the module's instance. This is useful for modules of known type.
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 * @return unmodifiable set of module names
84 */
85 Set<String> getModuleNames();
86
87 /**
88 * Use this to retrieve the configured singleton impl of ModuleRegistry.
89 */
90 public class Factory {
91 public static ModuleRegistry getInstance() {
92 return Components.getSingleton(ModuleRegistry.class);
93 }
94 }
95
96 }