org.jitsi.impl.configuration.DatabaseConfigurationStore Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of libjitsi Show documentation
libjitsi is an advanced Java media library for secure real-time audio/video communication
The newest version!
/*
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * 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.jitsi.impl.configuration;

import java.io.*;
import java.util.*;

import org.jitsi.util.xml.*;

/**
 *
 * @author Lyubomir Marinov
 */
@SuppressWarnings("rawtypes")
public abstract class DatabaseConfigurationStore
    extends HashtableConfigurationStore
{
    /**
     * Initializes a new DatabaseConfigurationStore instance.
     */
    protected DatabaseConfigurationStore()
    {
        this(new Hashtable());
    }

    /**
     * Initializes a new DatabaseConfigurationStore instance with a
     * specific runtime Hashtable storage.
     *
     * @param properties the Hashtable which is to become the runtime
     * storage of the new instance
     */
    protected DatabaseConfigurationStore(Hashtable properties)
    {
        super(properties);
    }

    /**
     * Removes all property name-value associations currently present in this
     * ConfigurationStore instance and deserializes new property
     * name-value associations from its underlying database (storage).
     *
     * @throws IOException if there is an input error while reading from the
     * underlying database (storage)
     */
    protected abstract void reloadConfiguration()
        throws IOException;

    /**
     * Removes all property name-value associations currently present in this
     * ConfigurationStore and deserializes new property name-value
     * associations from a specific File which presumably is in the
     * format represented by this instance.
     *
     * @param file the File to be read and to deserialize new property
     * name-value associations from into this instance
     * @throws IOException if there is an input error while reading from the
     * specified file
     * @throws XMLException if parsing the contents of the specified
     * file fails
     * @see ConfigurationStore#reloadConfiguration(File)
     */
    public void reloadConfiguration(File file)
        throws IOException,
               XMLException
    {
        properties.clear();

        reloadConfiguration();
    }

    /**
     * Stores/serializes the property name-value associations currently present
     * in this ConfigurationStore instance into its underlying database
     * (storage).
     *
     * @throws IOException if there is an output error while storing the
     * properties managed by this ConfigurationStore instance into its
     * underlying database (storage)
     */
    protected void storeConfiguration()
        throws IOException
    {
    }

    /**
     * Stores/serializes the property name-value associations currently present
     * in this ConfigurationStore into a specific OutputStream
     * in the format represented by this instance.
     *
     * @param out the OutputStream to receive the serialized form of
     * the property name-value associations currently present in this
     * ConfigurationStore
     * @throws IOException if there is an output error while storing the
     * properties managed by this ConfigurationStore into the specified
     * file
     * @see ConfigurationStore#storeConfiguration(OutputStream)
     */
    public void storeConfiguration(OutputStream out)
        throws IOException
    {
        storeConfiguration();
    }
}