|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.jersey.oauth.signature.OAuthSignature
public class OAuthSignature
Class used for processing an OAuth signature (signing or verifying).
Example of usage:
// wrap an existing request with some concrete implementation OAuthRequest request = new ConcreteOAuthRequestImplementation(); // establish the parameters that will be used to sign the request OAuthParameters params = new OAuthParameters().consumerKey("dpf43f3p2l4k3l03"). token("nnch734d00sl2jdk").signatureMethod(HMAC_SHA1.NAME). timestamp().nonce().version(); // establish the secrets that will be used to sign the request OAuthSecrets secrets = new OAuthSecrets().consumerSecret("kd94hf93k423kf44"). tokenSecret("pfkkdhi9sl3r4s00"); // generate the digital signature and set in the request OAuthSignature.sign(request, params, secrets);
Constructor Summary | |
---|---|
OAuthSignature()
|
Method Summary | |
---|---|
static String |
generate(OAuthRequest request,
OAuthParameters params,
OAuthSecrets secrets)
Generates and returns an OAuth signature for the given request, parameters and secrets. |
static void |
sign(OAuthRequest request,
OAuthParameters params,
OAuthSecrets secrets)
Generates an OAuth signature for the given request, parameters and secrets, and stores it as a signature parameter, and writes the OAuth parameters to the request as an Authorization header. |
static boolean |
verify(OAuthRequest request,
OAuthParameters params,
OAuthSecrets secrets)
Verifies the OAuth signature for a given request, parameters and secrets. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OAuthSignature()
Method Detail |
---|
public static String generate(OAuthRequest request, OAuthParameters params, OAuthSecrets secrets) throws OAuthSignatureException
request
- the request to generate signature for.params
- the OAuth authorization parameters.secrets
- the secrets used to generate the OAuth signature.
OAuthSignatureException
- if an error occurred generating the signature.public static void sign(OAuthRequest request, OAuthParameters params, OAuthSecrets secrets) throws OAuthSignatureException
request
- the request to generate signature for and write header to.params
- the OAuth authorization parameters.secrets
- the secrets used to generate the OAuth signature.
OAuthSignatureException
- if an error occurred generating the signature.public static boolean verify(OAuthRequest request, OAuthParameters params, OAuthSecrets secrets) throws OAuthSignatureException
request
- the request to verify the signature from.params
- the OAuth authorization parameterssecrets
- the secrets used to verify the OAuth signature.
OAuthSignatureException
- if an error occurred generating the signature.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |