ConfigDao.java

/*****************************************************************************
 * 
 * Copyright (C) Zenoss, Inc. 2010, all rights reserved.
 * 
 * This content is made available according to terms specified in
 * License.zenoss under the directory where your Zenoss product is installed.
 * 
 ****************************************************************************/


package org.zenoss.zep.dao;

import org.zenoss.protobufs.zep.Zep.ZepConfig;
import org.zenoss.zep.ZepException;

/**
 * Interface used to manage ZEP's configuration settings.
 */
public interface ConfigDao {
    /**
     * Returns the configuration of ZEP.
     * 
     * @return The ZEP configuration.
     * @throws ZepException
     *             If an error occurs loading the configuration.
     */
    public ZepConfig getConfig() throws ZepException;

    /**
     * Removes the configuration value with the specified name from the
     * database.
     *
     * @param name
     *            The name of the configuration value to remove.
     * @return The number of affected rows.
     * @throws ZepException
     *             If an error occurs removing the configuration value.
     */
    public int removeConfigValue(String name) throws ZepException;

    /**
     * Overwrites any existing configuration for ZEP with the specified
     * configuration.
     * 
     * @param config
     *            The new configuration settings to use.
     * @throws ZepException
     *             If an error occurs overwriting the configuration.
     */
    public void setConfig(ZepConfig config) throws ZepException;

    /**
     * Adds or updates one configuration entry with the specified name.
     *
     * @param name
     *            The name of the configuration entry.
     * @param config
     *            The configuration protobuf containing the new value.
     * @throws ZepException
     *             If an error occurs modifying the configuration.
     */
    public void setConfigValue(String name, ZepConfig config) throws ZepException;
}