/*
    * 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.jndi;
  
  import java.util.List;
  
  import javax.annotation.concurrent.ThreadSafe;
  import javax.naming.Context;
  import javax.naming.InitialContext;
  import javax.naming.NamingException;
  
  import de.smartics.properties.api.config.domain.ConfigurationException;
  import de.smartics.properties.api.config.domain.ConfigurationPropertiesManagement;
  import de.smartics.properties.api.config.domain.PropertyProvider;
  import de.smartics.properties.api.config.domain.key.ConfigurationKey;
  import de.smartics.properties.api.config.domain.key.ConfigurationKeyFactory;
  import de.smartics.properties.api.core.app.JndiContext;
  import de.smartics.properties.impl.config.cache.CacheConfigurationPropertiesManagement;
  import de.smartics.properties.spi.config.domain.key.ConfigurationKeyContextManager;
  import de.smartics.properties.spi.config.support.AbstractConfigurationPropertiesFactory;
  
  /**
   * Factory to create instances of {@link JndiConfigurationProperties}.
   */
  @ThreadSafe
  public final class JndiConfigurationPropertiesFactory extends
      AbstractConfigurationPropertiesFactory<ConfigurationPropertiesManagement>
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @throws IllegalStateException if the JNDI context cannot be accessed.
     */
    public JndiConfigurationPropertiesFactory() throws IllegalStateException
    {
      getFactoryConfiguration().setSkipClassPathPropertyLoading(true);
      init();
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    private void init() throws IllegalStateException
    {
      try
      {
        final Context jndi = new InitialContext();
        final List<String> keys = JndiContext.configKeys(jndi);
        for (final String key : keys)
        {
          final JndiContext context = JndiContext.config(jndi, key);
          final ConfigurationKey<?> configurationKey = parseKey(context, key);
          final PropertyProvider provider =
              new JndiConfigurationPropertyProvider(configurationKey, context);
          addPropertyProviders(provider);
        }
      }
      catch (final NamingException e)
      {
        // FIXME: smartics-exception
        throw new IllegalStateException("Cannot access JNDI context.");
      }
    }
  
    private ConfigurationKey<?> parseKey(final JndiContext context,
        final String key)
    {
      final ConfigurationKeyFactory<?> factory =
         ConfigurationKeyContextManager.INSTANCE.context()
             .configurationKeyFactory();
     try
     {
       final ConfigurationKey<?> configurationKey =
           factory.createKeyFromString(key);
       return configurationKey;
     }
     catch (final IllegalArgumentException e)
     {
       final JndiContextMessageBean message =
           JndiContextMessageBean.invalidKey(e, context.getSourceId(), key);
       throw new JndiPropertyStoreException(message);
     }
   }
 
   // --- get&set --------------------------------------------------------------
 
   // --- business -------------------------------------------------------------
 
   /**
    * Creates an empty instance of the configuration properties instance. Where
    * the public create methods may consult a cache, this method is required to
    * create a new instance.
    *
    * @param key the key to the instance.
    * @return the instance. Never <code>null</code>.
    * @throws NullPointerException if {@code key} is <code>null</code>.
    * @throws ConfigurationException if the configuration cannot be created.
    * @throws IllegalStateException if the JNDI context cannot be accessed to
    *           create a new configuration.
    */
   protected ConfigurationPropertiesManagement createNewConfiguration(
       final ConfigurationKey<?> key) throws NullPointerException,
     ConfigurationException, IllegalStateException
   {
     try
     {
       final ConfigurationPropertiesManagement config = createCache(key);
       return config;
     }
     catch (final NamingException e)
     {
       throw new IllegalStateException("Cannot fetch configuration for key '"
                                       + key + "' from JNDI.", e); // TODO
                                                                   // smartics-exception
     }
   }
 
   private ConfigurationPropertiesManagement createCache(
       final ConfigurationKey<?> key) throws NamingException
   {
     final JndiConfigurationProperties uncached =
         new JndiConfigurationProperties(key, getRegistry(),
             getFactoryConfiguration().getDecrypter());
     if (getFactoryConfiguration().isUseCache())
     {
       return new CacheConfigurationPropertiesManagement(uncached);
     }
     else
     {
       return uncached;
     }
   }
 
   // --- object basics --------------------------------------------------------
 
 }