alluxio.underfs.obs.OBSUnderFileSystemFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alluxio-underfs-obs Show documentation

Huawei OBS Under File System implementation

There is a newer version: 313

/*
 * 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.obs;

import alluxio.AlluxioURI;
import alluxio.Constants;
import alluxio.conf.PropertyKey;
import alluxio.underfs.UnderFileSystem;
import alluxio.underfs.UnderFileSystemConfiguration;
import alluxio.underfs.UnderFileSystemFactory;

import com.google.common.base.Preconditions;
import com.google.common.base.Throwables;

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

/**
 * Factory for creating {@link OBSUnderFileSystem}.
 */
@ThreadSafe
public class OBSUnderFileSystemFactory implements UnderFileSystemFactory {

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

  @Override
  public UnderFileSystem create(String path, UnderFileSystemConfiguration conf) {
    Preconditions.checkNotNull(path, "path");

    if (checkOBSCredentials(conf)) {
      try {
        return OBSUnderFileSystem.createInstance(new AlluxioURI(path), conf);
      } catch (Exception e) {
        throw Throwables.propagate(e);
      }
    }

    String err = "OBS credentials or endpoint not available, cannot create OBS Under File System.";
    throw Throwables.propagate(new IOException(err));
  }

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

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