com.google.api.client.googleapis.services.json

Class CommonGoogleJsonClientRequestInitializer

java.lang.Object

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

com.google.api.client.googleapis.services.json.CommonGoogleJsonClientRequestInitializer

All Implemented Interfaces:

GoogleClientRequestInitializer

public class CommonGoogleJsonClientRequestInitializer
extends CommonGoogleClientRequestInitializer

Google JSON 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 =
        CommonGoogleJsonClientRequestInitializer.newBuilder()
              .setKey(KEY)
              .build();
 

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

 public static final GoogleClientRequestInitializer INITIALIZER =
       CommonGoogleJsonClientRequestInitializer.newBuilder()
              .setKey(KEY)
              .setUserIp(USER_IP)
              .build();
 

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

 public static class MyRequestInitializer extends CommonGoogleJsonClientRequestInitializer {

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

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

 public static class MyKeyRequestInitializer extends CommonGoogleJsonClientRequestInitializer {

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

   {@literal @}Override
   public void initializeJsonRequest
       (AbstractGoogleJsonClientRequest{@literal <}?{@literal >} request) throws IOException {
     // custom logic
   }
 }
 

Subclasses should be thread-safe.

Since:

1.12

Author:

Yaniv Inbar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommonGoogleJsonClientRequestInitializer.Builder Builder for CommonGoogleJsonClientRequestInitializer.

Constructor Summary

Constructors

Constructor and Description
CommonGoogleJsonClientRequestInitializer() Deprecated. Please use the builder interface
CommonGoogleJsonClientRequestInitializer(String key) Deprecated. Please use the builder interface
CommonGoogleJsonClientRequestInitializer(String key, String userIp) Deprecated. Please use the builder interface

Method Summary

Modifier and Type	Method and Description
void	initialize(AbstractGoogleClientRequest<?> request) Subclasses should call super implementation in order to set the key and userIp.
protected void	initializeJsonRequest(AbstractGoogleJsonClientRequest<?> request) Initializes a Google JSON client request.

Methods inherited from class com.google.api.client.googleapis.services.CommonGoogleClientRequestInitializer

getKey, getRequestReason, getUserAgent, getUserIp, getUserProject, newBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonGoogleJsonClientRequestInitializer

@Deprecated
public CommonGoogleJsonClientRequestInitializer()

Deprecated. Please use the builder interface

CommonGoogleJsonClientRequestInitializer

@Deprecated
public CommonGoogleJsonClientRequestInitializer(String key)

Deprecated. Please use the builder interface

Parameters:

key - API key or null to leave it unchanged

CommonGoogleJsonClientRequestInitializer

@Deprecated
public CommonGoogleJsonClientRequestInitializer(String key,
                                                            String userIp)

Deprecated. Please use the builder interface

Parameters:

key - API key or null to leave it unchanged

userIp - user IP or null to leave it unchanged

Method Detail

initialize

public final void initialize(AbstractGoogleClientRequest<?> request)
                      throws IOException

Description copied from class: CommonGoogleClientRequestInitializer

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

Specified by:

initialize in interface GoogleClientRequestInitializer

Overrides:

initialize in class CommonGoogleClientRequestInitializer

Throws:

IOException - I/O exception

initializeJsonRequest

protected void initializeJsonRequest(AbstractGoogleJsonClientRequest<?> request)
                              throws IOException

Initializes a Google JSON client request.

Default implementation does nothing. Called from initialize(AbstractGoogleClientRequest).

Throws:

IOException - I/O exception