net.oauth
Class OAuth

java.lang.Object
  net.oauth.OAuth

public class OAuth
extends java.lang.Object

Miscellaneous constants, methods and types.

Author:

John Kristian

Nested Class Summary

static class	OAuth.Parameter A name/value pair.
static class	OAuth.Problems Strings used for problem reporting.

Field Summary

static java.lang.String	ENCODING The encoding used to represent characters as bytes.
static java.lang.String	FORM_ENCODED The MIME type for a sequence of OAuth parameters.
static java.lang.String	HMAC_SHA1
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	RSA_SHA1
static java.lang.String	VERSION_1_0

Constructor Summary

OAuth()

Method Summary

static java.lang.String	addParameters(java.lang.String url, java.lang.Iterable<? extends java.util.Map.Entry<java.lang.String,java.lang.String>> parameters)
static java.lang.String	addParameters(java.lang.String url, java.lang.String... parameters) Construct a URL like the given one, but with the given parameters added to its query string.
static java.util.List<OAuth.Parameter>	decodeForm(java.lang.String form) Parse a form-urlencoded document.
static java.lang.String	decodePercent(java.lang.String s)
static java.lang.String	formEncode(java.lang.Iterable<? extends java.util.Map.Entry> parameters) Construct a form-urlencoded document containing the given sequence of name/value pairs.
static void	formEncode(java.lang.Iterable<? extends java.util.Map.Entry> parameters, java.io.OutputStream into) Write a form-urlencoded document into the given stream, containing the given sequence of name/value pairs.
static boolean	isEmpty(java.lang.String str)
static boolean	isFormEncoded(java.lang.String contentType) Return true if the given Content-Type header means FORM_ENCODED.
static java.util.List<OAuth.Parameter>	newList(java.lang.String... parameters) Construct a list of Parameters from name, value, name, value...
static java.util.Map<java.lang.String,java.lang.String>	newMap(java.lang.Iterable<? extends java.util.Map.Entry> from) Construct a Map containing a copy of the given parameters.
static java.lang.String	percentEncode(java.lang.Iterable values) Construct a &-separated list of the given values, percentEncoded.
static java.lang.String	percentEncode(java.lang.String s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION_1_0

public static final java.lang.String VERSION_1_0

See Also:

Constant Field Values

ENCODING

public static final java.lang.String ENCODING

The encoding used to represent characters as bytes.

See Also:

Constant Field Values

FORM_ENCODED

public static final java.lang.String FORM_ENCODED

The MIME type for a sequence of OAuth parameters.

See Also:

Constant Field Values

OAUTH_CONSUMER_KEY

public static final java.lang.String OAUTH_CONSUMER_KEY

See Also:

Constant Field Values

OAUTH_TOKEN

public static final java.lang.String OAUTH_TOKEN

See Also:

Constant Field Values

OAUTH_TOKEN_SECRET

public static final java.lang.String OAUTH_TOKEN_SECRET

See Also:

Constant Field Values

OAUTH_SIGNATURE_METHOD

public static final java.lang.String OAUTH_SIGNATURE_METHOD

See Also:

Constant Field Values

OAUTH_SIGNATURE

public static final java.lang.String OAUTH_SIGNATURE

See Also:

Constant Field Values

OAUTH_TIMESTAMP

public static final java.lang.String OAUTH_TIMESTAMP

See Also:

Constant Field Values

OAUTH_NONCE

public static final java.lang.String OAUTH_NONCE

See Also:

Constant Field Values

OAUTH_VERSION

public static final java.lang.String OAUTH_VERSION

See Also:

Constant Field Values

OAUTH_CALLBACK

public static final java.lang.String OAUTH_CALLBACK

See Also:

Constant Field Values

OAUTH_CALLBACK_CONFIRMED

public static final java.lang.String OAUTH_CALLBACK_CONFIRMED

See Also:

Constant Field Values

OAUTH_VERIFIER

public static final java.lang.String OAUTH_VERIFIER

See Also:

Constant Field Values

HMAC_SHA1

public static final java.lang.String HMAC_SHA1

See Also:

Constant Field Values

RSA_SHA1

public static final java.lang.String RSA_SHA1

See Also:

Constant Field Values

Constructor Detail

OAuth

public OAuth()

Method Detail

isFormEncoded

public static boolean isFormEncoded(java.lang.String contentType)

Return true if the given Content-Type header means FORM_ENCODED.

formEncode

public static java.lang.String formEncode(java.lang.Iterable<? extends java.util.Map.Entry> parameters)
                                   throws java.io.IOException

Construct a form-urlencoded document containing the given sequence of name/value pairs. Use OAuth percent encoding (not exactly the encoding mandated by HTTP).

Throws:

java.io.IOException

formEncode

public static void formEncode(java.lang.Iterable<? extends java.util.Map.Entry> parameters,
                              java.io.OutputStream into)
                       throws java.io.IOException

Write a form-urlencoded document into the given stream, containing the given sequence of name/value pairs.

Throws:

java.io.IOException

decodeForm

public static java.util.List<OAuth.Parameter> decodeForm(java.lang.String form)

Parse a form-urlencoded document.

percentEncode

public static java.lang.String percentEncode(java.lang.Iterable values)

Construct a &-separated list of the given values, percentEncoded.

percentEncode

public static java.lang.String percentEncode(java.lang.String s)

decodePercent

public static java.lang.String decodePercent(java.lang.String s)

newMap

public static java.util.Map<java.lang.String,java.lang.String> newMap(java.lang.Iterable<? extends java.util.Map.Entry> from)

Construct a Map containing a copy of the given parameters. If several parameters have the same name, the Map will contain the first value, only.

newList

public static java.util.List<OAuth.Parameter> newList(java.lang.String... parameters)

Construct a list of Parameters from name, value, name, value...

addParameters

public static java.lang.String addParameters(java.lang.String url,
                                             java.lang.String... parameters)
                                      throws java.io.IOException

Construct a URL like the given one, but with the given parameters added to its query string.

Throws:

java.io.IOException

addParameters

public static java.lang.String addParameters(java.lang.String url,
                                             java.lang.Iterable<? extends java.util.Map.Entry<java.lang.String,java.lang.String>> parameters)
                                      throws java.io.IOException

Throws:

java.io.IOException

isEmpty

public static boolean isEmpty(java.lang.String str)