com.google.cloud.storage.SignedUrlEncodingHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-cloud-storage Show documentation

Java idiomatic client for Google Cloud Storage.

There is a newer version: 2.45.0

/*
 * Copyright 2019 Google LLC
 *
 * 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.storage;

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;

/** Helper for encoding URI segments appropriately when creating a Signed URL. */
class SignedUrlEncodingHelper {

  static String Rfc3986UriEncode(final String segment, final boolean encodeForwardSlash) {
    String encodedSegment;
    try {
      encodedSegment = URLEncoder.encode(segment, "UTF-8");
    } catch (UnsupportedEncodingException exception) {
      throw new RuntimeException(exception);
    }
    // URLEncoder.encode() does mostly what we want, with the exception of a few characters that
    // we fix in a second phase:
    encodedSegment =
        encodedSegment
            .replace("*", "%2A") // Asterisks should be encoded.
            .replace("+", "%20") // Spaces should be encoded as %20 instead of a plus sign.
            .replace("%7E", "~"); // Tildes should not be encoded.
    // Forward slashes should NOT be encoded in the segment of the URI that represents the
    // object's name, but should be encoded for all other segments.
    if (!encodeForwardSlash) {
      encodedSegment = encodedSegment.replace("%2F", "/");
    }
    return encodedSegment;
  }
}