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