com.google.api.client.googleapis.services

Class CommonGoogleClientRequestInitializer

java.lang.Object

com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer

All Implemented Interfaces:

GoogleClientRequestInitializer

Direct Known Subclasses:

CommonGoogleJsonClientRequestInitializer

public class CommonGoogleClientRequestInitializer
extends java.lang.Object
implements GoogleClientRequestInitializer

Google common client request initializer implementation for setting properties like key and userIp.

The simplest usage is to use it to set the key parameter:

  public static final GoogleClientRequestInitializer KEY_INITIALIZER =
      new CommonGoogleClientRequestInitializer(KEY);
 

There is also a constructor to set both the key and userIp parameters:

  public static final GoogleClientRequestInitializer INITIALIZER =
      new CommonGoogleClientRequestInitializer(KEY, USER_IP);
 

If you want to implement custom logic, extend it like this:

  public static class MyRequestInitializer extends CommonGoogleClientRequestInitializer {

     @Override
    public void initialize(AbstractGoogleClientRequest <? > request)
        throws IOException {
      // custom logic
    }
  }
 

Finally, to set the key and userIp parameters and insert custom logic, extend it like this:

  public static class MyRequestInitializer2 extends CommonGoogleClientRequestInitializer {

    public MyRequestInitializer2() {
      super(KEY, USER_IP);
    }

     @Override
    public void initialize(AbstractGoogleClientRequest <? > request)
        throws IOException {
      super.initialize(request); // must be called to set the key and userIp parameters
      // insert some additional logic
    }
  }
 

Subclasses should be thread-safe.

Since:

1.12

Author:

Yaniv Inbar

Constructor Summary

Constructors

Constructor and Description
CommonGoogleClientRequestInitializer()
CommonGoogleClientRequestInitializer(java.lang.String key)
CommonGoogleClientRequestInitializer(java.lang.String key, java.lang.String userIp)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey() Returns the API key or null to leave it unchanged.
java.lang.String	getUserIp() Returns the user IP or null to leave it unchanged.
void	initialize(AbstractGoogleClientRequest<?> request) Subclasses should call super implementation in order to set the key and userIp.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonGoogleClientRequestInitializer

public CommonGoogleClientRequestInitializer()

CommonGoogleClientRequestInitializer

public CommonGoogleClientRequestInitializer(java.lang.String key)

Parameters:

key - API key or null to leave it unchanged

CommonGoogleClientRequestInitializer

public CommonGoogleClientRequestInitializer(java.lang.String key,
                                            java.lang.String userIp)

Parameters:

key - API key or null to leave it unchanged

userIp - user IP or null to leave it unchanged

Method Detail

initialize

public void initialize(AbstractGoogleClientRequest<?> request)
                throws java.io.IOException

Subclasses should call super implementation in order to set the key and userIp.

Specified by:

initialize in interface GoogleClientRequestInitializer

Throws:

java.io.IOException - I/O exception

getKey

public final java.lang.String getKey()

Returns the API key or null to leave it unchanged.

getUserIp

public final java.lang.String getUserIp()

Returns the user IP or null to leave it unchanged.