org.mgnlconfig.YamlDefinitionProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of light-yaml Show documentation
Enhances extension capabilities of Yaml configuration files (~ to JCR 'extends' property), provides connection to the JCR config workspace and to all the registries as well
The newest version!
/**
 * This file Copyright (c) 2016 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package org.mgnlconfig;

import info.magnolia.config.NamedDefinition;
import info.magnolia.config.map2bean.ConfigurationParsingException;
import info.magnolia.config.map2bean.Map2BeanTransformer;
import info.magnolia.config.registry.DefinitionProvider;
import info.magnolia.config.registry.DefinitionProviderWrapper;
import info.magnolia.config.registry.DefinitionRawView;
import info.magnolia.config.registry.Registry;
import info.magnolia.config.source.raw.DefinitionRawViewMapWrapper;
import info.magnolia.context.Context;
import info.magnolia.resourceloader.Resource;

import java.util.Map;
import java.util.Set;

import org.mgnlconfig.yaml.YamlConfigurationDataProvider;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

class YamlDefinitionProvider extends DefinitionProviderWrapper {

    private static final Logger log = LoggerFactory.getLogger(YamlDefinitionProvider.class);

    private static final String NAME_PROPERTY = "name";

    private final Map2BeanTransformer map2BeanTransformer;

    private final YamlConfigurationDataProvider yamlConfigurationDataProvider;

    private Map resolvedYamlConfigurationData = null;

    private T definition = null;

    YamlDefinitionProvider(DefinitionProvider delegate, Resource yamlFile, Set registries, Context context, Map2BeanTransformer map2BeanTransformer) {
        super(delegate);
        this.map2BeanTransformer = map2BeanTransformer;
        this.yamlConfigurationDataProvider = new YamlConfigurationDataProvider(yamlFile, context, registries);
    }

    @Override
    public T get() {
        if (refreshYamlData()) {
            try {
                //noinspection unchecked
                definition = (T) map2BeanTransformer.toBean(resolvedYamlConfigurationData, getMetadata().getType().baseClass());
            } catch (ReflectiveOperationException | ConfigurationParsingException e) {
                log.error("{}", e.getMessage(), e);
            }
        }

        return definition;
    }

    @Override
    public boolean isValid() {
        return get() != null;
    }

    @Override
    public DefinitionRawView getRaw() {
        refreshYamlData();
        return new DefinitionRawViewMapWrapper(resolvedYamlConfigurationData);
    }

    private boolean refreshYamlData() {
        if (resolvedYamlConfigurationData == null || yamlConfigurationDataProvider.needsUpdate()) {
            resolvedYamlConfigurationData = yamlConfigurationDataProvider.parseConfigurationData();

            if (NamedDefinition.class.isAssignableFrom(getMetadata().getType().baseClass())) {
                final Object nameValue = resolvedYamlConfigurationData.get(NAME_PROPERTY);
                if (nameValue == null) {
                    resolvedYamlConfigurationData.put(NAME_PROPERTY, getMetadata().getName());
                }
            }

            return true;
        }
        return false;
    }
}