Class OAuthParameters

java.lang.Object
com.google.api.client.auth.oauth.OAuthParameters
All Implemented Interfaces:
com.google.api.client.http.HttpExecuteInterceptor, com.google.api.client.http.HttpRequestInitializer
@Beta public final class OAuthParameters extends Object implements com.google.api.client.http.HttpExecuteInterceptor, com.google.api.client.http.HttpRequestInitializer
Beta
OAuth 1.0a parameter manager.

The only required non-computed fields are signer and consumerKey. Use token to specify token or temporary credentials.

Sample usage, taking advantage that this class implements HttpRequestInitializer: 

 public static HttpRequestFactory createRequestFactory(HttpTransport transport) {
   OAuthParameters parameters = new OAuthParameters();
   // ...
   return transport.createRequestFactory(parameters);
 }

If you have a custom request initializer, take a look at the sample usage for HttpExecuteInterceptor, which this class also implements.

Since:
1.0

  • Field Details

    • RANDOM

      private static final SecureRandom RANDOM
      Secure random number generator to sign requests.

    • signer

      public OAuthSigner signer
      Required OAuth signature algorithm.

    • callback

      public String callback
      Absolute URI back to which the server will redirect the resource owner when the Resource Owner Authorization step is completed.

    • consumerKey

      public String consumerKey
      Required identifier portion of the client credentials (equivalent to a username).

    • nonce

      public String nonce
      Required nonce value. Should be computed using computeNonce().

    • realm

      public String realm
      Realm.

    • signature

      public String signature
      Signature. Required but normally computed using computeSignature(String, GenericUrl).

    • signatureMethod

      public String signatureMethod
      Name of the signature method used by the client to sign the request. Required, but normally computed using computeSignature(String, GenericUrl).

    • timestamp

      public String timestamp
      Required timestamp value. Should be computed using computeTimestamp().

    • token

      public String token
      Token value used to associate the request with the resource owner or null if the request is not associated with a resource owner.

    • verifier

      public String verifier
      The verification code received from the server.

    • version

      public String version
      Must either be "1.0" or null to skip. Provides the version of the authentication process as defined in this specification.

    • ESCAPER

      private static final com.google.api.client.util.escape.PercentEscaper ESCAPER

  • Constructor Details

    • OAuthParameters

      public OAuthParameters()

  • Method Details

    • computeNonce

      public void computeNonce()
      Computes a nonce based on the hex string of a random non-negative long, setting the value of the nonce field.

    • computeTimestamp

      public void computeTimestamp()
      Computes a timestamp based on the current system time, setting the value of the timestamp field.

    • computeSignature

      public void computeSignature(String requestMethod, com.google.api.client.http.GenericUrl requestUrl) throws GeneralSecurityException
      Computes a new signature based on the fields and the given request method and URL, setting the values of the signature and signatureMethod fields.
      Throws:
      GeneralSecurityException - general security exception

    • getAuthorizationHeader

      public String getAuthorizationHeader()
      Returns the Authorization header value to use with the OAuth parameter values found in the fields.

    • appendParameter

      private void appendParameter(StringBuilder buf, String name, String value)

    • putParameterIfValueNotNull

      private void putParameterIfValueNotNull(TreeMap<String,String> parameters, String key, String value)

    • putParameter

      private void putParameter(TreeMap<String,String> parameters, String key, Object value)

    • escape

      public static String escape(String value)
      Returns the escaped form of the given value using OAuth escaping rules.

    • initialize

      public void initialize(com.google.api.client.http.HttpRequest request) throws IOException
      Specified by:
      initialize in interface com.google.api.client.http.HttpRequestInitializer
      Throws:
      IOException

    • intercept

      public void intercept(com.google.api.client.http.HttpRequest request) throws IOException
      Specified by:
      intercept in interface com.google.api.client.http.HttpExecuteInterceptor
      Throws:
      IOException