com.google.gdata.client.authn.oauth

Class OAuthRsaSha1Signer

java.lang.Object

com.google.gdata.client.authn.oauth.OAuthRsaSha1Signer

All Implemented Interfaces:

OAuthSigner

public class OAuthRsaSha1Signer
extends Object
implements OAuthSigner

Signs strings using RSA-SHA1.

Constructor Summary

Constructors

Constructor and Description
OAuthRsaSha1Signer() Constructor for OAuthRsaSha1Signer.
OAuthRsaSha1Signer(byte[] privateKeyBytes) Sets the RSA-SHA1 private key object used to sign this request.
OAuthRsaSha1Signer(PrivateKey privateKey) Sets the RSA-SHA1 private key object used to sign this request.
OAuthRsaSha1Signer(String privateKeyString) Sets the RSA-SHA1 private key object used to sign this request.

Method Summary

Methods

Modifier and Type	Method and Description
String	getSignature(String baseString, OAuthParameters oauthParameters) Signs the input string using the appropriate signature method.
String	getSignatureMethod() Gets the signature method for this specific implementation.
void	setPrivateKey(PrivateKey privateKey) Sets the PrivateKey used to sign requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthRsaSha1Signer

public OAuthRsaSha1Signer()

Constructor for OAuthRsaSha1Signer. This form of the constructor does not set the private key, so be sure to call setPrivateKey(PrivateKey) before signing requests.

OAuthRsaSha1Signer

public OAuthRsaSha1Signer(PrivateKey privateKey)
                   throws OAuthException

Sets the RSA-SHA1 private key object used to sign this request.

Parameters:

privateKey - the PrivateKey to use to initialize the signer.

Throws:

OAuthException - if setting the private key fails

OAuthRsaSha1Signer

public OAuthRsaSha1Signer(String privateKeyString)
                   throws OAuthException

Sets the RSA-SHA1 private key object used to sign this request.

Parameters:

privateKeyString - the Base-64 encoded private key string conforming to the PKCS #8 standard.

Throws:

OAuthException - if setting the private key fails

OAuthRsaSha1Signer

public OAuthRsaSha1Signer(byte[] privateKeyBytes)
                   throws OAuthException

Sets the RSA-SHA1 private key object used to sign this request.

Parameters:

privateKeyBytes - the Base-64 encoded private key conforming to the PKCS #8 standard.

Throws:

OAuthException - if setting the private key fails

Method Detail

setPrivateKey

public void setPrivateKey(PrivateKey privateKey)
                   throws OAuthException

Sets the PrivateKey used to sign requests.

Parameters:

privateKey -

Throws:

OAuthException - if the private key is null.

getSignature

public String getSignature(String baseString,
                  OAuthParameters oauthParameters)
                    throws OAuthException

Description copied from interface: OAuthSigner

Signs the input string using the appropriate signature method.

Specified by:

getSignature in interface OAuthSigner

Parameters:

baseString - the string to sign

oauthParameters - the parameters related to the OAuth request or null

Returns:

the signed string

Throws:

OAuthException - if signing the request fails

getSignatureMethod

public String getSignatureMethod()

Description copied from interface: OAuthSigner

Gets the signature method for this specific implementation.

Specified by:

getSignatureMethod in interface OAuthSigner

Returns:

the signature method used to sign the base string