/*
    * 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.impl.config.cache;
  
  import java.beans.PropertyChangeListener;
  import java.util.List;
  
  import javax.annotation.concurrent.ThreadSafe;
  
  import org.apache.commons.lang.ObjectUtils;
  
  import de.smartics.properties.api.config.domain.AbstractAdminModeSupportedPropertiesManagement;
  import de.smartics.properties.api.config.domain.ConfigurationPropertiesManagement;
  import de.smartics.properties.api.config.domain.ConfigurationValidationException;
  import de.smartics.properties.api.config.domain.DescribedProperty;
  import de.smartics.properties.api.config.domain.Property;
  import de.smartics.properties.api.config.domain.PropertyCollection;
  import de.smartics.properties.api.config.domain.PropertyProvider;
  import de.smartics.properties.api.config.domain.ValidatedProperty;
  import de.smartics.properties.api.config.domain.UnknownPropertyException;
  import de.smartics.properties.api.config.domain.key.ConfigurationKey;
  import de.smartics.properties.api.core.app.PropertyRootException;
  import de.smartics.properties.api.core.domain.DuplicatePropertyDeclarationsException;
  import de.smartics.properties.api.core.domain.PropertiesContext;
  import de.smartics.properties.api.core.domain.PropertyContext;
  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.PropertyValueConversionException;
  import de.smartics.properties.api.core.domain.ReadOnlyPropertyException;
  import de.smartics.properties.api.core.security.PropertyValueSecurity;
  import de.smartics.properties.api.core.security.SecurityException;
  import de.smartics.properties.spi.config.support.ConfigurationPropertiesManagementSpi;
  import de.smartics.util.lang.Arg;
  
  /**
   * A delegate that provides a cache.
   */
  @ThreadSafe
  public abstract class AbstractCacheConfigurationPropertiesManagement extends
      AbstractAdminModeSupportedPropertiesManagement
  { // NOPMD
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The cache implementation that provides synchronized access to the stored
     * elements.
     */
    private final DependencyTrackingCache cache;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param configurationKey the key to the configuration this cache
     *          implementation works for.
     */
    public AbstractCacheConfigurationPropertiesManagement(
        final ConfigurationKey<?> configurationKey)
    {
      this(new DependencyTrackingCache(configurationKey));
    }
  
    /**
     * Default constructor that allows to specify a cache to be used.
     *
     * @param cache the synchronized cache.
     * @throws NullPointerException if {@code cache} is <code>null</code>.
     */
    protected AbstractCacheConfigurationPropertiesManagement(
        final DependencyTrackingCache cache) throws NullPointerException
    {
      this.cache = Arg.checkNotNull("cache", cache);
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns a reference to the delegate.
    *
    * @return a reference to the delegate. Never <code>null</code>.
    */
   protected abstract ConfigurationPropertiesManagementSpi getDelegate();
 
   /**
    * Provides access to the cache.
    *
    * @return the cache.
    */
   protected final DependencyTrackingCache getCache()
   {
     return cache;
   }
 
   // --- business -------------------------------------------------------------
 
   // ... cache relevant methods ...............................................
 
   @Override
   public Object getPropertyAsType(final PropertyDescriptor descriptor)
     throws IllegalArgumentException, UnknownPropertyException,
     PropertyValueConversionException, SecurityException, PropertyRootException
   {
     final DependencyTrackingCache cache = getCache();
     // FIXME: We should not validate the value (only resolve and convert)...
     // But we do not want to dodge the cache.
     final ValidatedProperty property =
         cache.getValidatedProperty(getDelegate(), descriptor, null);
     final Object value = property.getValidatedValue();
     return value;
   }
 
   // ... get property / properties
 
   @Override
   public final ValidatedProperty getValidatedProperty(
       final PropertyDescriptor descriptor, final Object defaultValue)
     throws IllegalArgumentException, UnknownPropertyException,
     PropertyValidationException
   {
     final DependencyTrackingCache cache = getCache();
     final ValidatedProperty property =
         cache.getValidatedProperty(getDelegate(), descriptor, defaultValue);
     return property;
   }
 
   @Override
   public final DescribedProperty getProperty(final PropertyDescriptor descriptor,
       final Object defaultValue) throws IllegalArgumentException,
     UnknownPropertyException
   {
     final DependencyTrackingCache cache = getCache();
     final DescribedProperty property =
         cache.getProperty(getDelegate(), descriptor, defaultValue);
     return property;
   }
 
   @Override
   public final DescribedProperty getProperty(final String key)
     throws IllegalArgumentException, UnknownPropertyException
   {
     return getProperty(key, null);
   }
 
   @Override
   public final DescribedProperty getProperty(final String key, final Object defaultValue)
     throws IllegalArgumentException, UnknownPropertyException
   {
     final PropertyDescriptor descriptor = getDescriptor(key);
     return getProperty(descriptor, defaultValue);
   }
 
   @Override
   public final Object getPropertyValue(final PropertyDescriptor descriptor,
       final Object defaultValue) throws IllegalArgumentException,
     UnknownPropertyException, PropertyValidationException
   {
     final ValidatedProperty property =
         getValidatedProperty(descriptor, defaultValue);
     return property.getValidatedValue();
   }
 
   @Override
   public final <T> T getProperties(final Class<T> propertiesInterface)
   {
     return getDelegate().getProperties(propertiesInterface, toSerializable());
   }
 
   // ... set property / properties
 
   @Override
   public final Property setProperty(final PropertyKey key, final String value)
     throws NullPointerException, PropertyValidationException,
     ReadOnlyPropertyException
   {
     final Property oldProperty = getDelegate().setProperty(key, value);
     final String stringKey = key.toString();
     cache.removeFromCache(stringKey);
     return oldProperty;
   }
 
   @Override
   public final Property unsetProperty(final PropertyKey key)
     throws NullPointerException, ReadOnlyPropertyException
   {
     final Property oldProperty = getDelegate().unsetProperty(key);
     final String stringKey = key.toString();
     cache.removeFromCache(stringKey);
     return oldProperty;
   }
 
   @Override
   public final ConfigurationPropertiesManagement addDefinitions(
       final PropertyProvider provider) throws NullPointerException
   {
     final ConfigurationPropertiesManagement manager =
         getDelegate().addDefinitions(provider);
 
     final PropertyCollection collection = provider.getProperties();
     cache.removeFromCache(collection);
 
     return manager;
   }
 
   @Override
   public final void flush()
   {
     getDelegate().flush();
   }
 
   // ... delegation only ......................................................
 
   @Override
   public final PropertyDescriptorRegistry getRegistry()
   {
     return getDelegate().getRegistry();
   }
 
   @Override
   public PropertyValueSecurity getPropertyValueSecurity()
   {
     return getDelegate().getPropertyValueSecurity();
   }
 
   @Override
   public final Object getPropertyValue(final PropertyDescriptor descriptor)
     throws NullPointerException, PropertyValidationException
   {
     return getPropertyValue(descriptor, null);
   }
 
   @Override
   public final Object getPropertyValue(final PropertyKey key)
     throws IllegalArgumentException, UnknownPropertyException,
     PropertyValidationException
   {
     final PropertyDescriptor descriptor = getDescriptor(key.toString());
     return getPropertyValue(descriptor);
   }
 
   @Override
   public final Object getPropertyValue(final String key,
       final Object defaultValue) throws NullPointerException,
     PropertyValueConversionException, PropertyValidationException,
     UnknownPropertyException
   {
     final PropertyDescriptor descriptor = getDescriptor(key);
     return getPropertyValue(descriptor, defaultValue);
   }
 
   @Override
   public final Object getPropertyValue(final String key)
     throws IllegalArgumentException, UnknownPropertyException,
     PropertyValidationException
   {
     return getPropertyValue(key, null);
   }
 
   @Override
   public final String getPropertyValueAsString(
       final PropertyDescriptor descriptor) throws NullPointerException,
     PropertyValidationException
   {
     final Object value = getPropertyValue(descriptor);
     return ObjectUtils.toString(value, null);
   }
 
   @Override
   public final String getPropertyValueAsString(final String key)
     throws IllegalArgumentException, UnknownPropertyException,
     PropertyValidationException
   {
     final PropertyDescriptor descriptor = getDescriptor(key);
     final Object value = getPropertyValue(descriptor);
     return ObjectUtils.toString(value, null);
   }
 
   @Override
   public final String getPropertyValueAsString(
       final PropertyDescriptor descriptor, final Object defaultValue)
     throws NullPointerException, PropertyValidationException
   {
     final Object value = getPropertyValue(descriptor, defaultValue);
     return ObjectUtils.toString(value, null);
   }
 
   @Override
   public final String getPropertyValueAsString(final String key,
       final Object defaultValue) throws IllegalArgumentException,
     UnknownPropertyException, PropertyValidationException
   {
     final PropertyDescriptor descriptor = getDescriptor(key);
     final Object value = getPropertyValue(descriptor, defaultValue);
     return ObjectUtils.toString(value, null);
   }
 
   @Override
   public final DescribedProperty getProperty(final PropertyKey key)
     throws IllegalArgumentException, UnknownPropertyException
   {
     final PropertyDescriptor descriptor = getDescriptor(key.toString());
     return getProperty(descriptor);
   }
 
   @Override
   public final DescribedProperty getProperty(final PropertyDescriptor descriptor)
     throws IllegalArgumentException, UnknownPropertyException
   {
     return getProperty(descriptor, null);
   }
 
   @Override
   public final ValidatedProperty getValidatedProperty(final String key,
       final Object defaultValue) throws IllegalArgumentException,
     UnknownPropertyException, PropertyValidationException
   {
     final PropertyDescriptor descriptor = getDescriptor(key);
     return getValidatedProperty(descriptor, defaultValue);
   }
 
   @Override
   public final ValidatedProperty getValidatedProperty(final PropertyKey key,
       final Object defaultValue) throws IllegalArgumentException,
     UnknownPropertyException, PropertyValidationException
   {
     final PropertyDescriptor descriptor = getDescriptor(key.toString());
     return getValidatedProperty(descriptor, defaultValue);
   }
 
   @Override
   public final void addDescriptors(final Class<?> propertySetType)
     throws DuplicatePropertyDeclarationsException
   {
     getDelegate().addDescriptors(propertySetType);
   }
 
   @Override
   public final ConfigurationKey<?> getKey()
   {
     return getDelegate().getKey();
   }
 
   @Override
   public final PropertyDescriptor getDescriptor(final String key)
     throws UnknownPropertyException
   {
     return getDelegate().getDescriptor(key);
   }
 
   @Override
   public final PropertiesContext getContext(final Class<?> declaringType)
     throws NullPointerException
   {
     return getDelegate().getContext(declaringType);
   }
 
   @Override
   public final PropertyDescriptor getDescriptor(final PropertyKey key)
     throws UnknownPropertyException
   {
     return getDelegate().getDescriptor(key);
   }
 
   @Override
   public final List<PropertyDescriptor> getMandatoryPropertyDescriptors()
   {
     return getDelegate().getMandatoryPropertyDescriptors();
   }
 
   @Override
   public final PropertyContext getContext(final PropertyDescriptor descriptor)
     throws NullPointerException
   {
     return getDelegate().getContext(descriptor);
   }
 
   @Override
   public final void validate() throws ConfigurationValidationException
   {
     getDelegate().validate();
   }
 
   @Override
   public final void validate(final Class<?>... groups)
     throws ConfigurationValidationException
   {
     getDelegate().validate(groups);
   }
 
   @Override
   public final void validate(final boolean lenient, final Class<?>... groups)
     throws ConfigurationValidationException
   {
     getDelegate().validate(lenient, groups);
   }
 
   @Override
   public final void validate(final PropertyDescriptor descriptor,
       final Class<?>... ifInOneOfTheseGroups)
     throws ConfigurationValidationException
   {
     getDelegate().validate(descriptor, ifInOneOfTheseGroups);
   }
 
   @Override
   public final void validate(final PropertyDescriptor descriptor,
       final String value, final Class<?>... ifInOneOfTheseGroups)
     throws ConfigurationValidationException
   {
     getDelegate().validate(descriptor, value, ifInOneOfTheseGroups);
   }
 
   @Override
   public final void addPropertyChangeListener(final PropertyKey name,
       final PropertyChangeListener listener) throws NullPointerException
   {
     getDelegate().addPropertyChangeListener(name, listener);
   }
 
   @Override
   public final void removePropertyChangeListener(final PropertyKey name,
       final PropertyChangeListener listener) throws NullPointerException
   {
     getDelegate().removePropertyChangeListener(name, listener);
   }
 
   @Override
   public final void addPropertyChangeListener(
       final PropertyChangeListener listener) throws NullPointerException
   {
     getDelegate().addPropertyChangeListener(listener);
   }
 
   @Override
   public final void removePropertyChangeListener(
       final PropertyChangeListener listener) throws NullPointerException
   {
     getDelegate().removePropertyChangeListener(listener);
   }
 
   // --- object basics --------------------------------------------------------
 
 }