/*
    * 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.domain.key.rtaware;
  
  import de.smartics.properties.api.config.domain.key.ConfigurationKeyFactory;
  import de.smartics.properties.api.config.domain.key.ConfigurationKeyHelper;
  import de.smartics.properties.api.config.domain.key.KeyListBuilder;
  import de.smartics.properties.spi.config.definition.DefinitionConfigParser;
  import de.smartics.properties.spi.config.definition.DefinitionKeyHelper;
  import de.smartics.properties.spi.config.definition.PropertiesDefinitionContext;
  import de.smartics.properties.spi.config.domain.key.ConfigurationKeyContext;
  
  /**
   * Implementation that supports environment, application, tenant, and user IDs.
   */
  public final class TenantUserConfigurationKeyContext implements
      ConfigurationKeyContext
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * Provides access to the configuration key factory.
     */
    private final TenantUserConfigurationKeyFactory factory =
        new TenantUserConfigurationKeyFactory();
  
    /**
     * Provides exploding a configuration key to its defaulting configuration
     * keys.
     */
    private final TenantUserKeyListBuilder builder =
        new TenantUserKeyListBuilder();
  
    /**
     * Provides parsing the <code>definition.xml</code> file for properties.
     */
    private final TenantUserDefinitionConfigParser parser =
        new TenantUserDefinitionConfigParser();
  
    /**
     * The default, contextless helper to deal with definition keys.
     */
    private final TenantUserDefinitionKeyHelper defaultHelper =
        new TenantUserDefinitionKeyHelper();
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     */
    public TenantUserConfigurationKeyContext()
    {
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    @Override
    public ConfigurationKeyFactory<?> configurationKeyFactory()
    {
      return factory;
    }
  
    @Override
    public KeyListBuilder keyListBuilder()
    {
      return builder;
    }
  
    @Override
    public DefinitionConfigParser<?> definitionConfigParser()
    {
      return parser;
   }
 
   @Override
   public DefinitionKeyHelper definitionKeyHelper()
   {
     return defaultHelper;
   }
 
   @Override
   public DefinitionKeyHelper definitionKeyHelper(
       final PropertiesDefinitionContext definitionContext)
   {
     return new TenantUserDefinitionKeyHelper(
         (TenantUserPropertiesDefinitionContext) definitionContext);
   }
 
   @Override
   public ConfigurationKeyHelper configurationKeyHelper(
       final boolean preferEarManifest)
   {
     final TenantUserConfigurationKeyHelper configurationKeyHelper =
         new TenantUserConfigurationKeyHelper(preferEarManifest);
     return configurationKeyHelper;
   }
 
   // --- object basics --------------------------------------------------------
 
 }