public class OAuth
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ENCODING |
static java.lang.String |
FORM_ENCODED |
static java.lang.String |
HTTP_AUTHORIZATION_HEADER |
static java.lang.String |
OAUTH_CALLBACK |
static java.lang.String |
OAUTH_CALLBACK_CONFIRMED |
static java.lang.String |
OAUTH_CONSUMER_KEY |
static java.lang.String |
OAUTH_NONCE |
static java.lang.String |
OAUTH_SIGNATURE |
static java.lang.String |
OAUTH_SIGNATURE_METHOD |
static java.lang.String |
OAUTH_TIMESTAMP |
static java.lang.String |
OAUTH_TOKEN |
static java.lang.String |
OAUTH_TOKEN_SECRET |
static java.lang.String |
OAUTH_VERIFIER |
static java.lang.String |
OAUTH_VERSION |
static java.lang.String |
OUT_OF_BAND
Pass this value as the callback "url" upon retrieving a request token if
your application cannot receive callbacks (e.g.
|
static java.lang.String |
VERSION_1_0 |
Constructor and Description |
---|
OAuth() |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
addQueryParameters(java.lang.String url,
java.util.Map<java.lang.String,java.lang.String> params) |
static java.lang.String |
addQueryParameters(java.lang.String url,
java.lang.String... kvPairs)
Appends a list of key/value pairs to the given URL, e.g.:
|
static java.lang.String |
addQueryString(java.lang.String url,
java.lang.String queryString) |
static void |
debugOut(java.lang.String key,
java.lang.String value) |
static HttpParameters |
decodeForm(java.io.InputStream content) |
static HttpParameters |
decodeForm(java.lang.String form)
Parse a form-urlencoded document.
|
static <T extends java.util.Map.Entry<java.lang.String,java.lang.String>> |
formEncode(java.util.Collection<T> parameters)
Construct a x-www-form-urlencoded document containing the given sequence
of name/value pairs.
|
static <T extends java.util.Map.Entry<java.lang.String,java.lang.String>> |
formEncode(java.util.Collection<T> parameters,
java.io.OutputStream into)
Construct a x-www-form-urlencoded document containing the given sequence
of name/value pairs.
|
static boolean |
isEmpty(java.lang.String str) |
static HttpParameters |
oauthHeaderToParamsMap(java.lang.String oauthHeader) |
static java.lang.String |
percentDecode(java.lang.String s) |
static java.lang.String |
percentEncode(java.lang.String s) |
static java.lang.String |
prepareOAuthHeader(java.lang.String... kvPairs)
Builds an OAuth header from the given list of header fields.
|
static java.lang.String |
safeToString(java.lang.Object from) |
static java.lang.String |
toHeaderElement(java.lang.String name,
java.lang.String value)
Helper method to concatenate a parameter and its value to a pair that can
be used in an HTTP header.
|
static <T extends java.util.Map.Entry<java.lang.String,java.lang.String>> |
toMap(java.util.Collection<T> from)
Construct a Map containing a copy of the given parameters.
|
public static final java.lang.String VERSION_1_0
public static final java.lang.String ENCODING
public static final java.lang.String FORM_ENCODED
public static final java.lang.String HTTP_AUTHORIZATION_HEADER
public static final java.lang.String OAUTH_CONSUMER_KEY
public static final java.lang.String OAUTH_TOKEN
public static final java.lang.String OAUTH_TOKEN_SECRET
public static final java.lang.String OAUTH_SIGNATURE_METHOD
public static final java.lang.String OAUTH_SIGNATURE
public static final java.lang.String OAUTH_TIMESTAMP
public static final java.lang.String OAUTH_NONCE
public static final java.lang.String OAUTH_VERSION
public static final java.lang.String OAUTH_CALLBACK
public static final java.lang.String OAUTH_CALLBACK_CONFIRMED
public static final java.lang.String OAUTH_VERIFIER
public static final java.lang.String OUT_OF_BAND
OAuthProvider#retrieveAccessToken(OAuthConsumer, String)
in order
to complete the token handshake.public static java.lang.String percentEncode(java.lang.String s)
public static java.lang.String percentDecode(java.lang.String s)
public static <T extends java.util.Map.Entry<java.lang.String,java.lang.String>> void formEncode(java.util.Collection<T> parameters, java.io.OutputStream into) throws java.io.IOException
java.io.IOException
public static <T extends java.util.Map.Entry<java.lang.String,java.lang.String>> java.lang.String formEncode(java.util.Collection<T> parameters) throws java.io.IOException
java.io.IOException
public static HttpParameters decodeForm(java.lang.String form)
public static HttpParameters decodeForm(java.io.InputStream content) throws java.io.IOException
java.io.IOException
public static <T extends java.util.Map.Entry<java.lang.String,java.lang.String>> java.util.Map<java.lang.String,java.lang.String> toMap(java.util.Collection<T> from)
public static final java.lang.String safeToString(java.lang.Object from)
public static boolean isEmpty(java.lang.String str)
public static java.lang.String addQueryParameters(java.lang.String url, java.lang.String... kvPairs)
String url = OAuth.addQueryParameters("http://example.com?a=1", b, 2, c, 3);which yields:
http://example.com?a=1&b=2&c=3All parameters will be encoded according to OAuth's percent encoding rules.
url
- the URLkvPairs
- the list of key/value pairspublic static java.lang.String addQueryParameters(java.lang.String url, java.util.Map<java.lang.String,java.lang.String> params)
public static java.lang.String addQueryString(java.lang.String url, java.lang.String queryString)
public static java.lang.String prepareOAuthHeader(java.lang.String... kvPairs)
String authHeader = OAuth.prepareOAuthHeader("realm", "http://example.com", "oauth_token", "x%y");which yields:
OAuth realm="http://example.com", oauth_token="x%25y"
kvPairs
- the list of key/value pairspublic static HttpParameters oauthHeaderToParamsMap(java.lang.String oauthHeader)
public static java.lang.String toHeaderElement(java.lang.String name, java.lang.String value)
name
- the OAuth parameter name, e.g. oauth_tokenvalue
- the OAuth parameter value, e.g. 'hello oauth'public static void debugOut(java.lang.String key, java.lang.String value)