Serializable
, Map<String,SortedSet<String>>
public class HttpParameters extends Object implements Map<String,SortedSet<String>>, Serializable
SortedSet
of parameters collected from the request during message
signing. Parameter values are sorted as per ://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.Constructor | Description |
---|---|
HttpParameters() |
Modifier and Type | Method | Description |
---|---|---|
void |
clear() |
|
boolean |
containsKey(Object key) |
|
boolean |
containsValue(Object value) |
|
Set<Map.Entry<String,SortedSet<String>>> |
entrySet() |
|
SortedSet<String> |
get(Object key) |
|
String |
getAsHeaderElement(String key) |
|
String |
getAsQueryString(Object key) |
Concatenates all values for the given key to a list of key/value pairs
suitable for use in a URL query string.
|
String |
getAsQueryString(Object key,
boolean percentEncode) |
Concatenates all values for the given key to a list of key/value pairs
suitable for use in a URL query string.
|
String |
getFirst(Object key) |
Convenience method for {@link #getFirst(key, false)}.
|
String |
getFirst(Object key,
boolean percentDecode) |
Returns the first value from the set of all values for the given
parameter name.
|
HttpParameters |
getOAuthParameters() |
|
boolean |
isEmpty() |
|
Set<String> |
keySet() |
|
String |
put(String key,
String value) |
Convenience method to add a single value for the parameter specified by
'key'.
|
String |
put(String key,
String value,
boolean percentEncode) |
Convenience method to add a single value for the parameter specified by
'key'.
|
SortedSet<String> |
put(String key,
SortedSet<String> value) |
|
SortedSet<String> |
put(String key,
SortedSet<String> values,
boolean percentEncode) |
|
void |
putAll(String[] keyValuePairs,
boolean percentEncode) |
|
void |
putAll(Map<? extends String,? extends SortedSet<String>> m) |
|
void |
putAll(Map<? extends String,? extends SortedSet<String>> m,
boolean percentEncode) |
|
void |
putMap(Map<String,List<String>> m) |
Convenience method to merge a Map
|
String |
putNull(String key,
String nullString) |
Convenience method to allow for storing null values.
|
SortedSet<String> |
remove(Object key) |
|
int |
size() |
|
Collection<SortedSet<String>> |
values() |
public String put(String key, String value)
key
- the parameter namevalue
- the parameter valuepublic String put(String key, String value, boolean percentEncode)
key
- the parameter namevalue
- the parameter valuepercentEncode
- whether key and value should be percent encoded before being
inserted into the mappublic String putNull(String key, String nullString)
put(java.lang.String, java.util.SortedSet<java.lang.String>)
doesn't
allow null values, because that would be ambiguous.key
- the parameter namenullString
- can be anything, but probably... null?public void putAll(Map<? extends String,? extends SortedSet<String>> m, boolean percentEncode)
public void putAll(String[] keyValuePairs, boolean percentEncode)
public void putMap(Map<String,List<String>> m)
m
- the mappublic String getFirst(Object key)
key
- the parameter name (must be percent encoded if it contains unsafe
characters!)public String getFirst(Object key, boolean percentDecode)
OAuth.percentEncode(String)
, otherwise the lookup will fail
(that's because upon storing values in this map, keys get
percent-encoded).key
- the parameter name (must be percent encoded if it contains unsafe
characters!)percentDecode
- whether the value being retrieved should be percent decodedpublic String getAsQueryString(Object key)
key
- the parameter namepublic String getAsQueryString(Object key, boolean percentEncode)
key
- the parameter namepercentEncode
- whether key should be percent encoded before being
used with the mappublic boolean containsKey(Object key)
containsKey
in interface Map<String,SortedSet<String>>
public boolean containsValue(Object value)
containsValue
in interface Map<String,SortedSet<String>>
public Collection<SortedSet<String>> values()
public HttpParameters getOAuthParameters()
Copyright © 2019. All rights reserved.