/*
    * Copyright 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.admin.domain.service;
  
  import static de.smartics.properties.admin.domain.service.ApplicationIdConfigurationLoader.ARCHIVE_TYPE;
  import static de.smartics.properties.admin.domain.service.ApplicationIdConfigurationLoader.ARTIFACT_ID;
  import static de.smartics.properties.admin.domain.service.ApplicationIdConfigurationLoader.CLASSIFIER;
  import static de.smartics.properties.admin.domain.service.ApplicationIdConfigurationLoader.GROUP_ID;
  import static de.smartics.properties.admin.domain.service.ApplicationIdConfigurationLoader.VERSION;
  
  import java.io.BufferedInputStream;
  import java.io.IOException;
  import java.io.InputStream;
  import java.io.Serializable;
  import java.net.URL;
  import java.util.Collections;
  import java.util.Enumeration;
  import java.util.List;
  import java.util.Properties;
  
  import org.apache.commons.io.IOUtils;
  import org.apache.commons.lang.StringUtils;
  
  import de.smartics.properties.api.core.domain.PropertiesContext;
  import de.smartics.properties.resource.domain.ArtifactId;
  
  /**
   * Responsible to read application identifier properties from the classpath.
   */
  public class ApplicationIdConfigurationPropertiesLoader implements Serializable
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final long serialVersionUID = 1L;
  
    /**
     * The location within the classpath to find the configuration file to load.
     */
    public static final String CLASSPATH_LOCATION =
        PropertiesContext.BOOT_PROPERTIES_HOME + "/application-id.properties";
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     */
    public ApplicationIdConfigurationPropertiesLoader()
    {
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    /**
     * Loads the application identifier configuration.
     *
     * @return the application identifier configuration.
     */
    public ArtifactId load()
    {
      try
      {
        final Properties properties = loadProperties();
  
        final String classifier = readClassifier(properties);
        final ArtifactId applicationId =
            new ArtifactId.Builder()
               .withGroupId(properties.getProperty(GROUP_ID))
               .withName(properties.getProperty(ARTIFACT_ID))
               .withVersion(properties.getProperty(VERSION))
               .withArchiveType(properties.getProperty(ARCHIVE_TYPE))
               .withClassifier(classifier).build();
 
       return applicationId;
     }
     catch (final IOException e)
     {
       throw new IllegalStateException(String.format(
           "Cannot define the application identifier: %s", e.getMessage(), e));
     }
   }
 
   private static String readClassifier(final Properties properties)
   {
     final String classifier = properties.getProperty(CLASSIFIER);
     if (StringUtils.isBlank(classifier))
     {
       return null;
     }
     return classifier;
   }
 
   private Properties loadProperties() throws IOException
   {
     final Enumeration<URL> urlsEnum =
         Thread.currentThread().getContextClassLoader()
             .getResources(CLASSPATH_LOCATION);
     final List<URL> urls = Collections.list(urlsEnum);
     final int count = urls.size();
     if (count == 1)
     {
       final URL url = urls.get(0);
       final Properties properties = new Properties();
 
       final InputStream in = new BufferedInputStream(url.openStream());
       try
       {
         properties.load(in);
       }
       finally
       {
         IOUtils.closeQuietly(in);
       }
       return properties;
     }
     else if (count == 0)
     {
       throw new IllegalStateException(String.format(
           "Cannot find '%s' to configure the application identifier.",
           CLASSPATH_LOCATION));
     }
     else
     {
       throw new IllegalStateException(String.format(
           "Found more than one configuration for '%s' to define the"
               + " application identifier: %s", CLASSPATH_LOCATION, urls));
     }
   }
 
   // --- object basics --------------------------------------------------------
 
 }