src.org.jets3t.service.utils.RestUtils Maven / Gradle / Ivy
/*
* jets3t : Java Extra-Tasty S3 Toolkit (for Amazon S3 online storage service)
* This is a java.net project, see https://jets3t.dev.java.net/
*
* Copyright 2006 James Murty
*
* 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 org.jets3t.service.utils;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.SortedMap;
import java.util.TreeMap;
import org.jets3t.service.Constants;
import org.jets3t.service.S3ServiceException;
/**
* Utilities useful for REST/HTTP S3Service implementations.
*
* @author James Murty
*/
public class RestUtils {
/**
* A list of HTTP-specific header names, that may be present in S3Objects as metadata but
* which should be treated as plain HTTP headers during transmission (ie not converted into
* S3 Object metadata items). All items in this list are in lower case.
*
* This list includes the items:
*
* Unchanged metadata names content-type content-md5 content-length content-language expires cache-control content-disposition content-encoding
*/
public static final List HTTP_HEADER_METADATA_NAMES = Arrays.asList(new String[] {
"content-type",
"content-md5",
"content-length",
"content-language",
"expires",
"cache-control",
"content-disposition",
"content-encoding"
});
/**
* Encodes a URL string, and ensures that spaces are encoded as "%20" instead of "+" to keep
* fussy web browsers happier.
*
* @param path
* @return
* encoded URL.
* @throws S3ServiceException
*/
public static String encodeUrlString(String path) throws S3ServiceException {
try {
String encodedPath = URLEncoder.encode(path, Constants.DEFAULT_ENCODING);
// Web browsers do not always handle '+' characters well, use the well-supported '%20' instead.
encodedPath = encodedPath.replaceAll("\\+", "%20");
return encodedPath;
} catch (UnsupportedEncodingException uee) {
throw new S3ServiceException("Unable to encode path: " + path, uee);
}
}
/**
* Encodes a URL string but leaves a delimiter string unencoded.
* Spaces are encoded as "%20" instead of "+".
*
* @param path
* @param delimiter
* @return
* encoded URL string.
* @throws S3ServiceException
*/
public static String encodeUrlPath(String path, String delimiter) throws S3ServiceException {
StringBuffer result = new StringBuffer();
String tokens[] = path.split(delimiter);
for (int i = 0; i < tokens.length; i++) {
result.append(encodeUrlString(tokens[i]));
if (i < tokens.length - 1) {
result.append(delimiter);
}
}
return result.toString();
}
/**
* Calculate the canonical string for a REST/HTTP request to S3.
*
* When expires is non-null, it will be used instead of the Date header.
*/
public static String makeCanonicalString(String method, String resource, Map headersMap, String expires)
{
StringBuffer buf = new StringBuffer();
buf.append(method + "\n");
// Add all interesting headers to a list, then sort them. "Interesting"
// is defined as Content-MD5, Content-Type, Date, and x-amz-
SortedMap interestingHeaders = new TreeMap();
if (headersMap != null && headersMap.size() > 0) {
Iterator headerIter = headersMap.entrySet().iterator();
while (headerIter.hasNext()) {
Map.Entry entry = (Map.Entry) headerIter.next();
Object key = entry.getKey();
Object value = entry.getValue();
if (key == null) continue;
String lk = key.toString().toLowerCase(Locale.getDefault());
// Ignore any headers that are not particularly interesting.
if (lk.equals("content-type") || lk.equals("content-md5") || lk.equals("date") ||
lk.startsWith(Constants.REST_HEADER_PREFIX))
{
interestingHeaders.put(lk, value);
}
}
}
// Remove default date timestamp if "x-amz-date" is set.
if (interestingHeaders.containsKey(Constants.REST_METADATA_ALTERNATE_DATE)) {
interestingHeaders.put("date", "");
}
// Use the expires value as the timestamp if it is available. This trumps both the default
// "date" timestamp, and the "x-amz-date" header.
if (expires != null) {
interestingHeaders.put("date", expires);
}
// these headers require that we still put a new line in after them,
// even if they don't exist.
if (! interestingHeaders.containsKey("content-type")) {
interestingHeaders.put("content-type", "");
}
if (! interestingHeaders.containsKey("content-md5")) {
interestingHeaders.put("content-md5", "");
}
// Finally, add all the interesting headers (i.e.: all that startwith x-amz- ;-))
for (Iterator i = interestingHeaders.entrySet().iterator(); i.hasNext(); ) {
Map.Entry entry = (Map.Entry) i.next();
String key = (String) entry.getKey();
Object value = entry.getValue();
if (key.startsWith(Constants.REST_HEADER_PREFIX)) {
buf.append(key).append(':').append(value);
} else {
buf.append(value);
}
buf.append("\n");
}
// don't include the query parameters...
int queryIndex = resource.indexOf('?');
if (queryIndex == -1) {
buf.append(resource);
} else {
buf.append(resource.substring(0, queryIndex));
}
// ...unless there is an acl, torrent or logging parameter
if (resource.matches(".*[&?]acl($|=|&).*")) {
buf.append("?acl");
} else if (resource.matches(".*[&?]torrent($|=|&).*")) {
buf.append("?torrent");
} else if (resource.matches(".*[&?]logging($|=|&).*")) {
buf.append("?logging");
} else if (resource.matches(".*[&?]location($|=|&).*")) {
buf.append("?location");
}
return buf.toString();
}
/**
* Renames metadata property names to be suitable for use as HTTP Headers. This is done
* by renaming any non-HTTP headers to have the prefix x-amz-meta- and leaving the
* HTTP header names unchanged. The HTTP header names left unchanged are those found in
* {@link #HTTP_HEADER_METADATA_NAMES}
*
* @param metadata
* @return
* a map of metadata property name/value pairs renamed to be suitable for use as HTTP headers.
*/
public static Map renameMetadataKeys(Map metadata) {
Map convertedMetadata = new HashMap();
// Add all meta-data headers.
if (metadata != null) {
Iterator metaDataIter = metadata.entrySet().iterator();
while (metaDataIter.hasNext()) {
Map.Entry entry = (Map.Entry) metaDataIter.next();
String key = (String) entry.getKey();
Object value = entry.getValue();
if (!HTTP_HEADER_METADATA_NAMES.contains(key.toLowerCase(Locale.getDefault()))
&& !key.startsWith(Constants.REST_HEADER_PREFIX))
{
key = Constants.REST_METADATA_PREFIX + key;
}
convertedMetadata.put(key, value);
}
}
return convertedMetadata;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy