/*
    * 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.domain;
  
  import java.io.IOException;
  import java.io.ObjectInputStream;
  import java.util.List;
  
  import de.smartics.properties.api.config.app.ConfigurationPropertiesFactory;
  import de.smartics.properties.api.config.domain.ConfigurationPropertiesManagement;
  import de.smartics.properties.api.config.domain.Property;
  import de.smartics.properties.api.config.domain.PropertyProvider;
  import de.smartics.properties.api.config.domain.PropertyStoreAccessor;
  import de.smartics.properties.api.config.domain.SerializableConfigurationPropertiesManagement;
  import de.smartics.properties.api.config.domain.UnknownPropertyException;
  import de.smartics.properties.api.config.domain.key.ConfigurationKey;
  import de.smartics.properties.api.core.domain.DuplicatePropertyDeclarationsException;
  import de.smartics.properties.api.core.domain.PropertyDescriptor;
  import de.smartics.properties.api.core.domain.PropertyDescriptorRegistry;
  import de.smartics.properties.api.core.domain.PropertyKey;
  import de.smartics.properties.api.core.domain.PropertyValidationException;
  import de.smartics.properties.api.core.domain.ReadOnlyPropertyException;
  import de.smartics.properties.api.core.security.PropertyValueSecurity;
  
  /**
   * A serialization proxy that allows non serializable configuration properties
   * instances to be serialized using their factories cache and ability to
   * recreate that instances.
   */
  public final class ConfigurationPropertiesManagementProxy extends
      ConfigurationPropertiesProxy implements
      SerializableConfigurationPropertiesManagement
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The transient delegate.
     */
    private transient ConfigurationPropertiesManagement configuration;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param key the key of the configuration properties instance is to be
     *          associated with
     * @param factory the factory to create instances of the configuration
     *          properties.
     */
    public ConfigurationPropertiesManagementProxy(final ConfigurationKey<?> key,
        final ConfigurationPropertiesFactory factory)
    {
      super(key, factory);
      this.configuration = getConfiguration();
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    private ConfigurationPropertiesManagement getConfiguration()
    {
      final ConfigurationKey<?> key = getKey();
      final ConfigurationPropertiesFactory factory = getFactory();
      final ConfigurationPropertiesManagement configuration =
          factory.createManagement(key);
      return configuration;
    }
  
    // --- get&set --------------------------------------------------------------
  
    @Override
   public PropertyDescriptorRegistry getRegistry()
   {
     return configuration.getRegistry();
   }
 
   @Override
   public PropertyValueSecurity getPropertyValueSecurity()
   {
     return configuration.getPropertyValueSecurity();
   }
 
   @Override
   public PropertyStoreAccessor getPropertyStoreAccessor()
   {
     return configuration.getPropertyStoreAccessor();
   }
 
   @Override
   public boolean isInAdminMode()
   {
     return configuration.isInAdminMode();
   }
 
   @Override
   public void setToAdminMode(final boolean newMode)
   {
     configuration.setToAdminMode(newMode);
   }
 
   // --- business -------------------------------------------------------------
 
   @Override
   public void addDescriptors(final Class<?> propertySetType)
     throws DuplicatePropertyDeclarationsException
   {
     configuration.addDescriptors(propertySetType);
   }
 
   @Override
   public PropertyDescriptor getDescriptor(final String key)
     throws UnknownPropertyException
   {
     return configuration.getDescriptor(key);
   }
 
   @Override
   public PropertyDescriptor getDescriptor(final PropertyKey key)
     throws UnknownPropertyException
   {
     return configuration.getDescriptor(key);
   }
 
   @Override
   public List<PropertyDescriptor> getMandatoryPropertyDescriptors()
   {
     return configuration.getMandatoryPropertyDescriptors();
   }
 
   @Override
   public ConfigurationPropertiesManagement addDefinitions(
       final PropertyProvider properties) throws NullPointerException
   {
     return configuration.addDefinitions(properties);
   }
 
   @Override
   public Property setProperty(final PropertyKey key, final String value)
     throws NullPointerException, PropertyValidationException,
     ReadOnlyPropertyException
   {
     return configuration.setProperty(key, value);
   }
 
   @Override
   public Property unsetProperty(final PropertyKey key)
     throws NullPointerException, ReadOnlyPropertyException
   {
     return configuration.unsetProperty(key);
   }
 
   @Override
   public void flush()
   {
     configuration.flush();
   }
 
   @Override
   public ConfigurationPropertiesManagement toRepresentative()
   {
     return this;
   }
 
   @Override
   public SerializableConfigurationPropertiesManagement toSerializable()
   {
     return this;
   }
 
   // --- object basics --------------------------------------------------------
 
   /**
    * Reads the object from the given stream.
    *
    * @param in the stream to read from.
    * @throws IOException on read problems.
    * @throws ClassNotFoundException if a class cannot be found.
    */
   private void readObject(final ObjectInputStream in) throws IOException,
     ClassNotFoundException
   {
     in.defaultReadObject();
 
     configuration = getConfiguration();
   }
 }