/*
    * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
    *
    * 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 de.smartics.properties.spi.config.ds;
  
  import java.sql.Connection;
  import java.sql.PreparedStatement;
  import java.sql.ResultSet;
  import java.sql.SQLException;
  import java.sql.Statement;
  
  import de.smartics.properties.api.config.domain.Property;
  import de.smartics.properties.api.config.domain.PropertyCollection;
  import de.smartics.properties.api.config.domain.PropertyLocation;
  import de.smartics.properties.api.config.domain.PropertyProvider;
  import de.smartics.properties.api.config.domain.key.ConfigurationKey;
  import de.smartics.util.lang.Arg;
  
  /**
   * Provides access to properties in a data source.
   */
  public final class PropertiesStore extends DefaultDataSourceManager implements
      PropertiesDataSourceAccessor
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param builder the builder of manager instance.
     */
    protected PropertiesStore(final Builder builder)
    {
      super(builder);
    }
  
    // ****************************** Inner Classes *****************************
  
    /**
     * The builder of manager instances.
     */
    public static class Builder extends DefaultDataSourceManager.Builder
    {
      // ******************************** Fields ********************************
  
      // --- constants ----------------------------------------------------------
  
      // --- members ------------------------------------------------------------
  
      // ***************************** Initializer ******************************
  
      // ***************************** Constructors *****************************
  
      // ***************************** Inner Classes ****************************
  
      // ******************************** Methods *******************************
  
      // --- init ---------------------------------------------------------------
  
      // --- get&set ------------------------------------------------------------
  
      // --- business -----------------------------------------------------------
  
      /**
       * Creates the instance.
       *
       * @return the created instance.
       * @throws NullPointerException if no data source proxy has been provided.
       */
      @Override
      public final PropertiesStore build() throws NullPointerException
      {
        Arg.checkNotNull("dataSourceProxy", dataSourceProxy);
        Arg.checkNotNull("insertOrUpdateSqlStatementTemplate",
           insertOrUpdateSqlStatementTemplate);
 
       return new PropertiesStore(this);
     }
 
     // --- object basics ------------------------------------------------------
   }
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   // --- business -------------------------------------------------------------
 
   @Override
   public Property getProperty(final String config, final String name)
     throws NullPointerException, IllegalArgumentException, DataSourceException
   {
     Arg.checkNotBlank("config", config); // NOPMD
     Arg.checkNotBlank("name", name); // NOPMD
 
     final String path = getDataSourceId() + '@' + getTable() + '>' + config;
     try
     {
       final Connection connection =
           getDataSourceProxy().getDataSource().getConnection();
 
       try
       {
         final PreparedStatement statement =
             createGetPropertyStatement(connection);
         statement.setString(1, config);
         statement.setString(2, name);
         final ResultSet resultSet = statement.executeQuery();
         final String value;
         if (resultSet.next())
         {
           value = resultSet.getString(1);
         }
         else
         {
           value = null;
         }
         return new Property(new PropertyLocation(path), name, value);
       }
       finally
       {
         connection.close();
       }
     }
     catch (final SQLException e)
     {
       final String dataSourceId = getDataSourceId();
       throw new DataSourceException(new DataSourcePropertyKeyMessageBean(
           DataSourceCode.CANNOT_ACCESS_PROPERTY, e, dataSourceId, path, name));
     }
   }
 
   @Override
   public void setProperty(final String config, final String name,
       final String value) throws IllegalArgumentException, DataSourceException
   {
     Arg.checkNotBlank("config", config);
     Arg.checkNotBlank("name", name);
 
     try
     {
       final Connection connection =
           getDataSourceProxy().getDataSource().getConnection();
 
       try
       {
         final PreparedStatement statement =
             createSetPropertyStatement(connection);
 
         getDataSourceProxy().setInsertOrUpdate(statement, config, name, value);
         statement.executeUpdate();
       }
       finally
       {
         connection.close();
       }
     }
     catch (final SQLException e)
     {
       final String dataSourceId = getDataSourceId();
       final String path = dataSourceId + '@' + getTable() + '>' + config;
       throw new DataSourceException(new DataSourcePropertyMessageBean(
           DataSourceCode.CANNOT_STORE_PROPERTY, e, dataSourceId, path, name,
           value));
     }
   }
 
   @Override
   public void setProperties(final PropertyProvider provider)
     throws NullPointerException, DataSourceException
   {
     Arg.checkNotNull("provider", provider);
 
     final ConfigurationKey<?> key = provider.getConfigurationKey();
     final String config = key.toString();
 
     try
     {
       final Connection connection =
           getDataSourceProxy().getDataSource().getConnection();
 
       try
       {
         final PreparedStatement statement =
             createSetPropertyStatement(connection);
 
         storeProperties(provider, config, statement);
       }
       finally
       {
         connection.close();
       }
     }
     catch (final SQLException e)
     {
       final String dataSourceId = getDataSourceId();
       throw new DataSourceException(new DataSourceConfigurationMessageBean(
           DataSourceCode.CANNOT_STORE_PROPERTIES, e, dataSourceId, config));
     }
   }
 
   private void storeProperties(final PropertyProvider provider,
       final String config, final PreparedStatement statement)
   {
     for (final Property property : provider.getProperties())
     {
       final String name = property.getName();
       final String value = property.getValue();
 
       try
       {
         statement.setString(1, config);
         statement.setString(2, name);
         statement.setString(3, value);
         // statement.setString(4, config);
         // statement.setString(5, name);
         statement.setString(4, value);
         statement.executeUpdate();
       }
       catch (final SQLException e)
       {
         final String dataSourceId = getDataSourceId();
         final String path = dataSourceId + '@' + getTable() + '>' + config;
         throw new DataSourceException(new DataSourcePropertyMessageBean(
             DataSourceCode.CANNOT_STORE_PROPERTY, e, dataSourceId, path, name,
             value));
       }
     }
   }
 
   @Override
   public void deleteProperty(final String config, final String name)
     throws IllegalArgumentException, DataSourceException
   {
     Arg.checkNotBlank("config", config);
     Arg.checkNotBlank("name", name);
 
     try
     {
       final Connection connection =
           getDataSourceProxy().getDataSource().getConnection();
 
       try
       {
         final PreparedStatement statement =
             createDeletePropertyStatement(connection);
         statement.setString(1, config);
         statement.setString(2, name);
         statement.executeUpdate();
       }
       finally
       {
         connection.close();
       }
     }
     catch (final SQLException e)
     {
       final String dataSourceId = getDataSourceId();
       final String path = dataSourceId + '@' + getTable() + '>' + config;
       throw new DataSourceException(new DataSourcePropertyKeyMessageBean(
           DataSourceCode.CANNOT_DELETE_PROPERTY, e, dataSourceId, path, name));
     }
   }
 
   /**
    * The collection of all properties stored.
    *
    * @param config the name of the configuration the property is part of.
    * @return the collection of all properties stored.
    * @throws DataSourceException on any database problem.
    */
   public PropertyCollection getCollection(final String config)
     throws DataSourceException
   {
     try
     {
       final Connection connection =
           getDataSourceProxy().getDataSource().getConnection();
 
       final PreparedStatement statement =
           createGetPropertiesStatement(connection);
       statement.setString(1, config);
       final ResultSet resultSet = statement.executeQuery(); // NOPMD
       final String path = getDataSourceId() + '@' + getTable() + '>' + config;
       final DsPropertyCollection collection =
           new DsPropertyCollection(path, connection, resultSet);
       return collection;
     }
     catch (final SQLException e)
     {
       final String dataSourceId = getDataSourceId();
       throw new DataSourceException(new DataSourceConfigurationMessageBean(
           DataSourceCode.CANNOT_ACCESS_PROPERTIES, e, dataSourceId, config));
     }
   }
 
   /**
    * Checks if a property with the given {@code name} is stored.
    *
    * @param config the name of the configuration the property is part of.
    * @param name the name of the property to check if it is stored.
    * @return <code>true</code> if there is a property with that name and a non-
    *         <code>null</code> value, <code>false</code> otherwise.
    * @throws IllegalArgumentException if {@code config} or {@code name} is
    *           blank.
    */
   public boolean containsKey(final String config, final String name)
     throws IllegalArgumentException
   {
     final Property property = getProperty(config, name);
     return property.getValue() != null;
   }
 
   private PreparedStatement createGetPropertyStatement(
       final Connection connection) throws SQLException
   {
     final String sql =
         "SELECT " + getValueColumn() + " FROM " + getTable() + " WHERE "
             + getConfigColumn() + " = ?" + " AND " + getNameColumn() + " = ?"; // NOPMD
     return connection.prepareStatement(sql);
   }
 
   private PreparedStatement createGetPropertiesStatement(
       final Connection connection) throws SQLException
   {
     final String sql =
         "SELECT " + getNameColumn() + ", " + getValueColumn() + " FROM "
             + getTable() + " WHERE " + getConfigColumn() + "= ?";
     return connection.prepareStatement(sql);
   }
 
   private PreparedStatement createSetPropertyStatement(
       final Connection connection) throws SQLException
   {
     final String sql = getInsertOrUpdateSqlStatementTemplate();
     return connection.prepareStatement(sql);
   }
 
   private PreparedStatement createDeletePropertyStatement(
       final Connection connection) throws SQLException
   {
     final String sql =
         "DELETE FROM " + getTable() + " WHERE " + getConfigColumn()
             + " = ? AND " + getNameColumn() + " = ? ";
     return connection.prepareStatement(sql);
   }
 
   /**
    * Deletes all properties.
    *
    * @throws DataSourceException on any database problem.
    */
   public void deleteProperties() throws DataSourceException
   {
     final String sql = "DELETE FROM " + getTable();
     try
     {
       final Connection connection =
           getDataSourceProxy().getDataSource().getConnection();
       try
       {
         final Statement statement = connection.createStatement();
         statement.executeUpdate(sql);
       }
       finally
       {
         connection.close();
       }
     }
     catch (final SQLException e)
     {
       final String dataSourceId = getDataSourceId();
       throw new DataSourceException(new DataSourceMessageBean(
           DataSourceCode.CANNOT_DELETE_PROPERTIES, e, dataSourceId));
     }
   }
 
   // --- object basics --------------------------------------------------------
 
 }