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