org.glassfish.jersey.oauth1.signature

Interface OAuth1SignatureMethod

All Known Implementing Classes:

HmaSha1Method, PlaintextMethod, RsaSha1Method

@Contract
public interface OAuth1SignatureMethod

An interface representing the OAuth signature method.

Author:

Hubert A. Le Van Gong , Paul C. Bryan

Method Summary

Methods

Modifier and Type	Method and Description
String	name() Returns the name of this signature method, as negotiated through the OAuth protocol.
String	sign(String baseString, OAuth1Secrets secrets) Signs the data using the supplied secret(s).
boolean	verify(String elements, OAuth1Secrets 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.

Returns:

Signature method name.

sign

String sign(String baseString,
          OAuth1Secrets secrets)
            throws InvalidSecretException

Signs the data using the supplied secret(s).

Parameters:

baseString - a String that contains the request baseString 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,
             OAuth1Secrets 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.