lang/java/reef-runtime-azbatch/src/main/java/org/apache/reef/runtime/azbatch/client/AzureBatchRuntimeConfigurationCreator.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.reef.runtime.azbatch.client;

import org.apache.reef.annotations.audience.Private;
import org.apache.reef.runtime.azbatch.parameters.AzureBatchAccountKey;
import org.apache.reef.runtime.azbatch.parameters.AzureBatchAccountName;
import org.apache.reef.runtime.azbatch.parameters.AzureBatchAccountUri;
import org.apache.reef.runtime.azbatch.parameters.AzureBatchPoolId;
import org.apache.reef.runtime.azbatch.util.command.CommandBuilder;
import org.apache.reef.runtime.azbatch.util.command.LinuxCommandBuilder;
import org.apache.reef.runtime.azbatch.util.command.WindowsCommandBuilder;
import org.apache.reef.runtime.azbatch.parameters.AzureStorageAccountKey;
import org.apache.reef.runtime.azbatch.parameters.AzureStorageAccountName;
import org.apache.reef.runtime.azbatch.parameters.AzureStorageContainerName;
import org.apache.reef.tang.formats.ConfigurationModule;
import org.apache.reef.tang.formats.ConfigurationModuleBuilder;

/**
 * Class that builds the ConfigurationModule for Azure Batch runtime.
 */
@Private
public final class AzureBatchRuntimeConfigurationCreator {

  /**
   * The ConfigurationModule for Azure Batch.
   */
  private static ConfigurationModule conf;

  /**
   * Get or create a {@link ConfigurationModule} for the Azure Batch runtime.
   *
   * @param isWindows true if Azure Batch pool nodes run Windows, false otherwise.
   * @return the configuration module object.
   */
  public static ConfigurationModule getOrCreateAzureBatchRuntimeConfiguration(final boolean isWindows) {

    if (AzureBatchRuntimeConfigurationCreator.conf == null) {
      ConfigurationModuleBuilder builder = AzureBatchRuntimeConfigurationStatic.CONF;
      ConfigurationModule module;
      if (isWindows) {
        module = builder.bindImplementation(CommandBuilder.class, WindowsCommandBuilder.class).build();
      } else {
        module = builder.bindImplementation(CommandBuilder.class, LinuxCommandBuilder.class).build();
      }

      AzureBatchRuntimeConfigurationCreator.conf = new AzureBatchRuntimeConfiguration()
          .merge(module)
          .bindNamedParameter(AzureBatchAccountName.class, AzureBatchRuntimeConfiguration.AZURE_BATCH_ACCOUNT_NAME)
          .bindNamedParameter(AzureBatchAccountUri.class, AzureBatchRuntimeConfiguration.AZURE_BATCH_ACCOUNT_URI)
          .bindNamedParameter(AzureBatchAccountKey.class, AzureBatchRuntimeConfiguration.AZURE_BATCH_ACCOUNT_KEY)
          .bindNamedParameter(AzureBatchPoolId.class, AzureBatchRuntimeConfiguration.AZURE_BATCH_POOL_ID)
          .bindNamedParameter(AzureStorageAccountName.class, AzureBatchRuntimeConfiguration.AZURE_STORAGE_ACCOUNT_NAME)
          .bindNamedParameter(AzureStorageAccountKey.class, AzureBatchRuntimeConfiguration.AZURE_STORAGE_ACCOUNT_KEY)
          .bindNamedParameter(
              AzureStorageContainerName.class, AzureBatchRuntimeConfiguration.AZURE_STORAGE_CONTAINER_NAME)
          .build();
    }

    return AzureBatchRuntimeConfigurationCreator.conf;
  }

  /*
   * Private constructor since this is a utility class.
   */
  private AzureBatchRuntimeConfigurationCreator() {
  }
}