com.google.cloud.hadoop.gcsio.GoogleCloudStorageStrings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gcs-connector Show documentation
An implementation of org.apache.hadoop.fs.FileSystem targeting Google Cloud Storage
There is a newer version: 3.0.4
/**
 * Copyright 2013 Google Inc. All Rights Reserved.
 * 
 * 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 com.google.cloud.hadoop.gcsio;

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

/**
 * Contains helper methods for standardizing String-matching algorithms specific to GCS.
 */
public class GoogleCloudStorageStrings {
  /**
   * Helper which mimics the GCS API behavior for taking an existing objectName and checking if it
   * matches a user-supplied prefix with an optional directory "delimiter". If it matches, either
   * the full objectName will be returned unmodified, or the return value will be a String which
   * is a prefix of the objectName inclusive of the matching prefix but truncating any suffix past
   * the first appearance of the delimiter after the full prefix. The returned prefix includes
   * the delimiter String at which the objectName was truncated.
   *
   * @param objectNamePrefix The prefix which {@code objectName} must match to be returned in any
   *     form. May be null; then an objectName will always be returned, just possibly truncated.
   * @param delimiter The delimiter (usually a directory separator, e.g. '/') at which to truncate
   *     the returned objectName after including the matched prefix. May be null for no truncation.
   * @param objectName The name to attempt to match against the prefix and delimiter.
   * @return A substring of objectName or the full unaltered objectName after applying GCS matching
   *     logic, or null if the supply objectName does not match the provided prefix.
   */
  public static String matchListPrefix(
      String objectNamePrefix, String delimiter, String objectName) {
    Preconditions.checkArgument(!Strings.isNullOrEmpty(objectName),
        String.format("objectName must not be null or empty, had args %s/%s/%s: ",
            objectNamePrefix, delimiter, objectName));

    // The suffix which we'll use to check for the delimiter is just the whole name if no prefix
    // was supplied.
    String suffix = objectName;
    int suffixIndex = 0;
    if (objectNamePrefix != null) {
      // The underlying GCS API does return objectName when it equals the prefix, but our
      // GoogleCloudStorage wrapper filters this case if the objectName also ends with the
      // delimiter.
      if (!objectName.startsWith(objectNamePrefix) ||
          (objectName.equals(objectNamePrefix) &&
              ((delimiter == null) || objectName.endsWith(delimiter)))) {
        return null;
      } else {
        suffixIndex = objectNamePrefix.length();
        suffix = objectName.substring(suffixIndex);
      }
    }
    if ((delimiter != null) && (suffix.indexOf(delimiter) >= 0)) {
      // Return the full prefix and suffix up through first occurrence of delimiter after
      // the prefix, inclusive of the delimiter.
      objectName = objectName.substring(
          0, objectName.indexOf(delimiter, suffixIndex) + delimiter.length());
    }
    return objectName;
  }
}