Packagecom.yahoo.oauth
Classpublic class OAuthSignatureMethod
ImplementsIOAuthSignatureMethod
SubclassesOAuthSignatureMethod_HMAC_SHA1, OAuthSignatureMethod_PLAINTEXT

Base class for OAuth signature method implmentations. This class alone cannot not be used to sign a request. Instead, use OAuthSignatureMethod_HMAC_SHA1 or OAuthSignatureMethod_PLAINTEXT, or your own that overrides the methods of this class.


Public Properties
 PropertyDefined by
  name : String
[read-only] The name of the signature method.
OAuthSignatureMethod
Protected Properties
 PropertyDefined by
  $name : String
The name of the signature method.
OAuthSignatureMethod
Public Methods
 MethodDefined by
  
OAuthSignatureMethod()
Class constructor.
OAuthSignatureMethod
  
buildSignature(request:OAuthRequest):String
Signs the request.
OAuthSignatureMethod
  
checkSignature(signature:String, request:OAuthRequest):Boolean
Validates the given signature against a generated signature from the request.
OAuthSignatureMethod
Property detail
$nameproperty
protected var $name:String

The name of the signature method.

nameproperty 
name:String  [read-only]

The name of the signature method.

Implementation
    public function get name():String
Constructor detail
OAuthSignatureMethod()constructor
public function OAuthSignatureMethod()

Class constructor.

Creates a new OAuthSignaureMethod object.

Method detail
buildSignature()method
public function buildSignature(request:OAuthRequest):String

Signs the request.

Parameters
request:OAuthRequest

Returns
String
checkSignature()method 
public function checkSignature(signature:String, request:OAuthRequest):Boolean

Validates the given signature against a generated signature from the request.

Parameters
signature:String — The signature string to be verified.
 
request:OAuthRequest — The OAuthRequest to sign and compare against the provided signature.

Returns
Boolean — Returns true if the signature matches the signature built from the request.