alluxio.underfs.gcs.GCSUnderFileSystemFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of alluxio-underfs-gcs Show documentation
Google Cloud Storage (GCS) Under File System implementation
The newest version!
/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio.underfs.gcs;

import alluxio.AlluxioURI;
import alluxio.Constants;
import alluxio.conf.PropertyKey;
import alluxio.exception.runtime.InvalidArgumentRuntimeException;
import alluxio.underfs.UnderFileSystem;
import alluxio.underfs.UnderFileSystemConfiguration;
import alluxio.underfs.UnderFileSystemFactory;
import alluxio.underfs.gcs.v2.GCSV2UnderFileSystem;

import com.google.common.base.Preconditions;
import com.google.common.base.Throwables;
import org.jets3t.service.ServiceException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import javax.annotation.concurrent.ThreadSafe;

/**
 * Factory for creating {@link GCSUnderFileSystem} or {@link GCSV2UnderFileSystem}
 * based on the {@link PropertyKey#UNDERFS_GCS_VERSION}.
 */
@ThreadSafe
public final class GCSUnderFileSystemFactory implements UnderFileSystemFactory {
  private static final Logger LOG = LoggerFactory.getLogger(GCSUnderFileSystemFactory.class);
  private static final int GCS_VERSION_TWO = 2;

  /**
   * Constructs a new {@link GCSUnderFileSystemFactory}.
   */
  public GCSUnderFileSystemFactory() {}

  @Override
  public UnderFileSystem create(String path, UnderFileSystemConfiguration conf) {
    Preconditions.checkNotNull(path, "Unable to create UnderFileSystem instance:"
        + " URI path should not be null");
    if (conf.getInt(PropertyKey.UNDERFS_GCS_VERSION) == GCS_VERSION_TWO) {
      try {
        return GCSV2UnderFileSystem.createInstance(new AlluxioURI(path), conf);
      } catch (IOException e) {
        LOG.error("Failed to create GCSV2UnderFileSystem.", e);
        throw Throwables.propagate(e);
      }
    }
    else {
      if (checkGCSCredentials(conf)) {
        try {
          return GCSUnderFileSystem.createInstance(new AlluxioURI(path), conf);
        } catch (ServiceException e) {
          LOG.error("Failed to create GCSUnderFileSystem.", e);
          throw Throwables.propagate(e);
        }
      }
    }
    String err = "GCS credentials or version not available, cannot create GCS Under File System.";
    throw new InvalidArgumentRuntimeException(err);
  }

  @Override
  public boolean supportsPath(String path) {
    return path != null && path.startsWith(Constants.HEADER_GCS);
  }

  /**
   * @param conf optional configuration object for the UFS
   * @return true if access, secret and endpoint keys are present, false otherwise
   */
  private boolean checkGCSCredentials(UnderFileSystemConfiguration conf) {
    return conf.isSet(PropertyKey.GCS_ACCESS_KEY)
        && conf.isSet(PropertyKey.GCS_SECRET_KEY);
  }
}