com.amazonaws.util.SdkHttpUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-core Show documentation
Show all versions of aws-java-sdk-core Show documentation
The AWS SDK for Java - Core module holds the classes that are used by the individual service clients to interact with Amazon Web Services. Users need to depend on aws-java-sdk artifact for accessing individual client classes.
/*
* Copyright 2015-2024 Amazon.com, Inc. or its affiliates. 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.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file 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.amazonaws.util;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.amazonaws.SignableRequest;
import com.amazonaws.http.HttpMethodName;
public class SdkHttpUtils {
private static final String DEFAULT_ENCODING = "UTF-8";
/**
* Regex which matches any of the sequences that we need to fix up after
* URLEncoder.encode().
*/
private static final Pattern ENCODED_CHARACTERS_PATTERN;
static {
StringBuilder pattern = new StringBuilder();
pattern
.append(Pattern.quote("+"))
.append("|")
.append(Pattern.quote("*"))
.append("|")
.append(Pattern.quote("%7E"))
.append("|")
.append(Pattern.quote("%2F"));
ENCODED_CHARACTERS_PATTERN = Pattern.compile(pattern.toString());
}
/**
* Encode a string for use in the path of a URL; uses URLEncoder.encode,
* (which encodes a string for use in the query portion of a URL), then
* applies some postfilters to fix things up per the RFC. Can optionally
* handle strings which are meant to encode a path (ie include '/'es
* which should NOT be escaped).
*
* @param value the value to encode
* @param path true if the value is intended to represent a path
* @return the encoded value
*/
public static String urlEncode(final String value, final boolean path) {
if (value == null) {
return "";
}
try {
String encoded = URLEncoder.encode(value, DEFAULT_ENCODING);
Matcher matcher = ENCODED_CHARACTERS_PATTERN.matcher(encoded);
StringBuffer buffer = new StringBuffer(encoded.length());
while (matcher.find()) {
String replacement = matcher.group(0);
if ("+".equals(replacement)) {
replacement = "%20";
} else if ("*".equals(replacement)) {
replacement = "%2A";
} else if ("%7E".equals(replacement)) {
replacement = "~";
} else if (path && "%2F".equals(replacement)) {
replacement = "/";
}
matcher.appendReplacement(buffer, replacement);
}
matcher.appendTail(buffer);
return buffer.toString();
} catch (UnsupportedEncodingException ex) {
throw new RuntimeException(ex);
}
}
/**
* Decode a string for use in the path of a URL; uses URLDecoder.decode,
* which decodes a string for use in the query portion of a URL.
*
* @param value The value to decode
* @return The decoded value if parameter is not null, otherwise, null is returned.
*/
public static String urlDecode(final String value) {
if (value == null) {
return null;
}
try {
return URLDecoder.decode(value, DEFAULT_ENCODING);
} catch (UnsupportedEncodingException ex) {
throw new RuntimeException(ex);
}
}
/**
* Returns true if the specified URI is using a non-standard port (i.e. any
* port other than 80 for HTTP URIs or any port other than 443 for HTTPS
* URIs).
*
* @param uri
*
* @return True if the specified URI is using a non-standard port, otherwise
* false.
*/
public static boolean isUsingNonDefaultPort(URI uri) {
String scheme = StringUtils.lowerCase(uri.getScheme());
int port = uri.getPort();
if (port <= 0) return false;
if (scheme.equals("http") && port == 80) return false;
if (scheme.equals("https") && port == 443) return false;
return true;
}
public static boolean usePayloadForQueryParameters(SignableRequest request) {
boolean requestIsPOST = HttpMethodName.POST.equals(request.getHttpMethod());
boolean requestHasNoPayload = (request.getContent() == null);
return requestIsPOST && requestHasNoPayload;
}
/**
* Creates an encoded query string from all the parameters in the specified
* request.
*
* @param request
* The request containing the parameters to encode.
*
* @return Null if no parameters were present, otherwise the encoded query
* string for the parameters present in the specified request.
*/
public static String encodeParameters(SignableRequest request) {
final Map> requestParams = request.getParameters();
if (requestParams.isEmpty()) return null;
final List nameValuePairs = new ArrayList();
for (Entry> entry : requestParams.entrySet()) {
String parameterName = entry.getKey();
for (String value : entry.getValue()) {
nameValuePairs
.add(new BasicNameValuePair(parameterName, value));
}
}
return URLEncodedUtils.format(nameValuePairs, DEFAULT_ENCODING);
}
/**
* Append the given path to the given baseUri.
* By default, all slash characters in path will not be url-encoded.
*/
public static String appendUri(String baseUri, String path) {
return appendUri(baseUri, path, false);
}
/**
* Append the given path to the given baseUri.
*
* @param baseUri The URI to append to (required, may be relative)
* @param path The path to append (may be null or empty). Path should be pre-encoded.
* @param escapeDoubleSlash Whether double-slash in the path should be escaped to "/%2F"
* @return The baseUri with the path appended
*/
public static String appendUri(final String baseUri, String path, final boolean escapeDoubleSlash) {
String resultUri = baseUri;
if (path != null && path.length() > 0) {
if (path.startsWith("/")) {
// trim the trailing slash in baseUri, since the path already starts with a slash
if (resultUri.endsWith("/")) {
resultUri = resultUri.substring(0, resultUri.length() - 1);
}
} else if (!resultUri.endsWith("/")) {
resultUri += "/";
}
if (escapeDoubleSlash) {
resultUri += path.replace("//", "/%2F");
} else {
resultUri += path;
}
} else if (!resultUri.endsWith("/")) {
resultUri += "/";
}
return resultUri;
}
}