com.google.api.ads.common.lib.conf.ConfigurationModule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ads-lib Show documentation

Client library for Java for accessing ads APIs including DFP. If you want to use this library, you must also include another Maven artifact to specify which framework you would like to use it with. For example, to use DFP with Axis, you should include the "dfp-axis" artifact.

There is a newer version: 5.6.0

Show newest version

// Copyright 2011 Google Inc. All Rights Reserved.
//
// 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 com.google.api.ads.common.lib.conf;

import com.google.api.ads.common.lib.utils.Builder;
import com.google.common.collect.Lists;
import com.google.inject.AbstractModule;
import com.google.inject.name.Names;
import java.net.URL;
import java.util.List;
import javax.annotation.Nullable;
import org.apache.commons.configuration.Configuration;

/**
 * Module for configuration.
 */
public abstract class ConfigurationModule extends AbstractModule {

  private static final String BUILD_PROPERTIES = "props/google-ads-api-java-build.properties";

  @Override
  protected void configure() {}

  /**
   * Configures configurations.
   *
   * @param apiConfigurationClass the API configuration class
   * @param apiPropertyUrls the API properties file URLs
   * @param apiPropertyFilePaths the API properties file paths or names
   * @param adsLibConfigurationClass the lib configuration class
   * @param libPropertyUrls the lib properties files
   * @param libPropertyFilePaths the lib properties file paths or names
   * @param productPropertyUrls the product build properties files
   */
  protected void configureConfigurations(
      Class apiConfigurationClass,
      @Nullable List apiPropertyUrls, @Nullable List apiPropertyFilePaths,
      Class adsLibConfigurationClass,
      @Nullable List libPropertyUrls, @Nullable List libPropertyFilePaths,
      List productPropertyUrls) {
    bind(AdsApiConfiguration.class).to(apiConfigurationClass).asEagerSingleton();
    bind(AdsLibConfiguration.class).to(adsLibConfigurationClass).asEagerSingleton();
    bind(Configuration.class).annotatedWith(Names.named("api")).toProvider(
        new ConfigurationProvider(ConfigurationHelper.newList(apiPropertyUrls, false),
            ConfigurationHelper.newList(apiPropertyFilePaths, true)));
    bind(Configuration.class).annotatedWith(Names.named("lib")).toProvider(
        new ConfigurationProvider(ConfigurationHelper.newList(libPropertyUrls, false),
            getFilePathConfigurationListWithDefault(libPropertyFilePaths,
                Builder.DEFAULT_CONFIGURATION_FILENAME)));
    bind(Configuration.class).annotatedWith(Names.named("build")).toProvider(
        new ConfigurationProvider(ConfigurationHelper.newList(
            Lists.newArrayList(ConfigurationModule.class.getResource(BUILD_PROPERTIES)), false),
            null));
    bind(Configuration.class).annotatedWith(Names.named("product")).toProvider(
        new ConfigurationProvider(ConfigurationHelper.newList(productPropertyUrls, false), null));
  }

  /**
   * Gets a combined configuration list with the default added last so that
   * {@code filePaths} will override {@code defaultFilePath}.
   */
  private List>
      getFilePathConfigurationListWithDefault(@Nullable List filePaths,
       String defaultFilePath) {
    List> defaultConfigList =
        ConfigurationHelper.newList(true, defaultFilePath);
    List> filePathConfigList =
        ConfigurationHelper.newList(filePaths, true);
    if (defaultConfigList != null) {
      if (filePathConfigList == null) {
        filePathConfigList = defaultConfigList;
      } else {
        filePathConfigList.addAll(defaultConfigList);
      } 
    }
    return filePathConfigList;
  }
}