plugins/org.apache.karaf.eik.core/src/main/java/org/apache/karaf/eik/core/configuration/AbstractPropertiesConfigurationSection.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.karaf.eik.core.configuration;

import org.apache.karaf.eik.core.KarafPlatformModel;
import org.apache.karaf.eik.core.internal.KarafCorePluginActivator;

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Properties;

import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;

abstract public class AbstractPropertiesConfigurationSection extends AbstractConfigurationSection {

    private Properties properties;

    /**
     * @see AbstractConfigurationSection#AbstractConfigurationSection(String,
     *      String, KarafPlatformModel)
     */
    public AbstractPropertiesConfigurationSection(String id, String filename,
                    KarafPlatformModel parent) {
        super(id, filename, parent);
    }

    public IStatus load() {
        loadProperties();

        return Status.OK_STATUS;
    }

    public IStatus save() {
        saveProperties();

        return Status.OK_STATUS;
    }

    /**
     * Getter for the {@link Properties} backing this object
     *
     * @return the {@link Properties} backing this object
     */
    protected Properties getProperties() {
        return properties;
    }

    /**
     * Loads the properties for this configuration section
     */
    protected void loadProperties() {
        final IPath path = getParent().getConfigurationFile(getFilename());

        try {
            final InputStream in = new FileInputStream(path.toFile());

            properties = new Properties();
            properties.load(in);

            in.close();
        } catch (Exception e) {
            KarafCorePluginActivator.getLogger().error(
                            "Unable to load configuration file: " + path.toOSString(), e);
        }
    }

    /**
     * Saves the properties for this configuration section if the parent model
     * is not read-only.<br>
     * <br>
     * If the parent model is read-only this method does nothing.
     */
    protected void saveProperties() {
        if (getParent().isReadOnly()) {
            KarafCorePluginActivator.getLogger().info(
                            "Attempting to write to read-only target platform: "
                                            + getParent().getConfigurationDirectory().toOSString());
            return;
        }

        final IPath path = getParent().getConfigurationFile(getFilename());

        try {
            final OutputStream out = new FileOutputStream(path.toFile());
            properties.store(out, getId());

            out.flush();
            out.close();
        } catch (Exception e) {
            KarafCorePluginActivator.getLogger().error(
                            "Unable to save configuration file: " + path.toOSString(), e);
        }
    }

    /**
     * Setter for the {@link Properties} backing this object
     *
     * @param p
     *            the {@link Properties} that will back this object
     */
    protected void setProperties(Properties p) {
        this.properties = p;
    }

}