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 java.util.List;
37
38 /**
39 * This is NOT called Provider to avoid confusion with javax.inject.Provider; however, keep in mind that some objects
40 * provided by these and registries are not necessarily "just" definition, they might be "live" objects (Renderer is an example).
41 * Naming this ConfiguredObjectProvider might have been more correct, but also a bit long.
42 *
43 * @param <T> the provided type
44 */
45 public interface DefinitionProvider<T> {
46
47 DefinitionMetadata getMetadata();
48
49 /**
50 * Returns the underlying bean if and only if it is successfully resolved, is valid, and is enabled.
51 *
52 * @throws Registry.InvalidDefinitionException (which is a RuntimeException) if the underlying bean is not successfully resolved, not valid, or not enabled.
53 */
54 T get() throws Registry.InvalidDefinitionException;
55
56 /**
57 * Returns a {@link info.magnolia.config.registry.DefinitionRawView} representation the underlying bean; it might be
58 * invalid, partially resolved and/or disabled.
59 */
60 DefinitionRawView getRaw();
61
62 boolean isValid();
63
64 List<String> getErrorMessages();
65 }