DeploymentInfo.java

/*
 * Copyright © 2015 Cask Data, Inc.
 *
 * 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 co.cask.cdap.internal.app.deploy.pipeline;

import org.apache.twill.filesystem.Location;

import java.io.File;
import javax.annotation.Nullable;

/**
 * Contains information about input and output locations for deployment.
 * TODO: (CDAP-2662) remove after ApplicationTemplates are removed
 */
public class DeploymentInfo {

  private final File appJarFile;
  private final Location destination;
  private final ApplicationDeployScope applicationDeployScope;
  private final String configString;

  /**
   * Construct the DeploymentInfo with appJarFile and destination.
   *
   * @param appJarFile Application jar file that should be deployed. The File is expected to be present in the local
   *                   file system.
   * @param destination Destination that represents {@link Location} of the jar
   * @param configString application configuration in json
   */
  public DeploymentInfo(File appJarFile, Location destination, @Nullable String configString) {
    this.appJarFile = appJarFile;
    this.destination = destination;
    this.configString = configString;
    this.applicationDeployScope = ApplicationDeployScope.USER;
  }

  /**
   * Construct the DeploymentInfo with appJarFile, destination, and applicationScope.
   *
   * @param appJarFile Application jar file that should be deployed. The File is expected to be present in the local
   *                   file system.
   * @param destination Destination that represents {@link Location} of the jar
   * @param applicationDeployScope Scope that the application is being deployed in
   * @param configString application configuration in json
   */
  public DeploymentInfo(File appJarFile, Location destination, ApplicationDeployScope applicationDeployScope,
                        @Nullable String configString) {
    this.appJarFile = appJarFile;
    this.destination = destination;
    this.configString = configString;
    this.applicationDeployScope = applicationDeployScope;
  }

  public File getAppJarFile() {
    return appJarFile;
  }

  public Location getDestination() {
    return destination;
  }

  public ApplicationDeployScope getApplicationDeployScope() {
    return applicationDeployScope;
  }

  @Nullable
  public String getConfigString() {
    return configString;
  }
}