org.parancoe.plugin.configuration.bo.ConfigurationManager.java Source code

Introduction

Here is the source code for org.parancoe.plugin.configuration.bo.ConfigurationManager.java

Source

/**
 * Copyright (C) 2006-2012 The Parancoe Team <info@parancoe.org>
 *
 * This file is part of Parancoe Plugin Configuration.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.parancoe.plugin.configuration.bo;

import java.util.List;
import javax.annotation.Resource;
import org.parancoe.plugin.configuration.ConfigurationCollection;
import org.parancoe.plugin.configuration.PropertyCollection;
import org.parancoe.plugin.configuration.dao.CategoryDao;
import org.parancoe.plugin.configuration.dao.PropertyDao;
import org.parancoe.plugin.configuration.po.Category;
import org.parancoe.plugin.configuration.po.Property;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeanUtils;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

/**
 * Services for managing the configuration.
 *
 * @author Lucio Benfante <lucio@benfante.com>
 */
@Service
public class ConfigurationManager implements ConfigurationService {

    private static final org.slf4j.Logger log = LoggerFactory.getLogger(ConfigurationManager.class);
    @Resource
    private CategoryDao categoryDao;
    @Resource
    private PropertyDao propertyDao;

    /**
     * Return a property of a category.
     *
     * @param categoryName The category name.
     * @param propertyName The property name.
     * @return A property. null if the category or the property are not found.
     */
    @Transactional(readOnly = true)
    @Override
    public Property getProperty(String categoryName, String propertyName) {
        Property result = null;
        Category category = categoryDao.findByName(categoryName);
        if (category != null) {
            log.debug("Category {} found.", categoryName);
            result = propertyDao.findByNameAndCategoryId(propertyName, category.getId());
            if (log.isDebugEnabled()) {
                if (result == null) {
                    log.debug("Property {} not found.", propertyName);
                } else {
                    log.debug("Property {} found.", propertyName);
                }
            }
        } else {
            log.debug("Category {} not found.", categoryName);
        }
        return result;
    }

    /**
     * Return all properties of a category.
     *
     * @param categoryName The category name.
     * @return A property collection. null if the category is not found.
     */
    @Transactional(readOnly = true)
    @Override
    public PropertyCollection getProperties(String categoryName) {
        List<Property> result = null;
        Category category = categoryDao.findByName(categoryName);
        if (category != null) {
            log.debug("Category {} found.", categoryName);
            result = propertyDao.findByCategoryId(category.getId());
        } else {
            log.debug("Category {} not found.", categoryName);
        }
        return new PropertyCollection(result);
    }

    /**
     * Load a property.
     *
     * @param id The property id.
     * @return A property. null if the property doesn't exist.
     */
    @Transactional(readOnly = true)
    @Override
    public Property getProperty(Long id) {
        return propertyDao.get(id);
    }

    /**
     * Load all configuration categories.
     *
     * @return The configuration categories.
     */
    @Transactional(readOnly = true)
    public List<Category> loadCategories() {
        return categoryDao.findByOrderByName();
    }

    /**
     * Load all configuration categories.
     *
     * @return The configuration categories.
     */
    @Transactional(readOnly = true)
    public ConfigurationCollection getConfiguration() {
        return new ConfigurationCollection(loadCategories());
    }

    /**
     * Store a property.
     *
     * @param property The property to store.
     */
    @Transactional
    @Override
    public void store(Property property) {
        propertyDao.store(property);
    }

    /**
     * Initialize a configuration, creating the elements (categories and properties) that doesn't
     * already exists.
     *
     * @param value The configuration collection to initialize.
     */
    @Transactional
    @Override
    public void initializeConfiguration(ConfigurationCollection configurationCollection) {
        for (Category category : configurationCollection.getCategories()) {
            Category dbCategory = categoryDao.findByName(category.getName());
            if (dbCategory == null) {
                log.info("Creating new configuration category: " + category.getName());
                dbCategory = new Category();
                BeanUtils.copyProperties(category, dbCategory, new String[] { "properties" });
                categoryDao.create(dbCategory);
            } else {
                log.info("This category already exists: " + category.getName());
            }
            for (Property property : category.getProperties()) {
                Property dbProperty = propertyDao.findByNameAndCategoryId(property.getName(), dbCategory.getId());
                if (dbProperty == null) {
                    log.info("  Creating new configuration property: {name=" + property.getName() + ", type="
                            + property.getType() + ", value=" + property.getValue() + "}");
                    dbProperty = new Property();
                    BeanUtils.copyProperties(property, dbProperty, new String[] { "category", "typedValue" });
                    dbProperty.setCategory(dbCategory);
                    propertyDao.create(dbProperty);
                } else {
                    log.info("  This property already exists: " + property.getName());
                }
            }
        }
    }
}