1 /** 2 * This file Copyright (c) 2014-2016 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 38 import java.util.List; 39 40 /** 41 * This is NOT called Provider to avoid confusion with javax.inject.Provider; however, keep in mind that some objects 42 * provided by these and registries are not necessarily "just" definition, they might be "live" objects (Renderer is an example). 43 * Naming this ConfiguredObjectProvider might have been more correct, but also a bit long. 44 * 45 * @param <T> the provided type 46 */ 47 public interface DefinitionProvider<T> { 48 49 List<DefinitionDecorator<T>> getDecorators(); 50 51 DefinitionMetadata getMetadata(); 52 53 /** 54 * Returns the underlying bean if and only if it is successfully resolved, is valid, and is enabled. 55 * 56 * @throws Registry.InvalidDefinitionException (which is a RuntimeException) if the underlying bean is not successfully resolved, not valid, or not enabled. 57 */ 58 T get() throws Registry.InvalidDefinitionException; 59 60 /** 61 * Returns a {@link info.magnolia.config.registry.DefinitionRawView} representation the underlying bean; it might be 62 * invalid, partially resolved and/or disabled. 63 */ 64 DefinitionRawView getRaw(); 65 66 boolean isValid(); 67 68 List<String> getErrorMessages(); 69 70 /** 71 * Returns the timestamp of the last change of the underlying definition change. If a {@link DefinitionProvider} merely wraps a definition instance - 72 * such timestamp would never change and be always equal to the provider's creation date. However, if a provider generates the definition on the fly from some 73 * resource - the last modified date might change and that might be a clear signal for an update of the structures that decorate/cache definitions. 74 * 75 * @see info.magnolia.config.registry.decoration.CachingDefinitionDecorator 76 */ 77 long getLastModified(); 78 }