1 /**
2 * This file Copyright (c) 2014-2015 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.objectfactory.annotation.Multibinding;
37
38 import java.util.Collection;
39 import java.util.Set;
40
41 /**
42 * An instance of a registry is responsible for one particular {@link DefinitionType};
43 * these definition can come from various sources.
44 *
45 * @param <T> element type of this registry
46 */
47 @Multibinding
48 public interface Registry<T> {
49
50 DefinitionType type();
51
52 /**
53 * Implementations of {@link info.magnolia.config.registry.DefinitionMetadataBuilder} determine how referenceId strings for this registry are generated.
54 */
55 DefinitionMetadataBuilder newMetadataBuilder();
56
57 /**
58 * Call start() once sources have been added; addSource() should however call source.startWith(registry) so maybe not ?
59 */
60 void start();
61
62 void register(DefinitionProvider<T> definitionProvider);
63
64
65 Set<DefinitionMetadata> unregisterAndRegister(Collection<DefinitionMetadata> toRemove, Collection<DefinitionProvider<T>> toAdd);
66
67 /**
68 * Gets a definition provider by its complete id object.
69 */
70 DefinitionProvider<T> getProvider(DefinitionMetadata id);
71
72 /**
73 * Convenience method, where the given String is what the corresponding {@link DefinitionMetadata#getReferenceId()} would return.
74 *
75 * @throws NoSuchDefinitionException (which is a RuntimeException) if the given reference is not known.
76 * @see DefinitionMetadata#getReferenceId()
77 */
78 DefinitionProvider<T> getProvider(String referenceId) throws NoSuchDefinitionException;
79
80 Collection<DefinitionProvider<T>> getAllProviders();
81
82 /**
83 * Returns all resolvable, valid and enabled definitions.
84 */
85 Collection<T> getAllDefinitions();
86
87 Collection<DefinitionMetadata> getAllMetadata();
88
89 /**
90 * Implementations are expected to return a subtype of DefinitionQuery that's able to callback its registry to perform the search.
91 */
92 DefinitionQuery<T> query();
93
94 /**
95 * Thrown by a registry when it doesn't hold an entity that is asked for.
96 */
97 public static class NoSuchDefinitionException extends RuntimeException {
98 public NoSuchDefinitionException(String nonExistingId) {
99 super(nonExistingId);
100 }
101 }
102
103 /**
104 * Thrown by a registry when the underlying bean is not successfully resolved, not valid, or not enabled.
105 */
106 public static class InvalidDefinitionException extends RuntimeException {
107 public InvalidDefinitionException(String definitionId) {
108 super(definitionId);
109 }
110 }
111 }