1 /**
2 * This file Copyright (c) 2014-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.config.registry;
35
36 import info.magnolia.config.source.ConfigurationSourceType;
37
38 import java.util.Collection;
39
40 /**
41 * Central interface for registries; provides views on known {@link info.magnolia.config.registry.Registry} instances,
42 * and is able to query them by module, type or source.
43 */
44 public interface RegistryFacade {
45
46 Registry registryFor(DefinitionType type);
47
48 Collection<Registry> all();
49
50 /**
51 * Convenience method to find all definitions registered by the given module.
52 *
53 * @see #query()
54 */
55 Collection<DefinitionProvider> byModule(String moduleName);
56
57 /**
58 * Convenience method to find all definitions of a certain {@link info.magnolia.config.registry.DefinitionType}.
59 *
60 * @see #query()
61 */
62 Collection<DefinitionProvider> byType(DefinitionType type);
63
64 /**
65 * Convenience method to find all definitions registered trough a given {@link ConfigurationSourceType}.
66 *
67 * @see #query()
68 */
69 Collection<DefinitionProvider> bySource(ConfigurationSourceType sourceType);
70
71 /**
72 * Create query operating over an aggregation of all registries in this facade.
73 */
74 DefinitionQuery query();
75
76 /**
77 * Like {@link #query()}, but adopts properties from another query.
78 */
79 DefinitionQuery query(DefinitionQuery base);
80 }