net.snowflake.client.jdbc.cloud.storage.StageInfo Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of snowflake-jdbc Show documentation
Snowflake JDBC Driver
There is a newer version: 3.18.0
package net.snowflake.client.jdbc.cloud.storage;

import java.util.Map;

/**
 * Encapsulates all the required stage properties used by GET/PUT
 * for Azure and S3 stages
 */
public class StageInfo
{
  public enum StageType
  {
    S3,
    AZURE,
    LOCAL_FS,
    GCS
  }

  ;
  private StageType stageType;        // The stage type
  private String location;            // The container or bucket
  private Map credentials;       // the credentials required for the  stage
  private String region;              // AWS/S3/GCS region (S3/GCS only)
  private String endPoint;            // The Azure Storage endpoint (Azure only)
  private String storageAccount;      // The Azure Storage account (Azure only)
  private String presignedUrl;        // GCS gives us back a presigned URL instead of a cred

  /*
   * Creates a StageInfo object
   * Validates that the necessary Stage info arguments are specified
   *
   * @param locationType the type of stage, i.e. AZURE/S3
   * @param location The container/bucket
   * @param credentials Map of cloud provider credentials
   * @param region The geographic region where the stage is located (S3 only)
   * @param endPoint The Azure Storage end point (Azure only)
   * @param storageAccount The Azure Storage account (azure only)
   * @throws IllegalArgumentException one or more parameters required were missing
   */
  public static StageInfo createStageInfo(String locationType,
                                          String location, Map credentials,
                                          String region, String endPoint, String storageAccount)
  throws IllegalArgumentException
  {
    StageType stageType;
    // Ensure that all the required parameters are specified
    switch (locationType)
    {
      case "AZURE":
        stageType = StageType.AZURE;
        if (!isSpecified(location) || !isSpecified(endPoint) || !isSpecified(storageAccount)
            || credentials == null)
        {
          throw new IllegalArgumentException("Incomplete parameters specified for Azure stage");
        }
        break;

      case "S3":
        stageType = StageType.S3;
        if (!isSpecified(location) || !isSpecified(region) || credentials == null)
        {
          throw new IllegalArgumentException("Incomplete parameters specified for S3 stage");
        }
        break;

      case "GCS":
        stageType = StageType.GCS;
        if (!isSpecified(location) || credentials == null)
        {
          throw new IllegalArgumentException("Incomplete parameters specified for GCS stage");
        }
        break;

      case "LOCAL_FS":
        stageType = StageType.LOCAL_FS;
        if (!isSpecified(location))
        {
          throw new IllegalArgumentException("Incomplete parameters specific for local stage");
        }
        break;

      default:
        throw new IllegalArgumentException("Invalid stage type: " + locationType);
    }
    return new StageInfo(stageType, location, credentials, region, endPoint, storageAccount);
  }

  /*
   * StageInfo constructor, accessible only via the createStageInfo method
   * Assumes valid parameters are specified
   *clear
   *
   * @param stageType the type of stage, i.e. AZURE/S3
   * @param location The container/bucket
   * @param credentials Map of cloud provider credentials
   * @param region The geographic region where the stage is located (S3 only)
   * @param endPoint The Azure Storage end point (Azure only)
   * @param storageAccount The Azure Storage account (azure only)
   */
  private StageInfo(StageType stageType, String location, Map credentials,
                    String region, String endPoint, String storageAccount)
  {
    this.stageType = stageType;
    this.location = location;
    this.credentials = credentials;
    this.region = region;
    this.endPoint = endPoint;
    this.storageAccount = storageAccount;
  }

  public StageType getStageType()
  {
    return stageType;
  }

  public String getLocation()
  {
    return location;
  }

  public Map getCredentials()
  {
    return credentials;
  }

  public void setCredentials(Map credentials)
  {
    this.credentials = credentials;
  }

  public String getRegion()
  {
    return region;
  }

  public String getEndPoint()
  {
    return endPoint;
  }

  public String getStorageAccount()
  {
    return storageAccount;
  }

  public String getPresignedUrl()
  {
    return presignedUrl;
  }

  public void setPresignedUrl(String presignedUrl)
  {
    this.presignedUrl = presignedUrl;
  }

  private static boolean isSpecified(String arg)
  {
    return !(arg == null || arg.equalsIgnoreCase(""));
  }
}