com.google.api.ads.common.lib.useragent.UserAgentCombiner 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 2012 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.useragent;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Joiner;
import com.google.common.base.Predicates;
import com.google.common.collect.Collections2;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.inject.Inject;
import java.util.List;

/**
 * Combines all user agents along with a user supplied string.
 */
public class UserAgentCombiner {

  private ImmutableList userAgentProviders;
  
  /**
   * Constructor that builds an instance based on a list of underlying user agent
   * providers. The {@code xyzHolder} parameters are for user agent providers that
   * may be null in certain contexts.
   *
   * @param productUserAgentProvider the product user agent library user agent provider
   * @param productFrameworkProviderHolder holder for the product/framework user agent
   *        provider
   * @param adsLibraryUserAgentProvider the ads library user agent provider
   * @param frameworkProviderHolder holder for the framework user agent provider
   * @param runtimeUserAgentProvider the runtime user agent provider
   * @param buildTypeUserAgentProvider the build type user agent provider
   * @param extensionProviderHolder holder for the extension user agent provider
   */
  @Inject
  public UserAgentCombiner(ProductUserAgentProvider productUserAgentProvider,
      ProductFrameworkProviderHolder productFrameworkProviderHolder,
      AdsLibraryUserAgentProvider adsLibraryUserAgentProvider,
      FrameworkProviderHolder frameworkProviderHolder,
      RuntimeUserAgentProvider runtimeUserAgentProvider,
      BuildTypeUserAgentProvider buildTypeUserAgentProvider,
      AdsUtilitiesUserAgentProvider adsUtilitiesUserAgentProvider,
      ExtensionProviderHolder extensionProviderHolder) {
    this(
        Lists.newArrayList(
            productUserAgentProvider,
            productFrameworkProviderHolder.value,
            adsLibraryUserAgentProvider,
            frameworkProviderHolder.value,
            runtimeUserAgentProvider,
            buildTypeUserAgentProvider,
            adsUtilitiesUserAgentProvider,
            extensionProviderHolder.value));
  }

  /**
   * Constructor used for testing.
   *
   * @param userAgentProviders the user agent providers
   * utilities agent provider
   */
  @VisibleForTesting
  UserAgentCombiner(
      List userAgentProviders) {
    // Remove any nulls from the list, since ImmutableList does not support null entries.
    this.userAgentProviders = ImmutableList.copyOf(
        Collections2.filter(userAgentProviders, Predicates.notNull()));
  }

  /**
   * Gets the full user agent in the form of
   * {@code "(UserAgent1,UserAgent2,UserAgent3,...)"}
   */
  public String getUserAgent(String nonLibraryUserAgent) {
    StringBuilder agentStringBuilder = new StringBuilder();
    agentStringBuilder.append(nonLibraryUserAgent);
    agentStringBuilder.append(" (");
    Joiner.on(", ")
        .skipNulls()
        .appendTo(
            agentStringBuilder,
            Iterables.transform(
                userAgentProviders, input -> input == null ? null : input.getUserAgent()));
    agentStringBuilder.append(')');
    return agentStringBuilder.toString();
  }
  
  /**
   * Holder that allows for optional injection of a {@link
   * ProductFrameworkUserAgentProvider}.
   * This is necessary because UserAgentCombiner instances are used in multiple contexts, some of
   * which do not have an associated SOAP toolkit. In such cases, the {@code value} will be null.
   */
  static class ProductFrameworkProviderHolder {
    @Inject(optional = true) ProductFrameworkUserAgentProvider value;
  }

  /**
   * Holder that allows for optional injection of a {@link FrameworkUserAgentProvider}.
   * This is necessary because UserAgentCombiner instances are used in multiple contexts, some of
   * which do not have an associated SOAP toolkit. In such cases, the {@code value} will be null.
   */
  static class FrameworkProviderHolder {
    @Inject(optional = true) FrameworkUserAgentProvider value;
  }
  
  /**
   * Holder that allows for optional injection of a {@link ExtensionUserAgentProvider}.
   * This is necessary because the {@link ExtensionUserAgentProvider} type will only be bound if an
   * extension or application provided an {@code AdWordsPluginModule} to the Guice injector.
   * Otherwise, the {@code value} will be null.
   */
  static class ExtensionProviderHolder {
    @Inject(optional = true) ExtensionUserAgentProvider value;
  }
}