ConfigurationPropertiesProxy

/*
 * 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.beans.PropertyChangeListener;
import java.io.IOException;
import java.io.ObjectInputStream;

import de.smartics.properties.api.config.app.ConfigurationPropertiesFactory;
import de.smartics.properties.api.config.domain.ConfigurationProperties;
import de.smartics.properties.api.config.domain.ConfigurationValidationException;
import de.smartics.properties.api.config.domain.DescribedProperty;
import de.smartics.properties.api.config.domain.SerializableConfigurationProperties;
import de.smartics.properties.api.config.domain.UnknownPropertyException;
import de.smartics.properties.api.config.domain.ValidatedProperty;
import de.smartics.properties.api.config.domain.key.ConfigurationKey;
import de.smartics.properties.api.core.app.PropertyRootException;
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.PropertyKey;
import de.smartics.properties.api.core.domain.PropertyValidationException;
import de.smartics.properties.api.core.domain.PropertyValueConversionException;
import de.smartics.properties.api.core.security.SecurityException;

/**
 * A serialization proxy that allows non serializable configuration properties
 * instances to be serialized using their factories cache and ability to
 * recreate that instances.
 */
public class ConfigurationPropertiesProxy implements
    SerializableConfigurationProperties
{
  // ********************************* Fields *********************************

  // --- constants ------------------------------------------------------------

  /**
   * The class version identifier.
   */
  private static final long serialVersionUID = 1L;

  // --- members --------------------------------------------------------------

  /**
   * The key of the configuration properties instance is to be associated with.
   *
   * @serial
   */
  private final ConfigurationKey<?> key;

  /**
   * The factory to create instances of the configuration properties.
   *
   * @serial
   */
  private final ConfigurationPropertiesFactory factory;

  /**
   * The transient delegate.
   */
  private transient ConfigurationProperties 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 ConfigurationPropertiesProxy(final ConfigurationKey<?> key,
      final ConfigurationPropertiesFactory factory)
  {
    this.key = key;
    this.factory = factory;
    this.configuration = getConfiguration();
  }

  // ****************************** Inner Classes *****************************

  // ********************************* Methods ********************************

  // --- init -----------------------------------------------------------------

  private ConfigurationProperties getConfiguration()
  {
    final ConfigurationProperties properties = factory.create(key);
    return properties;
  }

  // --- get&set --------------------------------------------------------------

  /**
   * Returns the key of the configuration properties instance is to be
   * associated with.
   *
   * @return the key of the configuration properties instance is to be
   *         associated with.
   */
  @Override
  public final ConfigurationKey<?> getKey()
  {
    return key;
  }

  /**
   * Returns the factory to create instances of the configuration properties.
   *
   * @return the factory to create instances of the configuration properties.
   */
  protected final ConfigurationPropertiesFactory getFactory()
  {
    return factory;
  }

  @Override
  public boolean isInAdminMode()
  {
    return false;
  }

  // --- business -------------------------------------------------------------

  @Override
  public final PropertiesContext getContext(final Class<?> declaringType)
    throws NullPointerException
  {
    return configuration.getContext(declaringType);
  }

  @Override
  public final PropertyContext getContext(final PropertyDescriptor descriptor)
    throws NullPointerException
  {
    return configuration.getContext(descriptor);
  }

  @Override
  public final <T> T getProperties(final Class<T> propertiesInterface)
  {
    return configuration.getProperties(propertiesInterface);
  }

  @Override
  public final Object getPropertyValue(final PropertyDescriptor descriptor)
    throws NullPointerException, PropertyValidationException
  {
    return configuration.getPropertyValue(descriptor);
  }

  @Override
  public final Object getPropertyValue(final String key)
    throws IllegalArgumentException, UnknownPropertyException,
    PropertyValidationException
  {
    return configuration.getPropertyValue(key);
  }

  @Override
  public final Object getPropertyValue(final PropertyKey key)
    throws IllegalArgumentException, UnknownPropertyException,
    PropertyValidationException
  {
    return configuration.getPropertyValue(key);
  }

  @Override
  public final Object getPropertyValue(final PropertyDescriptor descriptor,
      final Object defaultValue) throws NullPointerException,
    PropertyValueConversionException, PropertyValidationException,
    UnknownPropertyException
  {
    return configuration.getPropertyValue(descriptor, defaultValue);
  }

  @Override
  public final Object getPropertyValue(final String key,
      final Object defaultValue) throws IllegalArgumentException,
    UnknownPropertyException, PropertyValidationException
  {
    return configuration.getPropertyValue(key, defaultValue);
  }

  @Override
  public final DescribedProperty getProperty(final String key)
    throws IllegalArgumentException, UnknownPropertyException
  {
    return configuration.getProperty(key);
  }

  @Override
  public final DescribedProperty getProperty(final String key,
      final Object defaultValue) throws IllegalArgumentException,
    UnknownPropertyException
  {
    return configuration.getProperty(key, defaultValue);
  }

  @Override
  public final DescribedProperty getProperty(final PropertyKey key)
    throws IllegalArgumentException, UnknownPropertyException
  {
    return configuration.getProperty(key);
  }

  @Override
  public final DescribedProperty getProperty(final PropertyDescriptor descriptor)
    throws IllegalArgumentException, UnknownPropertyException
  {
    return configuration.getProperty(descriptor);
  }

  @Override
  public final DescribedProperty getProperty(
      final PropertyDescriptor descriptor, final Object defaultValue)
    throws IllegalArgumentException, UnknownPropertyException
  {
    return configuration.getProperty(descriptor, defaultValue);
  }

  @Override
  public Object getPropertyAsType(final PropertyDescriptor descriptor)
    throws IllegalArgumentException, UnknownPropertyException,
    PropertyValueConversionException, SecurityException, PropertyRootException
  {
    return configuration.getPropertyAsType(descriptor);
  }

  @Override
  public final ValidatedProperty getValidatedProperty(
      final PropertyDescriptor descriptor, final Object defaultValue)
    throws IllegalArgumentException, UnknownPropertyException,
    PropertyValidationException
  {
    return configuration.getValidatedProperty(descriptor, defaultValue);
  }

  @Override
  public final ValidatedProperty getValidatedProperty(final PropertyKey key,
      final Object defaultValue) throws IllegalArgumentException,
    UnknownPropertyException, PropertyValidationException
  {
    return configuration.getValidatedProperty(key, defaultValue);
  }

  @Override
  public final ValidatedProperty getValidatedProperty(final String key,
      final Object defaultValue) throws IllegalArgumentException,
    UnknownPropertyException, PropertyValidationException
  {
    return configuration.getValidatedProperty(key, defaultValue);
  }

  @Override
  public final String getPropertyValueAsString(
      final PropertyDescriptor descriptor) throws NullPointerException,
    PropertyValidationException
  {
    return configuration.getPropertyValueAsString(descriptor);
  }

  @Override
  public final String getPropertyValueAsString(final String key)
    throws IllegalArgumentException, UnknownPropertyException,
    PropertyValidationException
  {
    return configuration.getPropertyValueAsString(key);
  }

  @Override
  public final String getPropertyValueAsString(
      final PropertyDescriptor descriptor, final Object defaultValue)
    throws NullPointerException, PropertyValidationException
  {
    return configuration.getPropertyValueAsString(descriptor, defaultValue);
  }

  @Override
  public final String getPropertyValueAsString(final String key,
      final Object defaultValue) throws IllegalArgumentException,
    UnknownPropertyException, PropertyValidationException
  {
    return configuration.getPropertyValueAsString(key, defaultValue);
  }

  @Override
  public final void validate() throws ConfigurationValidationException
  {
    configuration.validate();
  }

  @Override
  public final void validate(final Class<?>... groups)
    throws ConfigurationValidationException
  {
    configuration.validate(groups);
  }

  @Override
  public final void validate(final boolean lenient, final Class<?>... groups)
    throws ConfigurationValidationException
  {
    configuration.validate(lenient, groups);
  }

  @Override
  public final void validate(final PropertyDescriptor descriptor,
      final Class<?>... ifInOneOfTheseGroups)
    throws ConfigurationValidationException
  {
    configuration.validate(descriptor, ifInOneOfTheseGroups);
  }

  @Override
  public final void validate(final PropertyDescriptor descriptor,
      final String value, final Class<?>... ifInOneOfTheseGroups)
    throws ConfigurationValidationException
  {
    configuration.validate(descriptor, value, ifInOneOfTheseGroups);
  }

  @Override
  public final void addPropertyChangeListener(final PropertyKey name,
      final PropertyChangeListener listener) throws NullPointerException
  {
    configuration.addPropertyChangeListener(name, listener);
  }

  @Override
  public final void removePropertyChangeListener(final PropertyKey name,
      final PropertyChangeListener listener) throws NullPointerException
  {
    configuration.removePropertyChangeListener(name, listener);
  }

  @Override
  public final void addPropertyChangeListener(
      final PropertyChangeListener listener) throws NullPointerException
  {
    configuration.addPropertyChangeListener(listener);
  }

  @Override
  public final void removePropertyChangeListener(
      final PropertyChangeListener listener) throws NullPointerException
  {
    configuration.removePropertyChangeListener(listener);
  }

  @Override
  public ConfigurationProperties toRepresentative()
  {
    return this;
  }

  @Override
  public SerializableConfigurationProperties 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();
  }
}