com.sun.jersey.oauth.signature

Interface OAuthSignatureMethod

All Known Implementing Classes:

HMAC_SHA1, PLAINTEXT, RSA_SHA1

public interface OAuthSignatureMethod

An interface representing the OAuth signature method. Concrete implementations are loaded through a service loader.

Author:

Hubert A. Le Van Gong , Paul C. Bryan

Method Summary

Modifier and Type	Method and Description
String	name() Returns the name of this signature method, as negotiated through the OAuth protocol.
String	sign(String elements, OAuthSecrets secrets) Signs the data using the supplied secret(s).
boolean	verify(String elements, OAuthSecrets secrets, String signature) Verifies the signature for the data using the supplied secret(s).

Method Detail

name

String name()

Returns the name of this signature method, as negotiated through the OAuth protocol.

sign

String sign(String elements,
            OAuthSecrets secrets)
     throws InvalidSecretException

Signs the data using the supplied secret(s).

Parameters:

elements - a String that contains the request elements to be signed.

secrets - the secret(s) to use to sign the data.

Returns:

a String that contains the signature.

Throws:

InvalidSecretException - if a supplied secret is not valid.

verify

boolean verify(String elements,
               OAuthSecrets secrets,
               String signature)
        throws InvalidSecretException

Verifies the signature for the data using the supplied secret(s).

Parameters:

elements - a String that contains the request elements to be verified.

secrets - the secret(s) to use to verify the signature.

signature - a String that contains the signature to be verified.

Returns:

true if the signature matches the secrets and data.

Throws:

InvalidSecretException - if a supplied secret is not valid.