/*
 * Copyright (C) 2009 eXo Platform SAS.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.exoplatform.services.jcr.config;

import org.exoplatform.container.xml.PropertiesParam;

import java.io.InputStream;
/**
 * Created by The eXo Platform SAS<br>
 *
 *  Repository service configuration persister interface.
 *
 * @LevelAPI Provisional
 */
public interface ConfigurationPersister
{

   /**
    * Init persister. Used by RepositoryServiceConfiguration on init.
    */
   void init(PropertiesParam params) throws RepositoryConfigurationException;

   /**
    * Read config data.
    * 
    * @return - config data stream
    */
   InputStream read() throws RepositoryConfigurationException;

   /**
    * Create table, write data.
    * 
    * @param confData
    *          - config data stream
    */
   void write(InputStream confData) throws RepositoryConfigurationException;

   /**
    * Tell if the config exists.
    * 
    * @return - flag
    */
   boolean hasConfig() throws RepositoryConfigurationException;

}
