Index: trunk/src/oauth/signpost/http/HttpParameters.java =================================================================== --- trunk/src/oauth/signpost/http/HttpParameters.java (revision 10831) +++ (revision ) @@ -1,316 +1,0 @@ -/* Copyright (c) 2008, 2009 Netflix, Matthias Kaeppler - * - * 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 oauth.signpost.http; - -import java.io.Serializable; -import java.util.Collection; -import java.util.Iterator; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.SortedSet; -import java.util.TreeMap; -import java.util.TreeSet; - -import oauth.signpost.OAuth; - -/** - * A multi-map of HTTP request parameters. Each key references a - * {@link SortedSet} of parameters collected from the request during message - * signing. Parameter values are sorted as per {@linkplain http://oauth.net/core/1.0a/#anchor13}. - * Every key/value pair will be percent-encoded upon insertion. - * This class has special semantics tailored to being useful for message signing; - * it's not a general purpose collection class to handle request parameters. - * - * @author Matthias Kaeppler - */ -@SuppressWarnings("serial") -public class HttpParameters implements Map>, Serializable { - - private TreeMap> wrappedMap = new TreeMap<>(); - - @Override - public SortedSet put(String key, SortedSet value) { - return wrappedMap.put(key, value); - } - - public SortedSet put(String key, SortedSet values, boolean percentEncode) { - if (percentEncode) { - remove(key); - for (String v : values) { - put(key, v, true); - } - return get(key); - } else { - return wrappedMap.put(key, values); - } - } - - /** - * Convenience method to add a single value for the parameter specified by - * 'key'. - * - * @param key - * the parameter name - * @param value - * the parameter value - * @return the value - */ - public String put(String key, String value) { - return put(key, value, false); - } - - /** - * Convenience method to add a single value for the parameter specified by - * 'key'. - * - * @param key - * the parameter name - * @param value - * the parameter value - * @param percentEncode - * whether key and value should be percent encoded before being - * inserted into the map - * @return the value - */ - public String put(String key, String value, boolean percentEncode) { - // fix contributed by Bjorn Roche - key should be encoded before wrappedMap.get - key = percentEncode ? OAuth.percentEncode(key) : key; - SortedSet values = wrappedMap.get(key); - if (values == null) { - values = new TreeSet<>(); - wrappedMap.put( key, values); - } - if (value != null) { - value = percentEncode ? OAuth.percentEncode(value) : value; - values.add(value); - } - - return value; - } - - /** - * Convenience method to allow for storing null values. {@link #put} doesn't - * allow null values, because that would be ambiguous. - * - * @param key - * the parameter name - * @param nullString - * can be anything, but probably... null? - * @return null - */ - public String putNull(String key, String nullString) { - return put(key, nullString); - } - - @Override - public void putAll(Map> m) { - wrappedMap.putAll(m); - } - - public void putAll(Map> m, boolean percentEncode) { - if (percentEncode) { - for (String key : m.keySet()) { - put(key, m.get(key), true); - } - } else { - wrappedMap.putAll(m); - } - } - - public void putAll(String[] keyValuePairs, boolean percentEncode) { - for (int i = 0; i < keyValuePairs.length - 1; i += 2) { - this.put(keyValuePairs[i], keyValuePairs[i + 1], percentEncode); - } - } - - /** - * Convenience method to merge a Map>. - * - * @param m - * the map - */ - public void putMap(Map> m) { - for (String key : m.keySet()) { - SortedSet vals = get(key); - if (vals == null) { - vals = new TreeSet<>(); - put(key, vals); - } - vals.addAll(m.get(key)); - } - } - - @Override - public SortedSet get(Object key) { - return wrappedMap.get(key); - } - - /** - * Convenience method for {@link #getFirst(key, false)}. - * - * @param key - * the parameter name (must be percent encoded if it contains unsafe - * characters!) - * @return the first value found for this parameter - */ - public String getFirst(Object key) { - return getFirst(key, false); - } - - /** - * Returns the first value from the set of all values for the given - * parameter name. If the key passed to this method contains special - * characters, you MUST first percent encode it using - * {@link OAuth#percentEncode(String)}, otherwise the lookup will fail - * (that's because upon storing values in this map, keys get - * percent-encoded). - * - * @param key - * the parameter name (must be percent encoded if it contains unsafe - * characters!) - * @param percentDecode - * whether the value being retrieved should be percent decoded - * @return the first value found for this parameter - */ - public String getFirst(Object key, boolean percentDecode) { - SortedSet values = wrappedMap.get(key); - if (values == null || values.isEmpty()) { - return null; - } - String value = values.first(); - return percentDecode ? OAuth.percentDecode(value) : value; - } - - /** - * Concatenates all values for the given key to a list of key/value pairs - * suitable for use in a URL query string. - * - * @param key - * the parameter name - * @return the query string - */ - public String getAsQueryString(Object key) { - return getAsQueryString(key, true); - } - - /** - * Concatenates all values for the given key to a list of key/value pairs - * suitable for use in a URL query string. - * - * @param key - * the parameter name - * @param percentEncode - * whether key should be percent encoded before being - * used with the map - * @return the query string - */ - public String getAsQueryString(Object key, boolean percentEncode) { - // fix contributed by Stjepan Rajko - we need the percentEncode parameter - // because some places (like SignatureBaseString.normalizeRequestParameters) - // need to supply the parameter percent encoded - - StringBuilder sb = new StringBuilder(); - if(percentEncode) - key = OAuth.percentEncode((String) key); - Set values = wrappedMap.get(key); - if (values == null) { - return key + "="; - } - Iterator iter = values.iterator(); - while (iter.hasNext()) { - sb.append(key + "=" + iter.next()); - if (iter.hasNext()) { - sb.append("&"); - } - } - return sb.toString(); - } - - public String getAsHeaderElement(String key) { - String value = getFirst(key); - if (value == null) { - return null; - } - return key + "=\"" + value + "\""; - } - - @Override - public boolean containsKey(Object key) { - return wrappedMap.containsKey(key); - } - - @Override - public boolean containsValue(Object value) { - for (Set values : wrappedMap.values()) { - if (values.contains(value)) { - return true; - } - } - return false; - } - - @Override - public int size() { - int count = 0; - for (String key : wrappedMap.keySet()) { - count += wrappedMap.get(key).size(); - } - return count; - } - - @Override - public boolean isEmpty() { - return wrappedMap.isEmpty(); - } - - @Override - public void clear() { - wrappedMap.clear(); - } - - @Override - public SortedSet remove(Object key) { - return wrappedMap.remove(key); - } - - @Override - public Set keySet() { - return wrappedMap.keySet(); - } - - @Override - public Collection> values() { - return wrappedMap.values(); - } - - @Override - public Set>> entrySet() { - return wrappedMap.entrySet(); - } - - public HttpParameters getOAuthParameters() { - HttpParameters oauthParams = new HttpParameters(); - - for (Entry> param : this.entrySet()) { - String key = param.getKey(); - if (key.startsWith("oauth_") || key.startsWith("x_oauth_")) { - oauthParams.put(key, param.getValue()); - } - } - - return oauthParams; - } -} Index: trunk/src/oauth/signpost/http/HttpRequest.java =================================================================== --- trunk/src/oauth/signpost/http/HttpRequest.java (revision 10831) +++ (revision ) @@ -1,42 +1,0 @@ -package oauth.signpost.http; - -import java.io.IOException; -import java.io.InputStream; -import java.util.Map; - -import oauth.signpost.OAuthConsumer; - -/** - * A concise description of an HTTP request. Contains methods to access all - * those parts of an HTTP request which Signpost needs to sign a message. If you - * want to extend Signpost to sign a different kind of HTTP request than those - * currently supported, you'll have to write an adapter which implements this - * interface and a custom {@link OAuthConsumer} which performs the wrapping. - * - * @author Matthias Kaeppler - */ -public interface HttpRequest { - - String getMethod(); - - String getRequestUrl(); - - void setRequestUrl(String url); - - void setHeader(String name, String value); - - String getHeader(String name); - - Map getAllHeaders(); - - InputStream getMessagePayload() throws IOException; - - String getContentType(); - - /** - * Returns the wrapped request object, in case you must work directly on it. - * - * @return the wrapped request object - */ - Object unwrap(); -} Index: trunk/src/oauth/signpost/http/HttpResponse.java =================================================================== --- trunk/src/oauth/signpost/http/HttpResponse.java (revision 10831) +++ (revision ) @@ -1,21 +1,0 @@ -package oauth.signpost.http; - -import java.io.IOException; -import java.io.InputStream; - -public interface HttpResponse { - - int getStatusCode() throws IOException; - - String getReasonPhrase() throws Exception; - - InputStream getContent() throws IOException; - - /** - * Returns the underlying response object, in case you need to work on it - * directly. - * - * @return the wrapped response object - */ - Object unwrap(); -}